• Home
  • Dynatrace API
  • Configuration
  • Extensions
  • GET available hosts

Extensions API - GET available hosts

Lists all available hosts that run the specified technology.

The request produces an application/json payload.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

GETManaged 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 an access token with Read configuration (ReadConfig) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameter

ParameterTypeDescriptionInRequired
technologystring

Name of requested technology

The element can hold these values
  • ACTIVE_MQ
  • ACTIVE_MQ_ARTEMIS
  • ADO_NET
  • AIX
  • AKKA
  • AMAZON_REDSHIFT
  • AMQP
  • APACHE_CAMEL
  • APACHE_CASSANDRA
  • APACHE_COUCH_DB
  • APACHE_DERBY
  • APACHE_HTTP_CLIENT_ASYNC
  • APACHE_HTTP_CLIENT_SYNC
  • APACHE_HTTP_SERVER
  • APACHE_KAFKA
  • APACHE_LOG4J
  • APACHE_SOLR
  • APACHE_STORM
  • APACHE_SYNAPSE
  • APACHE_TOMCAT
  • APPARMOR
  • APPLICATION_INSIGHTS_SDK
  • ASP_DOTNET
  • ASP_DOTNET_CORE
  • ASP_DOTNET_CORE_SIGNALR
  • ASP_DOTNET_SIGNALR
  • ASYNC_HTTP_CLIENT
  • AWS_LAMBDA
  • AWS_RDS
  • AWS_SERVICE
  • AXIS
  • AZURE_FUNCTIONS
  • AZURE_SERVICE_BUS
  • AZURE_SERVICE_FABRIC
  • AZURE_STORAGE
  • BOSHBPM
  • CITRIX
  • CITRIX_COMMON
  • CITRIX_DESKTOP_DELIVERY_CONTROLLERS
  • CITRIX_DIRECTOR
  • CITRIX_LICENSE_SERVER
  • CITRIX_PROVISIONING_SERVICES
  • CITRIX_STOREFRONT
  • CITRIX_VIRTUAL_DELIVERY_AGENT
  • CITRIX_WORKSPACE_ENVIRONMENT_MANAGEMENT
  • CITRIX_XEN
  • CLOUDFOUNDRY
  • CLOUDFOUNDRY_AUCTIONEER
  • CLOUDFOUNDRY_BOSH
  • CLOUDFOUNDRY_GOROUTER
  • COLDFUSION
  • CONFLUENT_KAFKA_CLIENT
  • CONTAINERD
  • CORE_DNS
  • COUCHBASE
  • CRIO
  • CXF
  • DATASTAX
  • DB2
  • DIEGO_CELL
  • DOCKER
  • DOTNET
  • DOTNET_REMOTING
  • ELASTIC_SEARCH
  • ENVOY
  • ERLANG
  • ETCD
  • F5_LTM
  • FSHARP
  • GARDEN
  • GLASSFISH
  • GO
  • GOOGLE_CLOUD_FUNCTIONS
  • GRAAL_TRUFFLE
  • GRPC
  • GRSECURITY
  • HADOOP
  • HADOOP_HDFS
  • HADOOP_YARN
  • HAPROXY
  • HEAT
  • HESSIAN
  • HORNET_Q
  • IBM_CICS_REGION
  • IBM_CICS_TRANSACTION_GATEWAY
  • IBM_IMS_CONNECT_REGION
  • IBM_IMS_CONTROL_REGION
  • IBM_IMS_MESSAGE_PROCESSING_REGION
  • IBM_IMS_SOAP_GATEWAY
  • IBM_INTEGRATION_BUS
  • IBM_MQ
  • IBM_MQ_CLIENT
  • IBM_WEBSHPRERE_APPLICATION_SERVER
  • IBM_WEBSHPRERE_LIBERTY
  • IBM_WEBSPHERE_APPLICATION_SERVER
  • IBM_WEBSPHERE_LIBERTY
  • IIS
  • IIS_APP_POOL
  • ISTIO
  • JAVA
  • JAX_WS
  • JBOSS
  • JBOSS_EAP
  • JDK_HTTP_SERVER
  • JERSEY
  • JETTY
  • JRUBY
  • JYTHON
  • KUBERNETES
  • LIBC
  • LIBVIRT
  • LINKERD
  • LINUX_SYSTEM
  • MARIADB
  • MEMCACHED
  • MICROSOFT_SQL_SERVER
  • MONGODB
  • MSSQL_CLIENT
  • MULE_ESB
  • MYSQL
  • MYSQL_CONNECTOR
  • NETFLIX_SERVO
  • NETTY
  • NGINX
  • NODE_JS
  • OK_HTTP_CLIENT
  • ONEAGENT_SDK
  • OPENCENSUS
  • OPENSHIFT
  • OPENSTACK_COMPUTE
  • OPENSTACK_CONTROLLER
  • OPENTELEMETRY
  • OPENTRACING
  • OPEN_LIBERTY
  • ORACLE_DATABASE
  • ORACLE_WEBLOGIC
  • OWIN
  • PERL
  • PHP
  • PHP_FPM
  • PLAY
  • POSTGRE_SQL
  • POSTGRE_SQL_DOTNET_DATA_PROVIDER
  • POWER_DNS
  • PROGRESS
  • PYTHON
  • QOS_LOGBACK
  • RABBIT_MQ
  • REACTOR_CORE
  • REDIS
  • RESTEASY
  • RESTLET
  • RIAK
  • RUBY
  • SAG_WEBMETHODS_IS
  • SAP
  • SAP_HANADB
  • SAP_HYBRIS
  • SAP_MAXDB
  • SAP_SYBASE
  • SCALA
  • SELINUX
  • SHAREPOINT
  • SPARK
  • SPRING
  • SQLITE
  • THRIFT
  • TIBCO
  • TIBCO_BUSINESS_WORKS
  • TIBCO_EMS
  • UNDERTOW_IO
  • VARNISH_CACHE
  • VERTX
  • VIM2
  • VIRTUAL_MACHINE_KVM
  • VIRTUAL_MACHINE_QEMU
  • WILDFLY
  • WINDOWS_CONTAINERS
  • WINDOWS_SYSTEM
  • WINK
  • ZERO_MQ
  • ZOS_CONNECT
