Try it free

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.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v1/deployment/boshrelease/versions/{osType}
GETEnvironment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v1/deployment/boshrelease/versions/{osType}

Authentication

Api-Token:

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

To learn how to obtain and use it, see Personal access tokens.

Platform Token / OAuth:

Required scope: fleet-management:oneagents:download

To learn how to obtain and use it, see Platform tokens or OAuth clients.

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