Skip to main content
POST
deploy.service.state.update

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
id
string
required

Identifier in your connected hosting account.

Pattern: ^[A-Za-z0-9_-]{1,100}$
confirm
boolean
required

Explicitly approve this change, including removal or replacement of existing configuration.

state
enum<string>
required

Requested suspension state.

Available options:
active,
suspended

Response

The result

accepted
boolean
required

Request accepted; use service.get to check state.