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.

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 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 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_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 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 IIS IIS_APP_POOL ISTIO JAVA JAX_WS JBOSS JBOSS_EAP JDK_HTTP_SERVER JERSEY JETTY JRUBY JYTHON KUBERNETES LIBC LIBVIRT LINKERD 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 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 VIM2 VIRTUAL_MACHINE_KVM VIRTUAL_MACHINE_QEMU WILDFLY WINDOWS_CONTAINERS WINK ZERO_MQ ZOS_CONNECT	path	required
tag	array	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.	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

Response parametersJSON model

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

Element	Type	Description
context	string	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
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 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

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": 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"
}