E-mail
WAS THIS PAGE HELPFUL? Leave Feedback
25.1 RTMM Optimized Host Queries
Get all or specific Hosts by id optimized for RTMM usage. Optimization includes reduced Host payloads and streamlined server query processing. Host responses include imbedded Services.
25.1.1 Method: GET all Hosts For RTMM
GET /api/rtmm/hosts
25.1.2 Method: GET Hosts by Id For RTMM
GET /api/rtmm/hosts/{id}
GET /api/rtmm/hosts/{ids}
25.1.3 Path Parameters
| Field | Type | Description | Required |
|---|---|---|---|
| id | Path | Single Host id | no |
| ids | Path | Multiple Host ids in a comma separated values list | no |
25.1.4 HTTP Headers
| Header | Valid Values | Required |
|---|---|---|
| Content-Type | application/xml or application/json | True |
| GWOS-API-TOKEN | a valid token returned from login | True |
| GWOS-APP-NAME | your application name | True |
25.1.5 HTTP Status Codes
| Code | Description |
|---|---|
| 200 | Queried Hosts returned |
| 404 | No Hosts found |
| 401 | Authentication/authorization error occurred |
| 500 | An internal server error occurred while processing autocomplete prefix |
25.1.6 Host Responses
Hosts are returned in the standard XML and JSON wrapped form. See the Host APIs. RTMM optimization limits the returned data to these data members:
- alias
- appTypeDisplayName
- bubbleUpStatus
- hostName
- id
- isAcknowledged
- lastCheckTime
- lastPluginOutput
- lastStateChange
- monitorStatus
- properties.isProblemAcknowledged
- properties.ScheduledDowntimeDepth
- serviceAvailability
- services.appTypeDisplayName
- services.description
- services.id
- services.lastCheckTime
- services.lastStateChange
- services.monitorStatus
- services.properties.isProblemAcknowledged
25.2 RTMM Optimized Host Group Queries
Get all or specific Host Groups by id optimized for RTMM usage. Optimization includes reduced Host Group payloads and streamlined server query processing. Host Group responses include embedded Hosts.
25.2.1 Method: GET all Host Groups For RTMM
GET /api/rtmm/hostgroups
25.2.2 Method: GET Host Groups by Id For RTMM
GET /api/rtmm/hostgroups/{id}
GET /api/rtmm/hostgroups/{ids}
25.2.3 Path Parameters
| Field | Type | Description | Required |
|---|---|---|---|
| id | Path | Single Host Group id | no |
| ids | Path | Multiple Host Group ids in a comma separated values list | no |
25.2.4 HTTP Headers
| Header | Valid Values | Required |
|---|---|---|
| Content-Type | application/xml or application/json | True |
| GWOS-API-TOKEN | a valid token returned from login | True |
| GWOS-APP-NAME | your application name | True |
25.2.5 HTTP Status Codes
| Code | Description |
|---|---|
| 200 | Queried Host Groups returned |
| 404 | No Host Groups found |
| 401 | Authentication/authorization error occurred |
| 500 | An internal server error occurred while processing autocomplete prefix |
25.2.6 RTMM Host Group Responses
Host Groups are returned in the standard XML and JSON wrapped form. See the Host Group APIs. RTMM optimization limits the returned data to these data members:
- alias
- hosts.id
- id
- name
25.3 RTMM Optimized Service Group Queries
Get all or specific Service Groups by id optimized for RTMM usage. Optimization includes reduced Service Group payloads and streamlined server query processing. Service Group responses include embedded Services.
25.3.1 Method: GET all Service Groups For RTMM
GET /api/rtmm/servicegroups
25.3.2 Method: GET Service Groups by Id For RTMM
GET /api/rtmm/servicegroups/{id}
GET /api/rtmm/servicegroups/{ids}
25.3.3 Path Parameters
| Field | Type | Description | Required |
|---|---|---|---|
| id | Path | Single Service Group id | no |
| ids | Path | Multiple Service Group ids in a comma separated values list | no |
25.3.4 HTTP Headers
| Header | Valid Values | Required |
|---|---|---|
| Content-Type | application/xml or application/json | True |
| GWOS-API-TOKEN | a valid token returned from login | True |
| GWOS-APP-NAME | your application name | True |
25.3.5 HTTP Status Codes
| Code | Description |
|---|---|
| 200 | Queried Service Groups returned |
| 404 | No Service Groups found |
| 401 | Authentication/authorization error occurred |
| 500 | An internal server error occurred while processing autocomplete prefix |
25.3.6 RTMM Service Group Responses
Service Groups are returned in the standard XML and JSON wrapped form. See the Service Group APIs. RTMM optimization limits the returned data to these data members:
- id
- name
- services.id
25.4 RTMM Optimized Custom Group Queries
Get all or specific Custom Groups by id optimized for RTMM usage. Optimization includes reduced Custom Group payloads and streamlined server query processing. Custom Group responses include embedded Host Groups, Service Groups, and child Custom Groups.
25.4.1 Method: GET all Custom Groups For RTMM
GET /api/rtmm/customgroups
25.4.2 Method: GET Custom Groups by Id For RTMM
GET /api/rtmm/customgroups/{id}
GET /api/rtmm/customgroups/{ids}
25.4.3 Path Parameters
| Field | Type | Description | Required |
|---|---|---|---|
| id | Path | Single Custom Group id | no |
| ids | Path | Multiple Custom Group ids in a comma separated values list | no |
25.4.4 HTTP Headers
| Header | Valid Values | Required |
|---|---|---|
| Content-Type | application/xml or application/json | True |
| GWOS-API-TOKEN | a valid token returned from login | True |
| GWOS-APP-NAME | your application name | True |
25.4.5 HTTP Status Codes
| Code | Description |
|---|---|
| 200 | Queried Custom Groups returned |
| 404 | No Custom Groups found |
| 401 | Authentication/authorization error occurred |
| 500 | An internal server error occurred while processing autocomplete prefix |
25.4.6 RTMM Custom Group Responses
Custom Groups are returned in the standard XML and JSON wrapped form. See the Custom Group APIs. RTMM optimization limits the returned data to these data members:
- children.id
- hostGroups.id
- id
- isRoot
- name
- serviceGroups.id