--- title: Cloud Workload Security --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Zero Trust](https://developers.cloudflare.com/api/typescript/resources/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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/basic_auth_credentials/methods/list) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/basic_auth_credentials/methods/get) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/basic_auth_credentials/methods/create) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/basic_auth_credentials/methods/delete) 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 Link to this property created\_at: string formatdate-time Link to this property updated\_at: string formatdate-time Link to this property 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 Link to this property

[Link to this property](<#(resource)%20zero_trust.cws.basic_auth_credentials%20%3E%20(model)%20basic_auth_credential%20%3E%20(schema)>)

BasicAuthCredentialDeleteResponse {id }

id: string formatuuid Link to this property

[Link to this property](<#(resource)%20zero_trust.cws.basic_auth_credentials%20%3E%20(model)%20basic_auth_credential_delete_response%20%3E%20(schema)>) #### Cloud Workload SecurityBasic Auth CredentialsSecrets ##### [List secrets for a basic-auth credential](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/basic_auth_credentials/subresources/secrets/methods/list) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/basic_auth_credentials/subresources/secrets/methods/get) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/basic_auth_credentials/subresources/secrets/methods/create) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/basic_auth_credentials/subresources/secrets/methods/delete) 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 Link to this property created\_at: string formatdate-time Link to this property expires\_at?: string Optional RFC 3339 expiration time. Omit for no expiration. formatdate-time Link to this property

[Link to this property](<#(resource)%20zero_trust.cws.basic_auth_credentials.secrets%20%3E%20(model)%20basic_auth_secret%20%3E%20(schema)>)

SecretDeleteResponse {id }

id: string formatuuid Link to this property

[Link to this property](<#(resource)%20zero_trust.cws.basic_auth_credentials.secrets%20%3E%20(model)%20secret_delete_response%20%3E%20(schema)>) #### Cloud Workload SecurityDeployments ##### [List deployments](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/deployments/methods/list) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/deployments/methods/get) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/deployments/methods/create) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/deployments/methods/update) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/deployments/methods/delete) 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 Link to this property basic\_auth\_credential\_ids: Array<string>| null IDs of basic-auth credentials attached to this deployment Link to this property created\_at: string formatdate-time Link to this property

default\_mode: "ALLOW"| "BLOCK" Default traffic decision when no policy set matches

One of the following: "ALLOW" Link to this property "BLOCK" Link to this property

Link to this property name: string Human-readable name; unique per account maxLength100 minLength1 Link to this property

on\_error\_action: "BLOCK"| "SKIP" Action applied when an enforcing policy has a runtime Rego error

One of the following: "BLOCK" Link to this property "SKIP" Link to this property

Link to this property policy\_set\_ids: Array<string>| null IDs of policy sets attached to this deployment Link to this property rego\_raise\_error: boolean Whether OPA builtin failures are raised as runtime evaluation errors Link to this property tags: Record<string, string> Tags attached to this deployment Link to this property updated\_at: string formatdate-time Link to this property description?: string Optional free-form description. maxLength1024 Link to this property domain\_acl\_id?: string ID of the attached domain ACL. Omitted when none. formatuuid Link to this property

[Link to this property](<#(resource)%20zero_trust.cws.deployments%20%3E%20(model)%20deployment%20%3E%20(schema)>)

DeploymentDeleteResponse {id }

id: string formatuuid Link to this property

[Link to this property](<#(resource)%20zero_trust.cws.deployments%20%3E%20(model)%20deployment_delete_response%20%3E%20(schema)>) #### Cloud Workload SecurityDomain ACLs ##### [List domain ACLs](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/domain_acls/methods/list) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/domain_acls/methods/get) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/domain_acls/methods/create) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/domain_acls/methods/update) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/domain_acls/methods/delete) 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 Link to this property created\_at: string formatdate-time Link to this property

default\_action: "ALLOW"| "BLOCK" Action applied when no entry matches the request domain

One of the following: "ALLOW" Link to this property "BLOCK" Link to this property

Link to this property

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" Link to this property "BLOCK" Link to this property

Link to this property domain: string Hostname or domain pattern, capped at 255 UTF-8 bytes maxLength255 minLength1 Link to this property

Link to this property name: string Human-readable name; unique per account maxLength100 minLength1 Link to this property updated\_at: string formatdate-time Link to this property

[Link to this property](<#(resource)%20zero_trust.cws.domain_acls%20%3E%20(model)%20domain_acl%20%3E%20(schema)>)

DomainACLDeleteResponse {id }

id: string formatuuid Link to this property

[Link to this property](<#(resource)%20zero_trust.cws.domain_acls%20%3E%20(model)%20domain_acl_delete_response%20%3E%20(schema)>) #### Cloud Workload SecurityPolicies ##### [List policies](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/policies/methods/list) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/policies/methods/get) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/policies/methods/create) client.zeroTrust.cws.policies.create(PolicyCreateParams {account\_id, entrypoint, filter, 4 more } params, RequestOptionsoptions?): [Policy]() {id, created\_at, entrypoint, 7 more } POST/accounts/{account\_id}/cws/policies ##### [Update a policy](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/policies/methods/update) client.zeroTrust.cws.policies.update(stringpolicyID, PolicyUpdateParams {account\_id, entrypoint, filter, 4 more } params, RequestOptionsoptions?): [Policy]() {id, created\_at, entrypoint, 7 more } PUT/accounts/{account\_id}/cws/policies/{policy\_id} ##### [Delete a policy](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/policies/methods/delete) 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 Link to this property created\_at: string formatdate-time Link to this property entrypoint: string Non-function rule declared in rego\_source. Evaluation uses data.<package\_path>.. maxLength255 Link to this property filter: string Filter expression that determines whether this policy applies. Maximum 4096 UTF-8 bytes. maxLength4096 minLength1 Link to this property name: string Human-readable name; unique per account maxLength100 minLength1 Link to this property package\_path: string Dotted path derived from rego\_source. Begins with policy. and is unique per account. maxLength1024 Link to this property rego\_source: string Inline Rego source with a package beginning with “policy.” Maximum 16384 UTF-8 bytes. maxLength16384 minLength1 Link to this property tags: Record<string, string> Tags attached to this policy Link to this property updated\_at: string formatdate-time Link to this property description?: string Optional free-form description. maxLength1024 Link to this property

[Link to this property](<#(resource)%20zero_trust.cws.policies%20%3E%20(model)%20policy%20%3E%20(schema)>)

PolicyDeleteResponse {id }

id: string formatuuid Link to this property

[Link to this property](<#(resource)%20zero_trust.cws.policies%20%3E%20(model)%20policy_delete_response%20%3E%20(schema)>) #### Cloud Workload SecurityPolicy Sets ##### [List policy sets](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/policy_sets/methods/list) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/policy_sets/methods/get) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/policy_sets/methods/create) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/policy_sets/methods/update) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/policy_sets/methods/delete) 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 Link to this property created\_at: string formatdate-time Link to this property exclude\_workload\_ids: Array<string>| null IDs of workloads that exclude matching requests. Exclusions take precedence. Link to this property include\_workload\_ids: Array<string>| null IDs of workloads that include matching requests. Empty includes all requests before exclusions. Link to this property name: string Human-readable name; unique per account maxLength100 minLength1 Link to this property

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. Link to this property policy\_id: string ID of the member policy formatuuid Link to this property

Link to this property tags: Record<string, string> Tags attached to this policy set Link to this property updated\_at: string formatdate-time Link to this property description?: string Optional free-form description. maxLength1024 Link to this property

[Link to this property](<#(resource)%20zero_trust.cws.policy_sets%20%3E%20(model)%20policy_set%20%3E%20(schema)>)

PolicySetDeleteResponse {id }

id: string formatuuid Link to this property

[Link to this property](<#(resource)%20zero_trust.cws.policy_sets%20%3E%20(model)%20policy_set_delete_response%20%3E%20(schema)>) #### Cloud Workload SecurityRego Metadata ##### [List Rego metadata documents](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/rego_metadata/methods/list) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/rego_metadata/methods/get) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/rego_metadata/methods/create) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/rego_metadata/methods/update) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/rego_metadata/methods/delete) 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 Link to this property created\_at: string formatdate-time Link to this property data: unknown Link to this property 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 Link to this property name: string Human-readable name; unique per account maxLength100 minLength1 Link to this property updated\_at: string formatdate-time Link to this property

[Link to this property](<#(resource)%20zero_trust.cws.rego_metadata%20%3E%20(model)%20rego_metadata%20%3E%20(schema)>)

RegoMetadataDeleteResponse {id }

id: string formatuuid Link to this property

[Link to this property](<#(resource)%20zero_trust.cws.rego_metadata%20%3E%20(model)%20rego_metadata_delete_response%20%3E%20(schema)>) #### Cloud Workload SecurityRego Modules ##### [List Rego modules](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/rego_modules/methods/list) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/rego_modules/methods/get) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/rego_modules/methods/create) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/rego_modules/methods/update) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/rego_modules/methods/delete) 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 Link to this property created\_at: string formatdate-time Link to this property name: string Human-readable name; unique per account maxLength100 minLength1 Link to this property package\_path: string Dotted path derived from rego\_source. Begins with lib. and is unique per account. maxLength1024 Link to this property rego\_source: string Library Rego source with a package beginning with “lib.” Maximum 16384 UTF-8 bytes. maxLength16384 minLength1 Link to this property updated\_at: string formatdate-time Link to this property

[Link to this property](<#(resource)%20zero_trust.cws.rego_modules%20%3E%20(model)%20rego_module%20%3E%20(schema)>)

RegoModuleDeleteResponse {id }

id: string formatuuid Link to this property

[Link to this property](<#(resource)%20zero_trust.cws.rego_modules%20%3E%20(model)%20rego_module_delete_response%20%3E%20(schema)>) #### Cloud Workload SecurityTenant Structures ##### [List tenant structures for an account](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/tenant_structures/methods/list) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/tenant_structures/methods/get) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/tenant_structures/methods/create) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/tenant_structures/methods/update) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/tenant_structures/methods/delete) 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 Link to this property

application: "aws"| "cloudflare" Platform this structure models. Immutable after creation; determines valid node kinds and identifier formats.

One of the following: "aws" Link to this property "cloudflare" Link to this property

Link to this property created\_at: string formatdate-time Link to this property name: string Human-readable name; unique per account maxLength100 minLength1 Link to this property updated\_at: string formatdate-time Link to this property import\_path?: string Optional unique Rego mount path in the form tenant... The application segment must match application; omitted when unmounted. maxLength255 minLength1 Link to this property

[Link to this property](<#(resource)%20zero_trust.cws.tenant_structures%20%3E%20(model)%20tenant_structure%20%3E%20(schema)>)

TenantStructureDeleteResponse {id }

id: string formatuuid Link to this property

[Link to this property](<#(resource)%20zero_trust.cws.tenant_structures%20%3E%20(model)%20tenant_structure_delete_response%20%3E%20(schema)>) #### Cloud Workload SecurityTenant StructuresNodes ##### [List nodes for a tenant structure](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/tenant_structures/subresources/nodes/methods/list) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/tenant_structures/subresources/nodes/methods/get) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/tenant_structures/subresources/nodes/methods/create) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/tenant_structures/subresources/nodes/methods/update) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/tenant_structures/subresources/nodes/methods/delete) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/tenant_structures/subresources/nodes/methods/batch) 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 Link to this property created\_at: string formatdate-time Link to this property 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 Link to this property 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 Link to this property updated\_at: string formatdate-time Link to this property name?: string Display name (e.g. an OU or account name), mutable. Optional; empty by default. maxLength100 Link to this property 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 Link to this property

[Link to this property](<#(resource)%20zero_trust.cws.tenant_structures.nodes%20%3E%20(model)%20tenant_structure_node%20%3E%20(schema)>)

NodeDeleteResponse {id }

id: string formatuuid Link to this property

[Link to this property](<#(resource)%20zero_trust.cws.tenant_structures.nodes%20%3E%20(model)%20node_delete_response%20%3E%20(schema)>)

NodeBatchResponse {created, deleted, updated }

created: Array<TenantStructureNode {id, created\_at, native\_id, 4 more } >

Link to this property

deleted: Array<Deleted>

id: string formatuuid Link to this property

Link to this property

updated: Array<TenantStructureNode {id, created\_at, native\_id, 4 more } >

Link to this property

[Link to this property](<#(resource)%20zero_trust.cws.tenant_structures.nodes%20%3E%20(model)%20node_batch_response%20%3E%20(schema)>) #### Cloud Workload SecurityWorkloads ##### [List workloads](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/workloads/methods/list) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/workloads/methods/get) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/workloads/methods/create) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/workloads/methods/update) 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](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/cws/subresources/workloads/methods/delete) 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 Link to this property created\_at: string formatdate-time Link to this property filter: string Filter expression selecting the requests this workload matches. Maximum 4096 UTF-8 bytes. maxLength4096 minLength1 Link to this property name: string Human-readable handle; unique per account. maxLength100 minLength1 Link to this property tags: Record<string, string> Tags attached to this workload Link to this property updated\_at: string formatdate-time Link to this property description?: string Optional free-form description. maxLength1024 Link to this property

[Link to this property](<#(resource)%20zero_trust.cws.workloads%20%3E%20(model)%20workload%20%3E%20(schema)>)

WorkloadDeleteResponse {id }

id: string formatuuid Link to this property

[Link to this property](<#(resource)%20zero_trust.cws.workloads%20%3E%20(model)%20workload_delete_response%20%3E%20(schema)>)