Skip to main content
POST
Release

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId
string
required
Pattern: ^[1-9]\d{0,18}$
projectId
string
required
Pattern: ^[1-9]\d{0,18}$

Body

application/json
expectedDraftVersion
integer
required
Required range: 0 <= x <= 9007199254740991
expectedStructureVersion
integer
required
Required range: 0 <= x <= 9007199254740991
expectedItemsFingerprint
string
required
Pattern: ^[a-f0-9]{64}$
idempotencyKey
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
note
string | null
Maximum string length: 160

Response

201 - application/json
id
string
required
number
number
required
note
string | null
required
releasedAt
string<date-time>
required
releasedBy
object
required
archivedAt
string<date-time> | null
required
summary
object
required
snapshot
object
required