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 |
|
Authentication
To execute this request, you need the 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 | required |
tag | array |
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 | Description |
---|---|
200 | Success |
Response body
The HostList object
The list of hosts supported by extension.
Element | Type | Description |
---|---|---|
totalResults | integer | Total number of results |
hosts | Host[] | The list of hosts |
nextPageKey | string | Next page key used for paging |
The Host object
Host details. Contains ID, name, host group, and tags.
Element | Type | Description |
---|---|---|
name | string | The name of the host |
id | string | The ID of the host |
hostGroup | HostGroup | |
tags | TagInfo[] | A list of tags of the host. |
managementZones | EntityShortRepresentation[] | A list of management zones to which the host belongs. |
The EntityShortRepresentation object
The short representation of a Dynatrace entity.
Element | Type | Description |
---|---|---|
id | string | The ID of the Dynatrace entity. |
name | string | The name of the Dynatrace entity. |
description | string | A short description 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. |
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. |
{
"totalResults": 0,
"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"
}