Skip to content
Start here

Deployments

List deployments
GET/accounts/{account_id}/cws/deployments
Get a deployment by ID
GET/accounts/{account_id}/cws/deployments/{deployment_id}
Create a new deployment
POST/accounts/{account_id}/cws/deployments
Update a deployment
PUT/accounts/{account_id}/cws/deployments/{deployment_id}
Delete a deployment
DELETE/accounts/{account_id}/cws/deployments/{deployment_id}
ModelsExpand Collapse
Deployment object { id, basic_auth_credential_ids, created_at, 9 more }
id: string

Server-assigned UUID

formatuuid
basic_auth_credential_ids: array of string

IDs of basic-auth credentials attached to this deployment

created_at: string
formatdate-time
default_mode: "ALLOW" or "BLOCK"

Default traffic decision when no policy set matches

One of the following:
"ALLOW"
"BLOCK"
name: string

Human-readable name; unique per account

maxLength100
minLength1
on_error_action: "BLOCK" or "SKIP"

Action applied when an enforcing policy has a runtime Rego error

One of the following:
"BLOCK"
"SKIP"
policy_set_ids: array of string

IDs of policy sets attached to this deployment

rego_raise_error: boolean

Whether OPA builtin failures are raised as runtime evaluation errors

tags: map[string]

Tags attached to this deployment

updated_at: string
formatdate-time
description: optional string

Optional free-form description.

maxLength1024
domain_acl_id: optional string

ID of the attached domain ACL. Omitted when none.

formatuuid
DeploymentDeleteResponse object { id }
id: string
formatuuid