Try it free

Validate a forwarding connection

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026

Validate a Data Forwarding connection configuration in Dynatrace before pipeline activation, confirming the connection and deleting the test file.

POSTSaaShttps://{your-environment-id}.apps.dynatrace.com/v1/forwarding:validate

Overview

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.

Authentication

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.

Parameters

ParameterTypeDescriptionInRequired
bodyForwardingValidationRequest-bodyRequired

Request body objects

The ForwardingValidationRequest object

ElementTypeDescriptionRequired
cloudVendorTypestring-Required

Request body JSON model

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"
}
}

Response

Response codes

CodeTypeDescription
200ForwardingValidationResponse

Connection properly established, file deleted.

204-

Connection properly established, file could not be deleted.

400ErrorEnvelope

Bad Request: The request could not be processed due to invalid connection id or bucket/container name.

403ErrorEnvelope

Forbidden: Access to the resource was denied.

500ErrorEnvelope

Server error.

503ErrorEnvelope

Service Unavailable: Cloud service connection issue.

4XXErrorEnvelope

Client-side error.

5XXErrorEnvelope

Server-side error.

Response body objects

The ForwardingValidationResponse object

ElementTypeDescription
codeinteger

Http status code of the response.

messagestring

Information about the operation.

The ErrorEnvelope object

ElementTypeDescription
errorErrorResponse-

The ErrorResponse object

ElementTypeDescription
codeinteger-
detailsErrorResponseDetails-
messagestring-
retryAfterSecondsinteger-

The ErrorResponseDetails object

ElementTypeDescription
argumentsstring[]-
constraintViolationsErrorResponseDetailsConstraintViolationsInner[]-
errorMessagestring-
errorMessageFormatstring-
errorMessageFormatSpecifierTypesstring[]-
errorTypestring-
exceptionTypestring-
missingPermissionsstring[]-
missingScopesstring[]-
queryIdstring-
queryStringstring-
syntaxErrorPositionTokenPosition-

The ErrorResponseDetailsConstraintViolationsInner object

ElementTypeDescription
messagestring-
parameterDescriptorstring-
parameterLocationstring-

The TokenPosition object

ElementTypeDescription
endPositionInfo-
startPositionInfo-

The PositionInfo object

ElementTypeDescription
columninteger-
indexinteger-
lineinteger-

Response body JSON models

{
"code": "200",
"message": "File created and deleted."
}
{
"error": {
"message": "Invalid connection id or bucket/container name.",
"code": 400
}
}
Related tags
Platform APIDynatrace Platform