API Reference

Zero Trust

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Cloud Workload Security

Cloud Workload SecurityBasic Auth Credentials

List basic-auth credentials for an account

client.zeroTrust.cws.basicAuthCredentials.list(BasicAuthCredentialListParams { account_id, cursor, deployment_id, 4 more } params, RequestOptionsoptions?): CursorPagination<BasicAuthCredential { id, created_at, updated_at, username } >

GET/accounts/{account_id}/cws/basic-auth-credentials

Get a basic-auth credential by ID

client.zeroTrust.cws.basicAuthCredentials.get(stringcredentialID, BasicAuthCredentialGetParams { account_id } params, RequestOptionsoptions?): BasicAuthCredential { id, created_at, updated_at, username }

GET/accounts/{account_id}/cws/basic-auth-credentials/{credential_id}

Create a basic-auth credential

client.zeroTrust.cws.basicAuthCredentials.create(BasicAuthCredentialCreateParams { account_id, username } params, RequestOptionsoptions?): BasicAuthCredential { id, created_at, updated_at, username }

POST/accounts/{account_id}/cws/basic-auth-credentials

Delete a basic-auth credential

client.zeroTrust.cws.basicAuthCredentials.delete(stringcredentialID, BasicAuthCredentialDeleteParams { account_id } params, RequestOptionsoptions?): BasicAuthCredentialDeleteResponse { id }

DELETE/accounts/{account_id}/cws/basic-auth-credentials/{credential_id}

ModelsExpand Collapse

BasicAuthCredential { id, created_at, updated_at, username }

id: string

Server-assigned UUID

formatuuid

created_at: string

formatdate-time

updated_at: string

formatdate-time

username: string

Login presented by the client. Printable ASCII only, excluding space and colon (RFC 7617 forbids a colon in the user-id).

maxLength100

minLength1

BasicAuthCredentialDeleteResponse { id }

id: string

formatuuid

Cloud Workload SecurityBasic Auth CredentialsSecrets

List secrets for a basic-auth credential

client.zeroTrust.cws.basicAuthCredentials.secrets.list(stringcredentialID, SecretListParams { account_id, cursor, direction, 2 more } params, RequestOptionsoptions?): CursorPagination<BasicAuthSecret { id, created_at, expires_at } >

GET/accounts/{account_id}/cws/basic-auth-credentials/{credential_id}/secrets

Get a basic-auth secret by ID

client.zeroTrust.cws.basicAuthCredentials.secrets.get(stringsecretID, SecretGetParams { account_id, credential_id } params, RequestOptionsoptions?): BasicAuthSecret { id, created_at, expires_at }

GET/accounts/{account_id}/cws/basic-auth-credentials/{credential_id}/secrets/{secret_id}

Add a secret to a basic-auth credential

client.zeroTrust.cws.basicAuthCredentials.secrets.create(stringcredentialID, SecretCreateParams { account_id, password, expires_at } params, RequestOptionsoptions?): BasicAuthSecret { id, created_at, expires_at }

POST/accounts/{account_id}/cws/basic-auth-credentials/{credential_id}/secrets

Delete a basic-auth secret

client.zeroTrust.cws.basicAuthCredentials.secrets.delete(stringsecretID, SecretDeleteParams { account_id, credential_id } params, RequestOptionsoptions?): SecretDeleteResponse { id }

DELETE/accounts/{account_id}/cws/basic-auth-credentials/{credential_id}/secrets/{secret_id}

ModelsExpand Collapse

BasicAuthSecret { id, created_at, expires_at }

id: string

Server-assigned UUID

formatuuid

created_at: string

formatdate-time

expires_at?: string

Optional RFC 3339 expiration time. Omit for no expiration.

formatdate-time

SecretDeleteResponse { id }

id: string

formatuuid

Cloud Workload SecurityDeployments

List deployments

client.zeroTrust.cws.deployments.list(DeploymentListParams { account_id, cursor, direction, 3 more } params, RequestOptionsoptions?): CursorPagination<Deployment { id, basic_auth_credential_ids, created_at, 9 more } >

GET/accounts/{account_id}/cws/deployments

Get a deployment by ID

client.zeroTrust.cws.deployments.get(stringdeploymentID, DeploymentGetParams { account_id } params, RequestOptionsoptions?): Deployment { id, basic_auth_credential_ids, created_at, 9 more }

GET/accounts/{account_id}/cws/deployments/{deployment_id}

Create a new deployment

