Sign in
Releases

Get

Retrieve a release by its ID.

get/releases/{release_id}

Path parameters

release_idstring required
Example:rls_123

The unique identifier of the release.

Response

Successfully retrieved the release.

object'release' required

The object type, which is always release.

idstring required

ID of the release.

versionstring required

The version of the release.

git_commit_idstring nullable required

The ID of the git commit associated with this release.

created_atstring date-time required

Timestamp of when the release was created.

Example response

{
  "object": "release",
  "id": "rls_123",
  "version": "v1.0.0",
  "git_commit_id": "git_commit_123",
  "created_at": "2024-01-01T00:00:00Z"
}

Changes

Changed in 1 of the 5 revisions of this API.16

  • 6c5a928176c516See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • ○

      removed BaseRelease from the response body allOf list for the response status 200

      response-body-all-of-removed

    • ○

      added the required property created_at to the response with the 200 status

      response-required-property-added

    • ○

      added the required property git_commit_id to the response with the 200 status

      response-required-property-added

    • ○

      added the required property id to the response with the 200 status

      response-required-property-added

    • ○

      added the required property object to the response with the 200 status

      response-required-property-added

    • ○

      added the required property version to the response with the 200 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog