Extensions API - GET all extension's instances

Lists all instances of the specified extension.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/extensions/{id}/instances
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/extensions/{id}/instances

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.

Parameters

Parameter
Type
Description
In
Required
id
string

The ID of the required extension.

path
required
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

Success

Response body objects

The ExtensionConfigurationList object

A list of configurations.

Element
Type
Description
configurationsList

List of configurations.

nextPageKey
string

The cursor for the next page of results. Has the value of null on the last page.

Use it in the nextPageKey query parameter to obtain subsequent pages of the result.

totalResults
integer

The total number of entries in the result.

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.

Response body JSON model

{
  "configurationsList": [
    {
      "id": "HOST-E1550E0AED6A572F"
    }
  ],
  "nextPageToken": "LlUdYmu5S2MfX/ppfCInR9M=",
  "totalResults": 9
}

Related topics