v1

latestOpenAPI 3.0.3MIT2026-07-22399194.2 KB
Releases

Create

Create a new release.

post/releases

Query parameters

expandReleaseExpansion[]

Fields to expand on the release resource.

[
  "config_schemas"
]

Request body

versionstring required

The version of the release.

config_schema_idsstring[] required

The IDs of the config schemas included in the release.

Example request

{
  "version": "v1.0.0",
  "config_schema_ids": [
    "cfg_sch_123"
  ],
  "git_commit_ref": {
    "id": "git_cmt_123",
    "sha": "1a2b3c4d..."
  }
}

Response

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