Skip to main content
GET
Get order draft

Authorizations

Authorization
string
header
required

Bearer token for the authenticated caller.

Path Parameters

id
string
required

Order draft ID

Required string length: 1 - 55
Example:

"odft_j572abc..."

Response

Order draft, with what is missing and wrong now

id
string
required

Order draft ID

Required string length: 1 - 55
Example:

"odft_j572abc..."

offer_id
string
required

The Offer this draft redeems

status
enum<string>
required

draft: editable. redeeming: fields frozen while the Offer is redeemed and the Install created; :redeem again resumes it. installing: the Install exists (install_id, operation_id). failed: the Offer redeemed but the Install could not be created (condition install-failed). cancelled: ended by the customer.

Available options:
draft,
redeeming,
installing,
cancelled,
failed
workspace_id
string | null
required
cluster_id
string | null
required
values
object
required

The customer's configuration values, without the Offer's values and without sensitive values.

missing
object[]
required

Something :redeem still needs.

problems
object[]
required

Something wrong now; :redeem refuses while any is present.

install_id
string | null
required
operation_id
string | null
required

The Install's create Operation; poll /v1/operations

conditions
object[]
required

What needs attention now; empty when nothing does. Reasons:

  • install-failed (error): the Offer was redeemed but the Install could not be created; the draft is failed.
Maximum array length: 32
redeemed_at
integer | null
required

Unix timestamp (seconds)

Required range: x >= 0
created_at
integer
required

Unix timestamp (seconds)

Required range: x >= 0
updated_at
integer
required

Unix timestamp (seconds)

Required range: x >= 0
expires_at
integer
required

Unix timestamp (seconds)

Required range: x >= 0
etag
string
required