How Can We Help?
This section describes usage of Query APIs to get information of services in HEAL.
Details for All Services
To get details of all the services for a specific account, use the ‘services’ Query API as follows:
API Name – services
Format – GET /config/accounts/{accountId}/applications/{applicationId}/services
Input Parameters
| Type | Name | Description | Schema | Mandatory / Optional |
| Path | accountId | ID or Identifier of an Account | string | Mandatory |
| Path | applicationId | ID or Identifier of an Application | string | Mandatory |
Output Parameters
Output Type: CSV
- Service ID – Unique ID of a service
- Service Name – Name of a service
- Type – Name of a component
- Timezone – The Timezone set for the service
- Offset – Offset with respect to GMT. It is the diversion in terms of duration from GMT.
Sample Input
Details for a Service
To get details of a specific Service for an application in an account, use the ‘services’ Query API as follows:
API Name – services
Format – GET /config/accounts/{accountId}/applications/{applicationId}/services/{serviceId}
Input Parameters
| Type | Name | Description | Schema | Mandatory / Optional |
| Path | accountId | ID or Identifier of an Account | string | Mandatory |
| Path | applicationId | ID or Identifier of an Application | string | Mandatory |
| Path | serviceId | ID or Identifier of a Service | string | Mandatory |
Output Parameters
Output Type: CSV
- Service ID – Unique ID of a service
- Service Name – Name of a service
- Type – Name of a component
- Timezone – Timezone set for the service
- Offset – Offset with respect to GMT. It is the diversion in terms of duration from GMT.
Sample Input
Details of Maintenance Window
To get details of all the scheduled and adhoc maintenance windows for a service in an account over a time period, use the ‘maintenance-data’ Query API as follows:
API Name – maintenance-data
Format – GET /config/accounts/{accountId}/services/{serviceId}/maintenance-data
Input Parameters
| Type | Name | Description | Schema | Mandatory/ Optional |
| Path | accountId | ID or Identifier of an Account | string | Mandatory |
| Path | serviceId | ID or Identifier of a Service | string | Mandatory |
| Query | from | Time Range in GMT format | string | Mandatory |
| Query | to | string | Mandatory |
Output Parameters
Output Type: CSV
- Service Id – Id or Identifier of a Service
- Service Name – Name of a Service
- Instance Id – Id or Identifier of an instance
- Instance Name – Name of an instance
- Host Address – IP address of the host
- From Time, To Time – Date and time for a maintenance window, either scheduled or adhoc.
- Duration – Maintenance Window time duration in minutes
Sample Input