Extensions API - GET available hosts
Lists all available hosts that run the specified technology.
The request produces an application/json payload.
| GET | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/config/v1/extensions/{technology}/availableHosts |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/extensions/{technology}/availableHosts | |
| Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/extensions/{technology}/availableHosts |
Authentication
To execute this request, you need an access token with ReadConfig scope.
To learn how to obtain and use it, see Tokens and authentication.
Parameter
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| technology | string | Name of requested technology
| path | required |
| tag | string[] | Filters the resulting set of hosts by the specified tag. You can specify several tags in the following format: | query | optional |
| managementZone | integer | Only return hosts that are part of the specified management zone. | query | optional |
| hostGroupId | string | Filters the resulting set of hosts by the specified host group. Specify the Dynatrace IDs of the host group you're interested in. | query | optional |
| hostGroupName | string | Filters the resulting set of hosts by the specified host group. Specify the name of the host group you're interested in. | query | optional |
| pageSize | integer | The number of results per result page. Must be between 1 and 500 | query | optional |
| nextPageKey | string | The cursor for the next page of results. | query | optional |
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | HostList | Success |
Response body objects
The HostList object
The list of hosts supported by extension.
| Element | Type | Description |
|---|---|---|
| hosts | Host[] | The list of hosts |
| nextPageKey | string | Next page key used for paging |
| totalResults | integer | Total number of results |
The Host object
Host details. Contains ID, name, host group, and tags.
| Element | Type | Description |
|---|---|---|
| hostGroup | HostGroup | Host group to which the host belongs. |
| id | string | The ID of the host |
| managementZones | EntityShortRepresentation[] | A list of management zones to which the host belongs. |
| name | string | The name of the host |
| tags | TagInfo[] | A list of tags of the host. |
The HostGroup object
Host group to which the host belongs.
| Element | Type | Description |
|---|---|---|
| meId | string | The Dynatrace entity ID of the host group. |
| name | string | The name of the Dynatrace entity, displayed in the UI. |
The EntityShortRepresentation object
The short representation of a Dynatrace entity.
| Element | Type | Description |
|---|---|---|
| description | string | A short description of the Dynatrace entity. |
| id | string | The ID of the Dynatrace entity. |
| name | string | The name of the Dynatrace entity. |
The TagInfo object
Tag of a Dynatrace entity.
| Element | Type | Description |
|---|---|---|
| context | string | The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the
|
| key | string | The key of the tag. Custom tags have the tag value here. |
| value | string | The value of the tag. Not applicable to custom tags. |
Response body JSON model
1{2 "hosts": [3 {4 "hostGroup": {5 "meId": "HOST_GROUP-CF1DA380B3A53F17",6 "name": "example host group"7 },8 "id": "HOST-0000000000000000",9 "managementZones": [10 {11 "id": "000000000000000000",12 "name": "example zone"13 }14 ],15 "name": "example host",16 "tags": [17 "tagA",18 "tagB"19 ]20 }21 ],22 "nextPageKey": "string",23 "totalResults": 124}