Try it free

Get location deployment YAML

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026
  • Early Access

Get location deployment YAML in Dynatrace with the Synthetic API for Kubernetes or OpenShift, using location, ActiveGate, namespace, and image settings.

GETSaaShttps://{your-environment-id}.apps.dynatrace.com/platform/synthetic/v1/locations/{location-id}/yaml

Overview

You use the location YAML endpoint to get the deployment file content for a Kubernetes or OpenShift cluster. The path parameter location-id identifies the location, and query parameters such as active-gate-name, namespace, custom-registry, tag-version-active-gate, and tag-version-synthetic shape the generated YAML.

Authentication

To execute this request, you need a platform token or OAuth access token with synthetic:locations:read scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
location-idstring

The ID of the required location.

pathRequired
active-gate-namestring

The name of the ActiveGate.

queryOptional
namespacestring

The target namespace.

queryOptional
custom-registrystring

Custom image registry prefix; replaces dynatrace in image URLs in the generated YAML.

queryOptional
tag-version-active-gatestring

Custom version tag for ActiveGate; used as the desired ActiveGate version in the generated YAML.

queryOptional
tag-version-syntheticstring

Custom version tag for Synthetic; used as the desired Synthetic version in the generated YAML.

queryOptional

Response

Response codes

CodeTypeDescription
200-

Success. The response contains the content of the YAML deployment file.

4XXErrorResponseEnvelope

Client side error.

5XXErrorResponseEnvelope

Server side error.

Response body objects

The ErrorResponseEnvelope object

Encloses the encountered error.

ElementTypeDescription
errorErrorResponse

Basic information of the encountered error.

The ErrorResponse object

Basic information of the encountered error.

ElementTypeDescription
codeinteger

The returned HTTP status code.

detailsErrorResponseDetails

Detailed information of the error.

messagestring

Description of the encountered error.

The ErrorResponseDetails object

Detailed information of the error.

ElementTypeDescription
typestring

Defines the actual set of fields depending on the value. See one of the following objects:

  • constraintViolation -> ConstraintViolationDetails
The element can hold these values
  • constraintViolation

Response body JSON models

{
"error": {
"code": 1,
"details": {
"type": "constraintViolation"
},
"message": "string"
}
}
Related tags
Platform APIDynatrace PlatformDigital Experience