client.zeroTrust.cws.deployments.create(DeploymentCreateParams { account_id, basic_auth_credential_ids, default_mode, 7 more } params, RequestOptionsoptions?): Deployment { id, basic_auth_credential_ids, created_at, 9 more }

POST/accounts/{account_id}/cws/deployments

Update a deployment

client.zeroTrust.cws.deployments.update(stringdeploymentID, DeploymentUpdateParams { account_id, basic_auth_credential_ids, default_mode, 7 more } params, RequestOptionsoptions?): Deployment { id, basic_auth_credential_ids, created_at, 9 more }

PUT/accounts/{account_id}/cws/deployments/{deployment_id}

Delete a deployment

client.zeroTrust.cws.deployments.delete(stringdeploymentID, DeploymentDeleteParams { account_id } params, RequestOptionsoptions?): DeploymentDeleteResponse { id }

DELETE/accounts/{account_id}/cws/deployments/{deployment_id}

ModelsExpand Collapse

Deployment { id, basic_auth_credential_ids, created_at, 9 more }

id: string

Server-assigned UUID

formatuuid

basic_auth_credential_ids: Array<string> | null

IDs of basic-auth credentials attached to this deployment

created_at: string

formatdate-time

default_mode: "ALLOW" | "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" | "SKIP"

Action applied when an enforcing policy has a runtime Rego error

One of the following:

"BLOCK"

"SKIP"

policy_set_ids: Array<string> | null

IDs of policy sets attached to this deployment

rego_raise_error: boolean

Whether OPA builtin failures are raised as runtime evaluation errors

tags: Record<string, string>

Tags attached to this deployment

updated_at: string

formatdate-time

description?: string

Optional free-form description.

maxLength1024

domain_acl_id?: string

ID of the attached domain ACL. Omitted when none.

formatuuid

DeploymentDeleteResponse { id }

id: string

formatuuid

Cloud Workload SecurityDomain ACLs

List domain ACLs

client.zeroTrust.cws.domainACLs.list(DomainACLListParams { account_id, cursor, deployment_id, 4 more } params, RequestOptionsoptions?): CursorPagination<DomainACL { id, created_at, default_action, 3 more } >

GET/accounts/{account_id}/cws/domain-acls

Get a domain ACL by ID

client.zeroTrust.cws.domainACLs.get(stringdomainACLID, DomainACLGetParams { account_id } params, RequestOptionsoptions?): DomainACL { id, created_at, default_action, 3 more }

GET/accounts/{account_id}/cws/domain-acls/{domain_acl_id}

Create a new domain ACL

client.zeroTrust.cws.domainACLs.create(DomainACLCreateParams { account_id, default_action, entries, name } params, RequestOptionsoptions?): DomainACL { id, created_at, default_action, 3 more }

POST/accounts/{account_id}/cws/domain-acls

Update a domain ACL and replace its entries

client.zeroTrust.cws.domainACLs.update(stringdomainACLID, DomainACLUpdateParams { account_id, default_action, entries, name } params, RequestOptionsoptions?): DomainACL { id, created_at, default_action, 3 more }

PUT/accounts/{account_id}/cws/domain-acls/{domain_acl_id}

Delete a domain ACL

client.zeroTrust.cws.domainACLs.delete(stringdomainACLID, DomainACLDeleteParams { account_id } params, RequestOptionsoptions?): DomainACLDeleteResponse { id }

DELETE/accounts/{account_id}/cws/domain-acls/{domain_acl_id}

ModelsExpand Collapse

DomainACL { id, created_at, default_action, 3 more }

id: string

Server-assigned UUID

formatuuid

created_at: string

formatdate-time

default_action: "ALLOW" | "BLOCK"

Action applied when no entry matches the request domain

One of the following:

"ALLOW"

"BLOCK"

entries: Array<Entry> | null

Per-domain action overrides. Each domain appears at most once.

action: "ALLOW" | "BLOCK"

Per-domain decision overriding the parent ACL’s default_action

One of the following:

"ALLOW"

"BLOCK"

domain: string

Hostname or domain pattern, capped at 255 UTF-8 bytes

maxLength255

minLength1

name: string

Human-readable name; unique per account

maxLength100

minLength1

updated_at: string

formatdate-time

DomainACLDeleteResponse { id }

id: string

formatuuid

Cloud Workload SecurityPolicies

List policies

client.zeroTrust.cws.policies.list(PolicyListParams { account_id, cursor, direction, 5 more } params, RequestOptionsoptions?): CursorPagination<Policy { id, created_at, entrypoint, 7 more } >

