Skip to main content
GET
/
api
/
projects
/
{projectId}
/
releases
/
{releaseId}
Get a release
curl --request GET \
  --url https://api.example.com/api/projects/{projectId}/releases/{releaseId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "<string>",
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deletedAt": "<string>",
  "name": "<string>",
  "description": "<string>",
  "version": 123,
  "semanticVersion": "<string>",
  "status": "draft",
  "createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "commitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "meta": {
    "bucket": "<string>",
    "key": "<string>"
  },
  "files": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "path": "<string>",
      "releaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "contentType": "<string>",
      "contentHash": "<string>",
      "versionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "<string>",
      "diffStatus": "added",
      "previousReleaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "previousId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "createdBy": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "[email protected]",
    "firstName": "<string>",
    "lastName": "<string>",
    "type": "<string>",
    "status": "<string>"
  },
  "changeRequests": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "<string>",
      "environment": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Personal access token is obtained through your profile

Path Parameters

projectId
string<uuid>
required

Project unique identifier

releaseId
string<uuid>
required

Release unique identifier

Query Parameters

previousReleaseId
string<uuid>

Previous release ID for computing file diffs

Response

200 - application/json

Release details with files

Release details with files

id
string<uuid>
required

Release unique identifier

createdAt
string
required

Release creation timestamp

projectId
string<uuid>
required

Project ID the release belongs to

deletedAt
string | null

Release deletion timestamp

name
string | null

Release name

description
string | null

Release description

version
number | null

Legacy numeric version

semanticVersion
string | null

Semantic version (e.g., 1.0.0)

status
enum<string>

Release status

Available options:
draft,
published,
completed
createdById
string<uuid> | null

ID of the user who created the release

commitId
string<uuid> | null

Associated commit ID

meta
object

Release storage metadata

files
object[]

List of files in the release

createdBy
object

User who created the release

changeRequests
object[]

Pending change requests