Get location deployment YAML in Dynatrace with the Synthetic API for Kubernetes or OpenShift, using location, ActiveGate, namespace, and image settings.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/synthetic/v1/locations/{location-id}/yaml |
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.
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.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| location-id | string | The ID of the required location. | path | Required |
| active-gate-name | string | The name of the ActiveGate. | query | Optional |
| namespace | string | The target namespace. | query | Optional |
| custom-registry | string | Custom image registry prefix; replaces | query | Optional |
| tag-version-active-gate | string | Custom version tag for ActiveGate; used as the desired ActiveGate version in the generated YAML. | query | Optional |
| tag-version-synthetic | string | Custom version tag for Synthetic; used as the desired Synthetic version in the generated YAML. | query | Optional |
| Code | Type | Description |
|---|---|---|
| 200 | - | Success. The response contains the content of the YAML deployment file. |
| 4XX | Error | Client side error. |
| 5XX | Error | Server side error. |
ErrorResponseEnvelope objectEncloses the encountered error.
| Element | Type | Description |
|---|---|---|
| error | Error | Basic information of the encountered error. |
ErrorResponse objectBasic information of the encountered error.
| Element | Type | Description |
|---|---|---|
| code | integer | The returned HTTP status code. |
| details | Error | Detailed information of the error. |
| message | string | Description of the encountered error. |
ErrorResponseDetails objectDetailed information of the error.
| Element | Type | Description |
|---|---|---|
| type | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
|
{"error": {"code": 1,"details": {"type": "constraintViolation"},"message": "string"}}