Deployment API - GET available versions of BOSH tarballs

  • Reference
  • Published Aug 28, 2019

Gets the list of available OneAgent versions for BOSH release tarballs.

The request produces an application/json payload.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v1/deployment/boshrelease/versions/{osType}
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v1/deployment/boshrelease/versions/{osType}

Authentication

To execute this request, you need an access token with InstallerDownload scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
osTypestring

The operating system of the installer.

The element can hold these values
  • windows
  • unix
pathRequired

Response

Response codes

CodeTypeDescription
200BoshReleaseAvailableVersions

Success

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The BoshReleaseAvailableVersions object

A list of available OneAgent versions for BOSH release tarballs.

ElementTypeDescription
availableVersionsstring[]

A list of available OneAgent versions for BOSH release tarballs.

The ErrorEnvelope object

ElementTypeDescription
errorError-

The Error object

ElementTypeDescription
codeinteger

The HTTP status code

constraintViolationsConstraintViolation[]

A list of constraint violations

messagestring

The error message

The ConstraintViolation object

A list of constraint violations

ElementTypeDescription
locationstring-
messagestring-
parameterLocationstring-
The element can hold these values
  • HEADER
  • PATH
  • PAYLOAD_BODY
  • QUERY
pathstring-

Response body JSON models

{
"availableVersions": [
"string"
]
}
{
"error": {
"code": 1,
"constraintViolations": [
{
"location": "string",
"message": "string",
"parameterLocation": "HEADER",
"path": "string"
}
],
"message": "string"
}
}