Releases

Release management operations

List releases

get

Retrieve a list of releases with optional filtering

Authorizations

bearerAuthbasicAuth

Query parameters

offsetinteger · max: 1000Optional

Number of items to skip

Default: 0

limitinteger · min: 1 · max: 100Optional

Maximum number of items to return

Default: 10

slugstringOptional

Filter by release slug

is_publicbooleanOptional

Filter by public visibility

statusstring · enumOptional

Filter by release status

Possible values:

project_idstringOptional

Filter by project ID

Responses

200

List of releases retrieved successfully

application/json

400

Bad request - Invalid input parameters

application/json

401

Unauthorized - Invalid or missing authentication

application/json

get

HTTPcURLJavaScriptPython

GET /v1/releases HTTP/1.1
Host: api.onset.com
Authorization: Bearer JWT
Accept: */*

[
  {
    "id": "text",
    "title": "text",
    "body": "text",
    "slug": "text",
    "status": "DRAFT",
    "version": "text",
    "is_pinned": true,
    "is_public": true,
    "is_pre_release": true,
    "hero": null,
    "changes": [
      {
        "id": "text",
        "change_id": "text",
        "content": "text"
      }
    ],
    "project": {
      "id": "text",
      "name": "text"
    },
    "labels": [
      {
        "id": "text",
        "name": "text",
        "color": "text"
      }
    ],
    "released_at": "2025-09-12T23:45:23.515Z",
    "created_at": "2025-09-12T23:45:23.515Z",
    "updated_at": "2025-09-12T23:45:23.515Z"
  }
]

Create a new release

post

Create a new release in the workspace

Authorizations

bearerAuthbasicAuth

Body

application/json

titlestring · min: 3 · max: 255Required

Release title

bodystringOptional

Release description/body content

statusstring · enumRequired

Release status

Possible values:

slugstring · min: 3 · max: 255Required

URL-friendly release identifier

Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

is_publicbooleanOptional

Whether release should be publicly visible

project_idstringOptional

ID of the project this release belongs to

label_idsstring[]Optional

Array of label IDs to attach to the release

is_pinnedbooleanOptional

Whether release should be pinned

is_pre_releasebooleanOptional

Whether this is a pre-release

versionstring | nullableOptional

Release version

Responses

201

Release created successfully

application/json

400

Bad request - Invalid input parameters

application/json

401

Unauthorized - Invalid or missing authentication

application/json

post

HTTPcURLJavaScriptPython

POST /v1/releases HTTP/1.1
Host: api.onset.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 395

{
  "title": "text",
  "body": "text",
  "status": "DRAFT",
  "slug": "text",
  "is_public": true,
  "project_id": "text",
  "label_ids": [
    "text"
  ],
  "attachments": [
    {
      "id": "text",
      "type": "FILE",
      "content": {
        "title": "text",
        "url": "text",
        "size": 1,
        "type": "text"
      }
    }
  ],
  "hero": {
    "type": "image",
    "url": "https://example.com"
  },
  "changes": [
    {
      "id": "text",
      "changeId": "text",
      "content": "text"
    }
  ],
  "is_pinned": true,
  "is_pre_release": true,
  "version": "text"
}

{
  "id": "text",
  "title": "text",
  "body": "text",
  "slug": "text",
  "status": "DRAFT",
  "version": "text",
  "is_pinned": true,
  "is_public": true,
  "is_pre_release": true,
  "hero": null,
  "changes": [
    {
      "id": "text",
      "change_id": "text",
      "content": "text"
    }
  ],
  "project": {
    "id": "text",
    "name": "text"
  },
  "labels": [
    {
      "id": "text",
      "name": "text",
      "color": "text"
    }
  ],
  "released_at": "2025-09-12T23:45:23.515Z",
  "created_at": "2025-09-12T23:45:23.515Z",
  "updated_at": "2025-09-12T23:45:23.515Z"
}

Get release by ID

get

Retrieve a specific release by its ID

Authorizations

bearerAuthbasicAuth

Path parameters

idstringRequired

Release ID

Responses

200

Release retrieved successfully

application/json

401

Unauthorized - Invalid or missing authentication

application/json

404

Not found - Resource does not exist

application/json

get

HTTPcURLJavaScriptPython

GET /v1/releases/{id} HTTP/1.1
Host: api.onset.com
Authorization: Bearer JWT
Accept: */*

