Extensions API - POST a new extension's instance

Creates a new instance for the specified extension.

The request consumes and produces an application/json payload.

Parameters

Parameter Type Description In Required
id string

The ID of the extension

path required
body ExtensionConfigurationDto

The JSON body of the request. Contains new configuration of the extension.

body optional

The ExtensionConfigurationDto object

Element Type Description Required
extensionId string

The ID of the extension.

optional
enabled boolean

The extension is enabled (true) or disabled (false).

required
useGlobal boolean

Allows to skip current configuration and use global one.

required
properties object

The list of extension parameters.

Each parameter is a key-value pair.

optional
hostId ExpMEIdentifier

The ID of the host on which the extension runs.

optional
activeGate EntityShortRepresentation

The ActiveGate extension module that hosts the endpoint.

optional
endpointId string

The ID of the endpoint.

optional
endpointName string

The name of the endpoint, displayed in Dynatrace.

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

The ExpMEIdentifier object

Element Type Description Required
type string The type element can hold these values. optional
longId integer optional
meidentifier MEIdentifier optional

The MEIdentifier object

Element Type Description Required
type string The type element can hold these values. optional
longId integer optional

Possible values

Possible values for the type element in the MEIdentifier object:

  • ABSTRACT_SITE
  • ABSTRACT_SYNTHETIC_TEST
  • ABSTRACT_VIRTUALMACHINE
  • APM_AGENT
  • APM_CLUSTER
  • APM_ENTITY
  • APM_SECURITY_GATEWAY
  • APM_SERVER
  • APM_TENANT
  • APPLICATION
  • APPLICATION_ENTITY
  • APPLICATION_METHOD
  • APPLICATION_METHOD_GROUP
  • APPMON_ENTITY
  • APPMON_SERVER
  • APPMON_SYSTEM_PROFILE
  • AUTO_SCALING_GROUP
  • AWS
  • AWS_APPLICATION_LOAD_BALANCER
  • AWS_AVAILABILITY_ZONE
  • AWS_CREDENTIALS
  • AWS_LAMBDA_FUNCTION
  • AWS_LOAD_BALANCER
  • AWS_NETWORK_LOAD_BALANCER
  • AZURE
  • AZURE_API_MANAGEMENT_SERVICE
  • AZURE_APPLICATION_GATEWAY
  • AZURE_APP_SERVICE_PLAN
  • AZURE_COSMOS_DB
  • AZURE_CREDENTIALS
  • AZURE_EVENT_HUB
  • AZURE_EVENT_HUB_NAMESPACE
  • AZURE_FUNCTION_APP
  • AZURE_IOT_HUB
  • AZURE_LOAD_BALANCER
  • AZURE_MGMT_GROUP
  • AZURE_REDIS_CACHE
  • AZURE_REGION
  • AZURE_SERVICE_BUS_NAMESPACE
  • AZURE_SERVICE_BUS_QUEUE
  • AZURE_SERVICE_BUS_TOPIC
  • AZURE_SQL_DATABASE
  • AZURE_SQL_ELASTIC_POOL
  • AZURE_SQL_SERVER
  • AZURE_STORAGE_ACCOUNT
  • AZURE_SUBSCRIPTION
  • AZURE_TENANT
  • AZURE_VM
  • AZURE_VM_SCALE_SET
  • AZURE_WEB_APP
  • BOSH_DEPLOYMENT
  • BROWSER
  • CF_APPLICATION
  • CF_APPLICATION_INSTANCE
  • CF_FOUNDATION
  • CF_ORG
  • CF_SPACE
  • CINDER_VOLUME
  • CLOUD_APPLICATION
  • CLOUD_APPLICATION_INSTANCE
  • CLOUD_APPLICATION_NAMESPACE
  • CLOUD_FOUNDRY
  • CONTAINER_ENTITY
  • CONTAINER_GROUP
  • CONTAINER_GROUP_INSTANCE
  • CREDENTIALS
  • CREDENTIALS_VAULT
  • CUSTOM_APPLICATION
  • CUSTOM_DEVICE
  • CUSTOM_DEVICE_GROUP
  • DATASTORE
  • DB_ENDPOINT
  • DB_ENDPOINT_GROUP
  • DCRUM_APPLICATION
  • DCRUM_ENTITY
  • DCRUM_SERVICE
  • DCRUM_SERVICE_INSTANCE
  • DEVICE_APPLICATION
  • DEVICE_APPLICATION_METHOD
  • DEVICE_APPLICATION_METHOD_GROUP
  • DISK
  • DOCKER_CONTAINER_GROUP
  • DOCKER_CONTAINER_GROUP_INSTANCE
  • DOCKER_ENTITY
  • DYNAMO_DB_TABLE
  • EBS_VOLUME
  • EC2_INSTANCE
  • ELASTIC_LOAD_BALANCER
  • ENVIRONMENT
  • EXTERNAL_SYNTHETIC_TEST
  • EXTERNAL_SYNTHETIC_TEST_STEP
  • GCP_ZONE
  • GEOLOCATION
  • GEOLOC_SITE
  • GOOGLE_COMPUTE_ENGINE
  • HOST
  • HOST_GROUP
  • HTTP_CHECK
  • HTTP_CHECK_STEP
  • HYPERVISOR
  • HYPERVISOR_CLUSTER
  • HYPERVISOR_DISK
  • INFRASTRUCTURE_ENTITY
  • KUBERNETES
  • KUBERNETES_CLUSTER
  • KUBERNETES_NODE
  • LOG_INSTANCE
  • MEASUREMENT
  • MEASUREMENT_GROUP
  • MOBILE_APPLICATION
  • MOBILE_ENTITY
  • MONITORED_ENTITY
  • NETWORK_INTERFACE
  • NEUTRON_SUBNET
  • OPENSTACK
  • OPENSTACK_AVAILABILITY_ZONE
  • OPENSTACK_COMPUTE_NODE
  • OPENSTACK_CREDENTIALS
  • OPENSTACK_PROJECT
  • OPENSTACK_REGION
  • OPENSTACK_VM
  • OS
  • PG_APPLICATION
  • PG_APPLICATION_INSTANCE
  • PROCESS_GROUP
  • PROCESS_GROUP_INSTANCE
  • QUEUE
  • QUEUE_ENTITY
  • QUEUE_INSTANCE
  • RELATIONAL_DATABASE_SERVICE
  • REMOTE_PLUGIN_MODULE
  • REQUEST_ATTRIBUTE
  • S3BUCKET
  • SERVICE
  • SERVICE_ENTITY
  • SERVICE_INSTANCE
  • SERVICE_METHOD
  • SERVICE_METHOD_GROUP
  • SESSION_STORED_ENTITY
  • SOFTWARE_COMPONENT
  • STRUCTURED_DIMENSION
  • SWIFT_CONTAINER
  • SYNTHETIC
  • SYNTHETIC_LOCATION
  • SYNTHETIC_TEST
  • SYNTHETIC_TEST_STEP
  • VCENTER
  • VIRTUALMACHINE
  • VMWARE_DATACENTER

