Validate a Data Forwarding connection configuration in Dynatrace before pipeline activation, confirming the connection and deleting the test file.
| POST | SaaS | https://{your-environment-id}.apps.dynatrace.com/v1/forwarding:validate |
You provide the cloudVendorType in the request body to validate a Data Forwarding connection configuration before pipeline activation. Dynatrace returns a 200 response when the connection is properly established and the file is deleted.
To execute this request, you need a platform token or OAuth access token with openpipeline:data-forwarding:validate scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| body | Forwarding | - | body | Required |
ForwardingValidationRequest object| Element | Type | Description | Required |
|---|---|---|---|
| cloudVendorType | string | - | Required |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"cloudVendorType": "aws","awsConnection": {"connectionId": "12345678901234567890","bucketName": "my-example-bucket"}}
| Code | Type | Description |
|---|---|---|
| 200 | Forwarding | Connection properly established, file deleted. |
| 204 | - | Connection properly established, file could not be deleted. |
| 400 | Error | Bad Request: The request could not be processed due to invalid connection id or bucket/container name. |
| 403 | Error | Forbidden: Access to the resource was denied. |
| 500 | Error | Server error. |
| 503 | Error | Service Unavailable: Cloud service connection issue. |
| 4XX | Error | Client-side error. |
| 5XX | Error | Server-side error. |
ForwardingValidationResponse object| Element | Type | Description |
|---|---|---|
| code | integer | Http status code of the response. |
| message | string | Information about the operation. |
ErrorEnvelope object| Element | Type | Description |
|---|---|---|
| error | Error | - |
ErrorResponse object| Element | Type | Description |
|---|---|---|
| code | integer | - |
| details | Error | - |
| message | string | - |
| retryAfterSeconds | integer | - |
ErrorResponseDetails object| Element | Type | Description |
|---|---|---|
| arguments | string[] | - |
| constraintViolations | Error | - |
| errorMessage | string | - |
| errorMessageFormat | string | - |
| errorMessageFormatSpecifierTypes | string[] | - |
| errorType | string | - |
| exceptionType | string | - |
| missingPermissions | string[] | - |
| missingScopes | string[] | - |
| queryId | string | - |
| queryString | string | - |
| syntaxErrorPosition | Token | - |
ErrorResponseDetailsConstraintViolationsInner object| Element | Type | Description |
|---|---|---|
| message | string | - |
| parameterDescriptor | string | - |
| parameterLocation | string | - |
TokenPosition object| Element | Type | Description |
|---|---|---|
| end | Position | - |
| start | Position | - |
PositionInfo object| Element | Type | Description |
|---|---|---|
| column | integer | - |
| index | integer | - |
| line | integer | - |
{"code": "200","message": "File created and deleted."}
{"error": {"message": "Invalid connection id or bucket/container name.","code": 400}}