v1

latestOpenAPI 3.1.02026-07-261344388.3 KB
Release

Get a release

Retrieve a single release by ID, optionally including diff information compared to a previous release.

get/api/projects/{projectId}/releases/{releaseId}

Path parameters

projectIdstring uuid required

Project unique identifier

releaseIdstring uuid required

Release unique identifier

Query parameters

previousReleaseIdstring uuid

Previous release ID for computing file diffs

Response

Release details with files

idstring uuid required

Release unique identifier

createdAtstring required

Release creation timestamp

deletedAtstring nullable

Release deletion timestamp

namestring nullable

Release name

descriptionstring nullable

Release description

versionnumber nullable

Legacy numeric version

semanticVersionstring nullable

Semantic version (e.g., 1.0.0)

status'draft' | 'published' | 'completed'

Release status

projectIdstring uuid required

Project ID the release belongs to

createdByIdstring uuid nullable

ID of the user who created the release

commitIdstring uuid nullable

Associated commit ID