Releases

Get

Retrieve a release by ID.

get/releases/{release_id}

Path parameters

release_idstring required
Example:rls_123

The unique identifier of the release.

Query parameters

expandReleaseExpansion[]

Fields to expand on the release resource.

[
  "config_schemas"
]

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.

updated_atstring date-time required

Timestamp of when the release was last updated.

Example response

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

Changes

Changed in 2 of the 6 revisions of this API.4

    • added ConfigType to the allOf[subschema #2]/config_schemas/items/allOf[subschema #2]/config_type response property allOf list for the response status 200

      response-property-all-of-added

    • removed BaseConfigType from the allOf[subschema #2]/config_schemas/items/allOf[subschema #2]/config_type response property allOf list for the response status 200

      response-property-all-of-removed

    • added BaseConfigType to the allOf[subschema #2]/config_schemas/items/allOf[subschema #2]/config_type response property allOf list for the response status 200

      response-property-all-of-added

    • removed ConfigType from the allOf[subschema #2]/config_schemas/items/allOf[subschema #2]/config_type response property allOf list for the response status 200

      response-property-all-of-removed

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