A deployment
GET
/v1/buyer/page-deployments/{id}
const url = 'https://example.com/v1/buyer/page-deployments/example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string
Responses
Section titled “Responses”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
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
target_id
required
integer | null format: int64
target_kind
required
string | null
url
required
string
workspace_id
required
integer format: int64
Example
{ "created_by": { "kind": "user" }, "status": "pending", "target_kind": "hosted"}default
Section titled “default”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" }}