{
  "id": "text",
  "title": "text",
  "body": "text",
  "slug": "text",
  "status": "DRAFT",
  "version": "text",
  "is_pinned": true,
  "is_public": true,
  "is_pre_release": true,
  "hero": null,
  "changes": [
    {
      "id": "text",
      "change_id": "text",
      "content": "text"
    }
  ],
  "project": {
    "id": "text",
    "name": "text"
  },
  "labels": [
    {
      "id": "text",
      "name": "text",
      "color": "text"
    }
  ],
  "released_at": "2025-09-12T23:45:23.515Z",
  "created_at": "2025-09-12T23:45:23.515Z",
  "updated_at": "2025-09-12T23:45:23.515Z"
}

Delete release

delete

Delete a release by its ID

Authorizations

bearerAuthbasicAuth

Path parameters

idstringRequired

Release ID

Responses

204

Release deleted successfully

No content

401

Unauthorized - Invalid or missing authentication

application/json

404

Not found - Resource does not exist

application/json

delete

HTTPcURLJavaScriptPython

DELETE /v1/releases/{id} HTTP/1.1
Host: api.onset.com
Authorization: Bearer JWT
Accept: */*

No content

Update release

patch

Update an existing release

Authorizations

bearerAuthbasicAuth

Path parameters

idstringRequired

Release ID

Body

application/json

titlestring · min: 3 · max: 255Optional

Release title

bodystringOptional

Release description/body content

statusstring · enumOptional

Release status

Possible values:

slugstring · min: 3 · max: 255Optional

URL-friendly release identifier

Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

is_publicbooleanOptional

Whether release should be publicly visible

project_idstring | nullableOptional

ID of the project this release belongs to

label_idsstring[]Optional

Array of label IDs to attach to the release

heroone ofOptional

Hero image/video for the release

nullOptional

or

is_pinnedbooleanOptional

Whether release should be pinned

is_pre_releasebooleanOptional

Whether this is a pre-release

versionstring | nullableOptional

Release version

Responses

200

Release updated successfully

application/json

400

Bad request - Invalid input parameters

application/json

401

Unauthorized - Invalid or missing authentication

application/json

404

Not found - Resource does not exist

application/json

patch

HTTPcURLJavaScriptPython

PATCH /v1/releases/{id} HTTP/1.1
Host: api.onset.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 355

{
  "title": "text",
  "body": "text",
  "status": "DRAFT",
  "slug": "text",
  "is_public": true,
  "project_id": "text",
  "label_ids": [
    "text"
  ],
  "attachments": [
    {
      "id": "text",
      "type": "FILE",
      "content": {
        "title": "text",
        "url": "text",
        "size": 1,
        "type": "text"
      }
    }
  ],
  "hero": null,
  "changes": [
    {
      "id": "text",
      "changeId": "text",
      "content": "text"
    }
  ],
  "is_pinned": true,
  "is_pre_release": true,
  "version": "text"
}

{
  "id": "text",
  "title": "text",
  "body": "text",
  "slug": "text",
  "status": "DRAFT",
  "version": "text",
  "is_pinned": true,
  "is_public": true,
  "is_pre_release": true,
  "hero": null,
  "changes": [
    {
      "id": "text",
      "change_id": "text",
      "content": "text"
    }
  ],
  "project": {
    "id": "text",
    "name": "text"
  },
  "labels": [
    {
      "id": "text",
      "name": "text",
      "color": "text"
    }
  ],
  "released_at": "2025-09-12T23:45:23.515Z",
  "created_at": "2025-09-12T23:45:23.515Z",
  "updated_at": "2025-09-12T23:45:23.515Z"
}