GET/accounts/{account_id}/cws/policies

Get a policy by ID

client.zeroTrust.cws.policies.get(stringpolicyID, PolicyGetParams { account_id } params, RequestOptionsoptions?): Policy { id, created_at, entrypoint, 7 more }

GET/accounts/{account_id}/cws/policies/{policy_id}

Create a new policy

client.zeroTrust.cws.policies.create(PolicyCreateParams { account_id, entrypoint, name, 4 more } params, RequestOptionsoptions?): Policy { id, created_at, entrypoint, 7 more }

POST/accounts/{account_id}/cws/policies

Update a policy

client.zeroTrust.cws.policies.update(stringpolicyID, PolicyUpdateParams { account_id, entrypoint, name, 4 more } params, RequestOptionsoptions?): Policy { id, created_at, entrypoint, 7 more }

PUT/accounts/{account_id}/cws/policies/{policy_id}

Delete a policy

client.zeroTrust.cws.policies.delete(stringpolicyID, PolicyDeleteParams { account_id } params, RequestOptionsoptions?): PolicyDeleteResponse { id }

DELETE/accounts/{account_id}/cws/policies/{policy_id}

ModelsExpand Collapse

Policy { id, created_at, entrypoint, 7 more }

id: string

Server-assigned UUID

formatuuid

created_at: string

formatdate-time

entrypoint: string

Non-function rule declared in rego_source. Evaluation uses data.<package_path>..

maxLength255

filter: string | null

Optional filter expression that determines whether this policy applies. Null means the policy applies to every request. Maximum 4096 UTF-8 bytes.

maxLength4096

minLength1

name: string

Human-readable name; unique per account

maxLength100

minLength1

package_path: string

Dotted path derived from rego_source. Begins with policy. and is unique per account.

maxLength1024

rego_source: string

Inline Rego source with a package beginning with “policy.” Maximum 16384 UTF-8 bytes.

maxLength16384

minLength1

tags: Record<string, string>

Tags attached to this policy

updated_at: string

formatdate-time

description?: string

Optional free-form description.

maxLength1024

PolicyDeleteResponse { id }

id: string

formatuuid

Cloud Workload SecurityPolicy Sets

List policy sets

client.zeroTrust.cws.policySets.list(PolicySetListParams { account_id, cursor, deployment_id, 4 more } params, RequestOptionsoptions?): CursorPagination<PolicySet { id, created_at, exclude_workload_ids, 6 more } >

GET/accounts/{account_id}/cws/policy-sets

Get a policy set by ID

client.zeroTrust.cws.policySets.get(stringpolicySetID, PolicySetGetParams { account_id } params, RequestOptionsoptions?): PolicySet { id, created_at, exclude_workload_ids, 6 more }

GET/accounts/{account_id}/cws/policy-sets/{policy_set_id}

Create a new policy set

client.zeroTrust.cws.policySets.create(PolicySetCreateParams { account_id, name, policies, 4 more } params, RequestOptionsoptions?): PolicySet { id, created_at, exclude_workload_ids, 6 more }

POST/accounts/{account_id}/cws/policy-sets

Update a policy set

client.zeroTrust.cws.policySets.update(stringpolicySetID, PolicySetUpdateParams { account_id, name, policies, 4 more } params, RequestOptionsoptions?): PolicySet { id, created_at, exclude_workload_ids, 6 more }

PUT/accounts/{account_id}/cws/policy-sets/{policy_set_id}

Delete a policy set

client.zeroTrust.cws.policySets.delete(stringpolicySetID, PolicySetDeleteParams { account_id } params, RequestOptionsoptions?): PolicySetDeleteResponse { id }

DELETE/accounts/{account_id}/cws/policy-sets/{policy_set_id}

ModelsExpand Collapse

PolicySet { id, created_at, exclude_workload_ids, 6 more }

id: string

Server-assigned UUID

formatuuid

created_at: string

formatdate-time

exclude_workload_ids: Array<string> | null

IDs of workloads that exclude matching requests. Exclusions take precedence.

include_workload_ids: Array<string> | null

IDs of workloads that include matching requests. Empty includes all requests before exclusions.

name: string

Human-readable name; unique per account

maxLength100

minLength1

policies: Array<Policy> | null

Member policies and their per-membership enforcement mode

enforce: boolean

Whether this policy should enforce when it matches. False keeps the policy attached for non-enforcing evaluation.

policy_id: string

ID of the member policy

formatuuid

tags: Record<string, string>

