Skip to main content
POST
Record a deployment

Authorizations

oiq_token
string
cookie
required

Query Parameters

tenantId
string

Tenant identifier. Overwritten from the authenticated session; a value naming a different tenant is refused with 403.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9][A-Za-z0-9_-]*$

Body

application/json
service
string
Maximum string length: 256
version
string
Maximum string length: 256
environment
string | null
Maximum string length: 512
status
string

One of pending, in_progress, success, failed, rolled_back. Default success.

Maximum string length: 32
deployer
string | null
Maximum string length: 512
gitSha
string | null
Maximum string length: 512
gitRef
string | null
Maximum string length: 512
notes
string | null
Maximum string length: 8192
metadata
object | null
startedAt
string | null

ISO-8601. Defaults to now.

finishedAt
string | null

ISO-8601. Null while in progress.

Response

200

Success