pathrequired
tagstring[]

Filters the resulting set of hosts by the specified tag.

You can specify several tags in the following format: tag=tag1&tag=tag2. The host has to match all the specified tags.

queryoptional
managementZoneinteger

Only return hosts that are part of the specified management zone.

queryoptional
hostGroupIdstring

Filters the resulting set of hosts by the specified host group.

Specify the Dynatrace IDs of the host group you're interested in.

queryoptional
hostGroupNamestring

Filters the resulting set of hosts by the specified host group.

Specify the name of the host group you're interested in.

queryoptional
pageSizeinteger

The number of results per result page. Must be between 1 and 500

queryoptional
nextPageKeystring

The cursor for the next page of results.

queryoptional

Response

Response codes

CodeTypeDescription
200HostList

Success

Response body objects

The HostList object

The list of hosts supported by extension.

ElementTypeDescription
totalResultsinteger

Total number of results

Can be null.

hostsHost[]

The list of hosts

Can be null.

nextPageKeystring

Next page key used for paging

Can be null.

The Host object

Host details. Contains ID, name, host group, and tags.

ElementTypeDescription
namestring

The name of the host

Can be null.

idstring

The ID of the host

Can be null.

hostGroupHostGroup

Host group to which the host belongs.

Can be null.

tagsTagInfo[]

A list of tags of the host.

Can be null.

managementZonesEntityShortRepresentation[]

A list of management zones to which the host belongs.

Can be null.

The HostGroup object

Host group to which the host belongs.

ElementTypeDescription
meIdstring

The Dynatrace entity ID of the host group.

Can be null.

namestring

The name of the Dynatrace entity, displayed in the UI.

Can be null.

The TagInfo object

Tag of a Dynatrace entity.

ElementTypeDescription
contextstring

The origin of the tag, such as AWS or Cloud Foundry.

Custom tags use the CONTEXTLESS value.

The element can hold these values
  • AWS
  • AWS_GENERIC
  • AZURE
  • CLOUD_FOUNDRY
  • CONTEXTLESS
  • ENVIRONMENT
  • GOOGLE_CLOUD
  • KUBERNETES
keystring

The key of the tag.

Custom tags have the tag value here.

valuestring

The value of the tag.

Not applicable to custom tags.

Can be null.

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

ElementTypeDescription
idstring

The ID of the Dynatrace entity.

namestring

The name of the Dynatrace entity.

Can be null.

descriptionstring

A short description of the Dynatrace entity.

Can be null.

Response body JSON model

json
{ "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" }
Related topics
  • Extensions

    Learn about the extensions framework offered by Dynatrace.