Skip to content

A deployment

GET
/v1/buyer/page-deployments/{id}
curl --request GET \
--url https://example.com/v1/buyer/page-deployments/example \
--header 'Authorization: Bearer <token>'

Who: a workspace’s member, staff under its support access, or its key. API keys with the buyer:read or buyer:write scope.

id
required
string

OK

Media typeapplication/json
object
attempts
required
integer format: int32
build_id
required
string
build_number
required
integer format: int32
created_at
required
string format: date-time
created_by
required
Any of:
object
account
string
id
string
kind
required
string | null
Allowed values: user api_key service system postback rule tuner schedule
name
string
error_code
required
string
error_message
required
string
finished_at
required
string | null format: date-time
id
required
string
next_attempt_at
required
string | null format: date-time
page_id
required
integer format: int64
rollback
required
boolean
started_at
required
string | null format: date-time
status
required
string | null
Allowed values: pending running succeeded failed
target_id
required
integer | null format: int64
target_kind
required
string | null
Allowed values: hosted aws gcp vps
url
required
string
workspace_id
required
integer format: int64

Example

{
"created_by": {
"kind": "user"
},
"status": "pending",
"target_kind": "hosted"
}

An error, as go-commons apperr maps it

Media typeapplication/json
object
error
required
object
code
required
string
fields
object
key
additional properties
string
message
required
string

Example generated

{
"error": {
"code": "example",
"fields": {
"additionalProperty": "example"
},
"message": "example"
}
}