Possible values for the type element in the ExpMEIdentifier object:

  • APPLICATION
  • APPLICATION_METHOD
  • APPLICATION_METHOD_GROUP
  • AUTO_SCALING_GROUP
  • AUXILIARY_SYNTHETIC_TEST
  • AWS_APPLICATION_LOAD_BALANCER
  • AWS_AVAILABILITY_ZONE
  • AWS_CREDENTIALS
  • AWS_LAMBDA_FUNCTION
  • AWS_NETWORK_LOAD_BALANCER
  • AZURE_API_MANAGEMENT_SERVICE
  • AZURE_APPLICATION_GATEWAY
  • AZURE_COSMOS_DB
  • AZURE_CREDENTIALS
  • AZURE_EVENT_HUB
  • AZURE_EVENT_HUB_NAMESPACE
  • AZURE_FUNCTION_APP
  • AZURE_IOT_HUB
  • AZURE_LOAD_BALANCER
  • AZURE_MGMT_GROUP
  • AZURE_REDIS_CACHE
  • AZURE_REGION
  • AZURE_SERVICE_BUS_NAMESPACE
  • AZURE_SERVICE_BUS_QUEUE
  • AZURE_SERVICE_BUS_TOPIC
  • AZURE_SQL_DATABASE
  • AZURE_SQL_ELASTIC_POOL
  • AZURE_SQL_SERVER
  • AZURE_STORAGE_ACCOUNT
  • AZURE_SUBSCRIPTION
  • AZURE_TENANT
  • AZURE_VM
  • AZURE_VM_SCALE_SET
  • AZURE_WEB_APP
  • CF_APPLICATION
  • CF_FOUNDATION
  • CINDER_VOLUME
  • CLOUD_APPLICATION
  • CLOUD_APPLICATION_INSTANCE
  • CLOUD_APPLICATION_NAMESPACE
  • CONTAINER_GROUP
  • CONTAINER_GROUP_INSTANCE
  • CUSTOM_APPLICATION
  • CUSTOM_DEVICE
  • CUSTOM_DEVICE_GROUP
  • DCRUM_APPLICATION
  • DCRUM_SERVICE
  • DCRUM_SERVICE_INSTANCE
  • DEVICE_APPLICATION_METHOD
  • DISK
  • DOCKER_CONTAINER_GROUP_INSTANCE
  • DYNAMO_DB_TABLE
  • EBS_VOLUME
  • EC2_INSTANCE
  • ELASTIC_LOAD_BALANCER
  • ENVIRONMENT
  • EXTERNAL_SYNTHETIC_TEST_STEP
  • GCP_ZONE
  • GEOLOCATION
  • GEOLOC_SITE
  • GOOGLE_COMPUTE_ENGINE
  • HOST
  • HOST_GROUP
  • HTTP_CHECK
  • HTTP_CHECK_STEP
  • HYPERVISOR
  • KUBERNETES_CLUSTER
  • KUBERNETES_NODE
  • MOBILE_APPLICATION
  • NETWORK_INTERFACE
  • NEUTRON_SUBNET
  • OPENSTACK_PROJECT
  • OPENSTACK_REGION
  • OPENSTACK_VM
  • OS
  • PROCESS_GROUP
  • PROCESS_GROUP_INSTANCE
  • RELATIONAL_DATABASE_SERVICE
  • SERVICE
  • SERVICE_INSTANCE
  • SERVICE_METHOD
  • SERVICE_METHOD_GROUP
  • SWIFT_CONTAINER
  • SYNTHETIC_LOCATION
  • SYNTHETIC_TEST
  • SYNTHETIC_TEST_STEP
  • VIRTUALMACHINE
  • VMWARE_DATACENTER

Response format

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.

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

The request consumes an application/json payload.

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

POST
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/extensions/{id}/instances/validator
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/extensions/{id}/instances/validator

Response code

Code Description
204 Validated. The submitted configuration is valid. Response doesn't have a body.
400 Failed. The input is invalid.