Tags attached to this policy set

updated_at: string

formatdate-time

description?: string

Optional free-form description.

maxLength1024

PolicySetDeleteResponse { id }

id: string

formatuuid

Cloud Workload SecurityRego Metadata

List Rego metadata documents

client.zeroTrust.cws.regoMetadata.list(RegoMetadataListParams { account_id, cursor, direction, 4 more } params, RequestOptionsoptions?): CursorPagination<RegoMetadata { id, created_at, data, 3 more } >

GET/accounts/{account_id}/cws/rego-metadata

Get a rego metadata document by ID

client.zeroTrust.cws.regoMetadata.get(stringregoMetadataID, RegoMetadataGetParams { account_id } params, RequestOptionsoptions?): RegoMetadata { id, created_at, data, 3 more }

GET/accounts/{account_id}/cws/rego-metadata/{rego_metadata_id}

Create a new rego metadata document

client.zeroTrust.cws.regoMetadata.create(RegoMetadataCreateParams { account_id, data, import_path, name } params, RequestOptionsoptions?): RegoMetadata { id, created_at, data, 3 more }

POST/accounts/{account_id}/cws/rego-metadata

Update a rego metadata document

client.zeroTrust.cws.regoMetadata.update(stringregoMetadataID, RegoMetadataUpdateParams { account_id, data, import_path, name } params, RequestOptionsoptions?): RegoMetadata { id, created_at, data, 3 more }

PUT/accounts/{account_id}/cws/rego-metadata/{rego_metadata_id}

Delete a rego metadata document

client.zeroTrust.cws.regoMetadata.delete(stringregoMetadataID, RegoMetadataDeleteParams { account_id } params, RequestOptionsoptions?): RegoMetadataDeleteResponse { id }

DELETE/accounts/{account_id}/cws/rego-metadata/{rego_metadata_id}

ModelsExpand Collapse

RegoMetadata { id, created_at, data, 3 more }

id: string

Server-assigned UUID

formatuuid

created_at: string

formatdate-time

data: unknown

import_path: string

Unique Rego import path in the form metadata., with one alphanumeric or underscore segment. Reference it as data.<import_path>.

maxLength255

minLength1

name: string

Human-readable name; unique per account

maxLength100

minLength1

updated_at: string

formatdate-time

RegoMetadataDeleteResponse { id }

id: string

formatuuid

Cloud Workload SecurityRego Modules

List Rego modules

client.zeroTrust.cws.regoModules.list(RegoModuleListParams { account_id, cursor, direction, 4 more } params, RequestOptionsoptions?): CursorPagination<RegoModule { id, created_at, name, 3 more } >

GET/accounts/{account_id}/cws/rego-modules

Get a Rego module by ID

client.zeroTrust.cws.regoModules.get(stringregoModuleID, RegoModuleGetParams { account_id } params, RequestOptionsoptions?): RegoModule { id, created_at, name, 3 more }

GET/accounts/{account_id}/cws/rego-modules/{rego_module_id}

Create a new Rego module

client.zeroTrust.cws.regoModules.create(RegoModuleCreateParams { account_id, name, rego_source } params, RequestOptionsoptions?): RegoModule { id, created_at, name, 3 more }

POST/accounts/{account_id}/cws/rego-modules

Update a Rego module

client.zeroTrust.cws.regoModules.update(stringregoModuleID, RegoModuleUpdateParams { account_id, name, rego_source } params, RequestOptionsoptions?): RegoModule { id, created_at, name, 3 more }

PUT/accounts/{account_id}/cws/rego-modules/{rego_module_id}

Delete a Rego module

client.zeroTrust.cws.regoModules.delete(stringregoModuleID, RegoModuleDeleteParams { account_id } params, RequestOptionsoptions?): RegoModuleDeleteResponse { id }

DELETE/accounts/{account_id}/cws/rego-modules/{rego_module_id}

ModelsExpand Collapse

RegoModule { id, created_at, name, 3 more }

id: string

Server-assigned UUID

formatuuid

created_at: string

formatdate-time

name: string

Human-readable name; unique per account

maxLength100

minLength1

package_path: string

Dotted path derived from rego_source. Begins with lib. and is unique per account.

maxLength1024

rego_source: string

Library Rego source with a package beginning with “lib.” Maximum 16384 UTF-8 bytes.

maxLength16384

minLength1

updated_at: string

formatdate-time

RegoModuleDeleteResponse { id }

id: string

formatuuid

Cloud Workload SecurityTenant Structures

