Extensions API - GET available hosts
Lists all available hosts that run the specified technology.
The request produces an application/json payload.
This request is an Early Adopter release and may be changed in non-compatible way.
| GET | Managed | 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}/e/{your-environment-id}/api/config/v1/extensions/{technology}/availableHosts |
Authentication
To execute this request, you need Read configuration (ReadConfig) permission assigned to your API token. 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 | optional |
| tag | string[] | Filters the resulting set of hosts by the specified tag. You can specify several tags in the following format: | query | required |
| managementZone | integer | Only return hosts that are part of the specified management zone. | query | required |
| 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 | required |
| 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 | required |
| pageSize | integer | The number of results per result page. Must be between 1 and 500 | query | required |
| nextPageKey | string | The cursor for the next page of results. | query | required |
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | Host | Success |
Response body objects
The HostList object
The list of hosts supported by extension.
| Element | Type | Description | Required |
|---|---|---|---|
| totalResults | integer | Total number of results | optional |
| hosts | Host[] | The list of hosts | optional |
| nextPageKey | string | Next page key used for paging | optional |
The Host object
Host details. Contains ID, name, host group, and tags.
| Element | Type | Description | Required |
|---|---|---|---|
| name | string | The name of the host | optional |
| id | string | The ID of the host | optional |
| hostGroup | Host | Host group to which the host belongs. | optional |
| tags | Tag | A list of tags of the host. | optional |
| managementZones | Entity | A list of management zones to which the host belongs. | optional |
The HostGroup object
Host group to which the host belongs.
| Element | Type | Description | Required |
|---|---|---|---|
| meId | string | The Dynatrace entity ID of the host group. | optional |
| name | string | The name of the Dynatrace entity, displayed in the UI. | optional |
The TagInfo object
Tag of a Dynatrace entity.
| Element | Type | Description | Required |
|---|---|---|---|
| context | string | The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the | required |
| key | string | The key of the tag. Custom tags have the tag value here. | required |
| value | string | The value of the tag. Not applicable to custom tags. | optional |
The EntityShortRepresentation object
The short representation of a Dynatrace entity.
| Element | Type | Description | Required |
|---|---|---|---|
| id | string | The ID of the Dynatrace entity. | required |
| name | string | The name of the Dynatrace entity. | optional |
| description | string | A short description of the Dynatrace entity. | optional |
Response body JSON model
{
"totalResults": 1,
"hosts": [
{
"name": "example host",
"id": "HOST-0000000000000000",
"hostGroup": {
"meId": "HOST_GROUP-CF1DA380B3A53F17",
"name": "example host group"
},
"tags": [
"tagA",
"tagB"
],
"managementZones": [
{
"id": "000000000000000000",
"name": "example zone"
}
]
}
],
"nextPageKey": "string"
}