Skip to main content
POST
Cancel

Authorizations

Authorization
string
header
required

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

Path Parameters

execution_id
string
required
Pattern: ^[0-9a-f]{32}$

Query Parameters

project
string
required
Required string length: 1 - 256

Body

application/json
note
string
required
Required string length: 1 - 1024

Response

Successful Response

execution_id
string
required
Pattern: ^[0-9a-f]{32}$
plan_digest
string
required
Pattern: ^[0-9a-f]{64}$
state
enum<string>
required
Available options:
active,
drained,
cancelled,
failed
total_units
integer
required
Required range: 0 <= x <= 9223372036854776000
accepted_units
integer
required
Required range: 0 <= x <= 9223372036854776000
bytes_fetched
integer
required
Required range: 0 <= x <= 9223372036854776000
bytes_decoded
integer
required
Required range: 0 <= x <= 9223372036854776000
records_seen
integer
required
Required range: 0 <= x <= 9223372036854776000
created_at_ms
integer
required
Required range: 0 <= x <= 9223372036854776000
ended_at_ms
integer | null
required
Required range: 0 <= x <= 9223372036854776000
purpose
string | null
sealed_at_ms
integer | null
Required range: 0 <= x <= 9223372036854776000