Deployment API - GET checksum of a BOSH tarball

Gets the checksum of the specified BOSH release tarball. The checksum is the SHA-256 hash of the installer file.

The result is not stable if the skipMetadata query parameter is set to false.

The request produces an application/json payload.

This request is an early adopter release and may be changed in non compatible way.

  • Managed https://{your-domain}/e/{your-environment-id}/api/v1/deployment/boshrelease/agent/{osType}/version/{version}/checksum
  • SaaS https://{your-environment-id}{osType}/version/{version}/checksum


To execute this request, you need the PaaS token of your environment. See Why do I need an environment ID? to learn how to obtain it.


Parameter Type Description In Required
osType string

The operating system of the installer.

The osType element can hold these values.
path required
version string

The required version of the OneAgent in format.

You can retrieve the list of available versions with the GET /deployment/boshrelease/versions/{osType} call.

path required
skipMetadata boolean

Set true to omit the OneAgent connectivity information from the installer.

If not set, false is used.

query optional

Possible values

Possible values for the osType element:

  • windows
  • unix

Response format

The BoshReleaseChecksum object

The checksum of the BOSH release tarball.

Element Type Description
sha256 string

The checksum of the BOSH release tarball.

This is the sha256 hash of the installer file.