How Can We Help?
This section describes the usage of Query APIs to get information on connections in HEAL.
Connections Details for a Service
To get details of all dependent services for a specific service, use the ‘connections’ Query API as follows:
API Name – connections
Format – GET /config/accounts/{accountId}/services/{serviceId}/connections
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 |
Output Parameters
Output Type: CSV
- Dependent Service ID – Unique ID of a dependent service
- Dependent Service – Name of a dependent service
- Connection Type – It is the connection between source and destination service i.e. Inbound or Outbound
Sample Input
http://<keycloak_host>:<keycloak_port>/appsone-query-api/v1.0/config/accounts/5/services/34/connections