List tenant structures for an account

client.zeroTrust.cws.tenantStructures.list(TenantStructureListParams { account_id, cursor, direction, 4 more } params, RequestOptionsoptions?): CursorPagination<TenantStructure { id, application, created_at, 3 more } >

GET/accounts/{account_id}/cws/tenant-structures

Get a tenant structure by ID

client.zeroTrust.cws.tenantStructures.get(stringstructureID, TenantStructureGetParams { account_id } params, RequestOptionsoptions?): TenantStructure { id, application, created_at, 3 more }

GET/accounts/{account_id}/cws/tenant-structures/{structure_id}

Create a tenant structure

client.zeroTrust.cws.tenantStructures.create(TenantStructureCreateParams { account_id, application, name, import_path } params, RequestOptionsoptions?): TenantStructure { id, application, created_at, 3 more }

POST/accounts/{account_id}/cws/tenant-structures

Update a tenant structure

client.zeroTrust.cws.tenantStructures.update(stringstructureID, TenantStructureUpdateParams { account_id, application, name, import_path } params, RequestOptionsoptions?): TenantStructure { id, application, created_at, 3 more }

PUT/accounts/{account_id}/cws/tenant-structures/{structure_id}

Delete a tenant structure

client.zeroTrust.cws.tenantStructures.delete(stringstructureID, TenantStructureDeleteParams { account_id } params, RequestOptionsoptions?): TenantStructureDeleteResponse { id }

DELETE/accounts/{account_id}/cws/tenant-structures/{structure_id}

ModelsExpand Collapse

TenantStructure { id, application, created_at, 3 more }

id: string

Server-assigned UUID

formatuuid

application: "aws" | "cloudflare"

Platform this structure models. Immutable after creation; determines valid node kinds and identifier formats.

One of the following:

"aws"

"cloudflare"

created_at: string

formatdate-time

name: string

Human-readable name; unique per account

maxLength100

minLength1

updated_at: string

formatdate-time

import_path?: string

Optional unique Rego mount path in the form tenant... The application segment must match application; omitted when unmounted.

maxLength255

minLength1

TenantStructureDeleteResponse { id }

id: string

formatuuid

Cloud Workload SecurityTenant StructuresNodes

List nodes for a tenant structure

client.zeroTrust.cws.tenantStructures.nodes.list(stringstructureID, NodeListParams { account_id, cursor, direction, 6 more } params, RequestOptionsoptions?): CursorPagination<TenantStructureNode { id, created_at, native_id, 4 more } >

GET/accounts/{account_id}/cws/tenant-structures/{structure_id}/nodes

Get a tenant node by ID

client.zeroTrust.cws.tenantStructures.nodes.get(stringnodeID, NodeGetParams { account_id, structure_id } params, RequestOptionsoptions?): TenantStructureNode { id, created_at, native_id, 4 more }

GET/accounts/{account_id}/cws/tenant-structures/{structure_id}/nodes/{node_id}

Add a node to a tenant structure

client.zeroTrust.cws.tenantStructures.nodes.create(stringstructureID, NodeCreateParams { account_id, native_id, node_kind, 2 more } params, RequestOptionsoptions?): TenantStructureNode { id, created_at, native_id, 4 more }

POST/accounts/{account_id}/cws/tenant-structures/{structure_id}/nodes

Update a tenant node

client.zeroTrust.cws.tenantStructures.nodes.update(stringnodeID, NodeUpdateParams { account_id, structure_id, native_id, 3 more } params, RequestOptionsoptions?): TenantStructureNode { id, created_at, native_id, 4 more }

PUT/accounts/{account_id}/cws/tenant-structures/{structure_id}/nodes/{node_id}

Delete a tenant node

client.zeroTrust.cws.tenantStructures.nodes.delete(stringnodeID, NodeDeleteParams { account_id, structure_id } params, RequestOptionsoptions?): NodeDeleteResponse { id }

DELETE/accounts/{account_id}/cws/tenant-structures/{structure_id}/nodes/{node_id}

Apply a batch of tenant node mutations

client.zeroTrust.cws.tenantStructures.nodes.batch(stringstructureID, NodeBatchParams { account_id, creates, deletes, updates } params, RequestOptionsoptions?): NodeBatchResponse { created, deleted, updated }

POST/accounts/{account_id}/cws/tenant-structures/{structure_id}/nodes/batch

ModelsExpand Collapse

TenantStructureNode { id, created_at, native_id, 4 more }

id: string

Server-assigned UUID

formatuuid

