Sign in
Release

Update a release

Update information for a release.

patch/release/{id}

Path parameters

idinteger required

The ID of the release.

Request body

status'active' | 'pending' | 'deprecated' | 'failed' | 'unstable'

The status of the release.

Example request

{
  "status": "active",
  "asset": {
    "id": 123,
    "buildId": 456,
    "type": "docker-image",
    "url": "https://example.com/assets/456"
  }
}

Response

The operation was successful.

idinteger required

A system-wide unique ID for the release.

semverstring required

A version identifier following Semantic Versioning (SemVer) conventions."

buildIdinteger required

The ID of the build to be released.

status'active' | 'pending' | 'deprecated' | 'failed' | 'unstable' required

The status of the release.

created_atstring date-time required

The timestamp when the entity was created.

updated_atstring date-time required

The timestamp when the entity was created.

Example response

{
  "id": 789,
  "semver": "1.0.1-rc1",
  "buildId": 456,
  "status": "active",
  "asset": {
    "id": 123,
    "buildId": 456,
    "type": "docker-image",
    "url": "https://example.com/assets/456"
  },
  "created_at": "2023-10-01T12:34:56Z",
  "updated_at": "2023-10-01T12:34:56Z"
}

Changes