Parameters
| Parameter | Description |
|---|---|
| Fields | A comma delimited list of fields. Filters the response to only include the listed fields for each object. |
| Filter | Filters the response according to the operator and value specified. Note that you can use * to match on more than one character. You can use the ‘.’ character to filter values within an object (e.g. custom properties), and multiple filters can be separated by a comma. Operators include: Greater than or equals: >:Less than or equals: <:Greater than: >Less than: <Does not equal: !:Equals: :Includes: ~Does not include: !~For example, filter=id>100 will return the results where the resource id is greater than 100. |
| Offset | The number of results to offset the displayed results by. |
| Size | The number of results to display. Max is 1000. |
Example Output
{
"total": 0,
"searchId": "string",
"items": [
{
"fullPath": "string",
"stopMonitoring": true,
"userPermission": "string",
"testLocation": {
"all": true,
"collectorIds": [
0
],
"collectors": [
{
"hostname": "string",
"collectorGroupName": "string",
"collectorGroupId": 0,
"description": "string",
"id": 0,
"status": "string"
}
],
"smgIds": [
1,
2,
4,
3,
5,
6
]
},
"hasWebsitesDisabled": true,
"description": "Amazon web and ping checks",
"disableAlerting": false,
"rolePrivileges": [
"string"
],
"parentId": 1,
"numOfDirectWebsites": 0,
"name": "Amazon Website Checks",
"numOfDirectSubGroups": 0,
"id": 0,
"numOfWebsites": 0,
"properties": [
{
"name": "addr",
"value": "127.0.0.1"
}
]
}
]
}