created_at: string

formatdate-time

native_id: string

Cloud-native identifier of this node, unique within the structure; the parent-reference target. Shape depends on the structure’s application. Immutable after create.

maxLength255

minLength1

node_kind: string

Position in the tree. Legal values depend on the structure’s application (aws: root/ou/account; cloudflare: org/account/zone). At most one root per structure. Immutable after create.

maxLength64

minLength1

updated_at: string

formatdate-time

name?: string

Display name (e.g. an OU or account name), mutable. Optional; empty by default.

maxLength100

parent?: string

Native ID of this node’s parent. Required for non-root nodes and omitted for the root. The parent must be in the same structure and able to contain this node kind.

maxLength255

NodeDeleteResponse { id }

id: string

formatuuid

NodeBatchResponse { created, deleted, updated }

created: Array<TenantStructureNode { id, created_at, native_id, 4 more } >

id: string

Server-assigned UUID

formatuuid

created_at: string

formatdate-time

native_id: string

Cloud-native identifier of this node, unique within the structure; the parent-reference target. Shape depends on the structure’s application. Immutable after create.

maxLength255

minLength1

node_kind: string

Position in the tree. Legal values depend on the structure’s application (aws: root/ou/account; cloudflare: org/account/zone). At most one root per structure. Immutable after create.

maxLength64

minLength1

updated_at: string

formatdate-time

name?: string

Display name (e.g. an OU or account name), mutable. Optional; empty by default.

maxLength100

parent?: string

Native ID of this node’s parent. Required for non-root nodes and omitted for the root. The parent must be in the same structure and able to contain this node kind.

maxLength255

deleted: Array<Deleted>

id: string

formatuuid

updated: Array<TenantStructureNode { id, created_at, native_id, 4 more } >

id: string

Server-assigned UUID

formatuuid

created_at: string

formatdate-time

native_id: string

Cloud-native identifier of this node, unique within the structure; the parent-reference target. Shape depends on the structure’s application. Immutable after create.

maxLength255

minLength1

node_kind: string

Position in the tree. Legal values depend on the structure’s application (aws: root/ou/account; cloudflare: org/account/zone). At most one root per structure. Immutable after create.

maxLength64

minLength1

updated_at: string

formatdate-time

name?: string

Display name (e.g. an OU or account name), mutable. Optional; empty by default.

maxLength100

parent?: string

Native ID of this node’s parent. Required for non-root nodes and omitted for the root. The parent must be in the same structure and able to contain this node kind.

maxLength255

Cloud Workload SecurityWorkloads

List workloads

client.zeroTrust.cws.workloads.list(WorkloadListParams { account_id, cursor, direction, 4 more } params, RequestOptionsoptions?): CursorPagination<Workload { id, created_at, filter, 4 more } >

GET/accounts/{account_id}/cws/workloads

Get a workload by ID

client.zeroTrust.cws.workloads.get(stringworkloadID, WorkloadGetParams { account_id } params, RequestOptionsoptions?): Workload { id, created_at, filter, 4 more }

GET/accounts/{account_id}/cws/workloads/{workload_id}

Create a new workload

client.zeroTrust.cws.workloads.create(WorkloadCreateParams { account_id, filter, name, 2 more } params, RequestOptionsoptions?): Workload { id, created_at, filter, 4 more }

POST/accounts/{account_id}/cws/workloads

Update a workload

client.zeroTrust.cws.workloads.update(stringworkloadID, WorkloadUpdateParams { account_id, filter, name, 2 more } params, RequestOptionsoptions?): Workload { id, created_at, filter, 4 more }

PUT/accounts/{account_id}/cws/workloads/{workload_id}

Delete a workload

client.zeroTrust.cws.workloads.delete(stringworkloadID, WorkloadDeleteParams { account_id } params, RequestOptionsoptions?): WorkloadDeleteResponse { id }

DELETE/accounts/{account_id}/cws/workloads/{workload_id}

ModelsExpand Collapse

Workload { id, created_at, filter, 4 more }

id: string

Server-assigned UUID

formatuuid

created_at: string

formatdate-time

filter: string

Filter expression selecting the requests this workload matches. Maximum 4096 UTF-8 bytes.

maxLength4096

minLength1

name: string

Human-readable handle; unique per account.

maxLength100

minLength1

tags: Record<string, string>

Tags attached to this workload

updated_at: string

formatdate-time

description?: string

Optional free-form description.

maxLength1024

WorkloadDeleteResponse { id }

id: string

formatuuid