System management

Use this REST API to manage system resources.

When generating HTTP requests, certain headers are required for authentication, authorization, and content negotiation. For more information, see HTTP header requests.

Common parameters

The following parameters provide general status about the overall system function. These fields are commonly used throughout all REST API calls.

created_time: The time at which the object is created.
updated_time: The time at which the object was last updated.
state: The general availability of the object. If the value is pending, the object is created but not activated. If the value is available, the object is active in the system.
id: The unique ID of the object in the system.

To list multiple occurrences of a field, specify the same parameter multiple items, for example:

?id=<id1>&id=<id2>

The Response sections in the REST API method descriptions show only a partial response to provide an example of one object of the type. Some descriptions include syntax to retrieve a single instance of the object in question. Examples of the response and parameters are not provided, because the details are an identical subset of the whole response.

Optional parameters for GET calls

Use the following optional parameters to modify the response from GET calls:

For GET calls for a single resource or for multiple resources:
resolvechildren=<n>
Show children table entries one or more levels down, for any fields containing one or more URI patterns, where <n> is the number of levels to resolve. An example is shown below:
```
/resources/{resource}/{id}?resolvechildren=3
```
resolveparents=<n>
Show parent table entries one or more levels up, for any fields containing one or more URI patterns, where <n> is the number of levels to resolve. An example is shown below:
```
/resources/{resource}/{id}?resolveparents=3
```
For GET calls for multiple resources only:
<field>=<value>
You can specify filters to reduce the number of resources that are returned. This filter returns only the records whose specified field contains the specified filter value. An example is shown below:
```
/resources/{resource}/<field>=<value>
```
fuzzy=[true | false]
You can specify this attribute along with the field filter to further refine the number of records that are returned. If the fuzzy attribute is specified as true (the default), the search matches the specified value anywhere in the field. If fuzzy is specified as false, then an exact match of the specified value is performed. An example is shown below:
```
/resources/{resource}/<field>=<value>&fuzzy=true
```
compare=[gt | gte | lt | lte]
You can specify this attribute along with the field filter to further refine the number of records that are returned. The value for the field must be a number.
- gt returns resources where the value for the specified field is greater than the specified value.
- gte returns resources where the value for the specified field is greater than or equal to the specified value.
- lt returns resources where the value for the specified field is less than the specified value.
- lte returns resources where the value for the specified field is less than or equal to the specified value.
An example is shown below:
```
/resources/{resource}/<field>=<value>&compare=gt
```
count=<n>

Used with the page parameter, returns a specified number of resources per page. If this parameter is not specified, 500 return codes for each page are returned.

page=<m>
Used with the count parameter, returns a specified number of pages. If this parameter is not specified, only the first page is returned, containing the number of resources specified by the count parameter. An example is shown below:
```
/resources/{resource}?count=<n>&page=<m>
```
totalcount=[true | false]
Returns a count of the number of resources. An example is shown below:
```
/resources/{resource}?totalcount=true
```
order=[+ | -]
Used with the field filter, this parameter sorts in ascending or descending order the returned resources by the value of the specified field. An example is shown below:
```
/resources/{resource}?order=+<field>
```