--- title: Cloud Workload Security --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Zero Trust](https://developers.cloudflare.com/api/python/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/python/resources/zero_trust/subresources/cws/subresources/basic_auth_credentials/methods/list) zero\_trust.cws.basic\_auth\_credentials.list(BasicAuthCredentialListParams\*\*kwargs) -> SyncCursorPagination\[[BasicAuthCredential]()] GET/accounts/{account\_id}/cws/basic-auth-credentials ##### [Get a basic-auth credential by ID](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/basic_auth_credentials/methods/get) zero\_trust.cws.basic\_auth\_credentials.get(strcredential\_id, BasicAuthCredentialGetParams\*\*kwargs) -> [BasicAuthCredential]() GET/accounts/{account\_id}/cws/basic-auth-credentials/{credential\_id} ##### [Create a basic-auth credential](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/basic_auth_credentials/methods/create) zero\_trust.cws.basic\_auth\_credentials.create(BasicAuthCredentialCreateParams\*\*kwargs) -> [BasicAuthCredential]() POST/accounts/{account\_id}/cws/basic-auth-credentials ##### [Delete a basic-auth credential](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/basic_auth_credentials/methods/delete) zero\_trust.cws.basic\_auth\_credentials.delete(strcredential\_id, BasicAuthCredentialDeleteParams\*\*kwargs) -> [BasicAuthCredentialDeleteResponse]() DELETE/accounts/{account\_id}/cws/basic-auth-credentials/{credential\_id} ##### ModelsExpand Collapse
class BasicAuthCredential: … id: str Server-assigned UUID formatuuid Link to this property created\_at: datetime formatdate-time Link to this property updated\_at: datetime formatdate-time Link to this property username: str 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)>)
class BasicAuthCredentialDeleteResponse: … id: str 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/python/resources/zero_trust/subresources/cws/subresources/basic_auth_credentials/subresources/secrets/methods/list) zero\_trust.cws.basic\_auth\_credentials.secrets.list(strcredential\_id, SecretListParams\*\*kwargs) -> SyncCursorPagination\[[BasicAuthSecret]()] GET/accounts/{account\_id}/cws/basic-auth-credentials/{credential\_id}/secrets ##### [Get a basic-auth secret by ID](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/basic_auth_credentials/subresources/secrets/methods/get) zero\_trust.cws.basic\_auth\_credentials.secrets.get(strsecret\_id, SecretGetParams\*\*kwargs) -> [BasicAuthSecret]() 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/python/resources/zero_trust/subresources/cws/subresources/basic_auth_credentials/subresources/secrets/methods/create) zero\_trust.cws.basic\_auth\_credentials.secrets.create(strcredential\_id, SecretCreateParams\*\*kwargs) -> [BasicAuthSecret]() POST/accounts/{account\_id}/cws/basic-auth-credentials/{credential\_id}/secrets ##### [Delete a basic-auth secret](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/basic_auth_credentials/subresources/secrets/methods/delete) zero\_trust.cws.basic\_auth\_credentials.secrets.delete(strsecret\_id, SecretDeleteParams\*\*kwargs) -> [SecretDeleteResponse]() DELETE/accounts/{account\_id}/cws/basic-auth-credentials/{credential\_id}/secrets/{secret\_id} ##### ModelsExpand Collapse
class BasicAuthSecret: … id: str Server-assigned UUID formatuuid Link to this property created\_at: datetime formatdate-time Link to this property expires\_at: Optional\[datetime] 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)>)
class SecretDeleteResponse: … id: str 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/python/resources/zero_trust/subresources/cws/subresources/deployments/methods/list) zero\_trust.cws.deployments.list(DeploymentListParams\*\*kwargs) -> SyncCursorPagination\[[Deployment]()] GET/accounts/{account\_id}/cws/deployments ##### [Get a deployment by ID](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/deployments/methods/get) zero\_trust.cws.deployments.get(strdeployment\_id, DeploymentGetParams\*\*kwargs) -> [Deployment]() GET/accounts/{account\_id}/cws/deployments/{deployment\_id} ##### [Create a new deployment](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/deployments/methods/create) zero\_trust.cws.deployments.create(DeploymentCreateParams\*\*kwargs) -> [Deployment]() POST/accounts/{account\_id}/cws/deployments ##### [Update a deployment](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/deployments/methods/update) zero\_trust.cws.deployments.update(strdeployment\_id, DeploymentUpdateParams\*\*kwargs) -> [Deployment]() PUT/accounts/{account\_id}/cws/deployments/{deployment\_id} ##### [Delete a deployment](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/deployments/methods/delete) zero\_trust.cws.deployments.delete(strdeployment\_id, DeploymentDeleteParams\*\*kwargs) -> [DeploymentDeleteResponse]() DELETE/accounts/{account\_id}/cws/deployments/{deployment\_id} ##### ModelsExpand Collapse
class Deployment: … id: str Server-assigned UUID formatuuid Link to this property basic\_auth\_credential\_ids: Optional\[List\[str]] IDs of basic-auth credentials attached to this deployment Link to this property created\_at: datetime formatdate-time Link to this property
default\_mode: Literal\["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: str Human-readable name; unique per account maxLength100 minLength1 Link to this property
on\_error\_action: Literal\["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: Optional\[List\[str]] IDs of policy sets attached to this deployment Link to this property rego\_raise\_error: bool Whether OPA builtin failures are raised as runtime evaluation errors Link to this property tags: Dict\[str, str] Tags attached to this deployment Link to this property updated\_at: datetime formatdate-time Link to this property description: Optional\[str] Optional free-form description. maxLength1024 Link to this property domain\_acl\_id: Optional\[str] 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)>)
class DeploymentDeleteResponse: … id: str 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/python/resources/zero_trust/subresources/cws/subresources/domain_acls/methods/list) zero\_trust.cws.domain\_acls.list(DomainACLListParams\*\*kwargs) -> SyncCursorPagination\[[DomainACL]()] GET/accounts/{account\_id}/cws/domain-acls ##### [Get a domain ACL by ID](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/domain_acls/methods/get) zero\_trust.cws.domain\_acls.get(strdomain\_acl\_id, DomainACLGetParams\*\*kwargs) -> [DomainACL]() GET/accounts/{account\_id}/cws/domain-acls/{domain\_acl\_id} ##### [Create a new domain ACL](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/domain_acls/methods/create) zero\_trust.cws.domain\_acls.create(DomainACLCreateParams\*\*kwargs) -> [DomainACL]() POST/accounts/{account\_id}/cws/domain-acls ##### [Update a domain ACL and replace its entries](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/domain_acls/methods/update) zero\_trust.cws.domain\_acls.update(strdomain\_acl\_id, DomainACLUpdateParams\*\*kwargs) -> [DomainACL]() PUT/accounts/{account\_id}/cws/domain-acls/{domain\_acl\_id} ##### [Delete a domain ACL](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/domain_acls/methods/delete) zero\_trust.cws.domain\_acls.delete(strdomain\_acl\_id, DomainACLDeleteParams\*\*kwargs) -> [DomainACLDeleteResponse]() DELETE/accounts/{account\_id}/cws/domain-acls/{domain\_acl\_id} ##### ModelsExpand Collapse
class DomainACL: … id: str Server-assigned UUID formatuuid Link to this property created\_at: datetime formatdate-time Link to this property
default\_action: Literal\["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: Optional\[List\[Entry]] Per-domain action overrides. Each domain appears at most once.
action: Literal\["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: str Hostname or domain pattern, capped at 255 UTF-8 bytes maxLength255 minLength1 Link to this property
Link to this property name: str Human-readable name; unique per account maxLength100 minLength1 Link to this property updated\_at: datetime 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)>)
class DomainACLDeleteResponse: … id: str 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/python/resources/zero_trust/subresources/cws/subresources/policies/methods/list) zero\_trust.cws.policies.list(PolicyListParams\*\*kwargs) -> SyncCursorPagination\[[Policy]()] GET/accounts/{account\_id}/cws/policies ##### [Get a policy by ID](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/policies/methods/get) zero\_trust.cws.policies.get(strpolicy\_id, PolicyGetParams\*\*kwargs) -> [Policy]() GET/accounts/{account\_id}/cws/policies/{policy\_id} ##### [Create a new policy](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/policies/methods/create) zero\_trust.cws.policies.create(PolicyCreateParams\*\*kwargs) -> [Policy]() POST/accounts/{account\_id}/cws/policies ##### [Update a policy](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/policies/methods/update) zero\_trust.cws.policies.update(strpolicy\_id, PolicyUpdateParams\*\*kwargs) -> [Policy]() PUT/accounts/{account\_id}/cws/policies/{policy\_id} ##### [Delete a policy](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/policies/methods/delete) zero\_trust.cws.policies.delete(strpolicy\_id, PolicyDeleteParams\*\*kwargs) -> [PolicyDeleteResponse]() DELETE/accounts/{account\_id}/cws/policies/{policy\_id} ##### ModelsExpand Collapse
class Policy: … id: str Server-assigned UUID formatuuid Link to this property created\_at: datetime formatdate-time Link to this property entrypoint: str Non-function rule declared in rego\_source. Evaluation uses data.<package\_path>.. maxLength255 Link to this property filter: str Filter expression that determines whether this policy applies. Maximum 4096 UTF-8 bytes. maxLength4096 minLength1 Link to this property name: str Human-readable name; unique per account maxLength100 minLength1 Link to this property package\_path: str Dotted path derived from rego\_source. Begins with policy. and is unique per account. maxLength1024 Link to this property rego\_source: str Inline Rego source with a package beginning with “policy.” Maximum 16384 UTF-8 bytes. maxLength16384 minLength1 Link to this property tags: Dict\[str, str] Tags attached to this policy Link to this property updated\_at: datetime formatdate-time Link to this property description: Optional\[str] 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)>)
class PolicyDeleteResponse: … id: str 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/python/resources/zero_trust/subresources/cws/subresources/policy_sets/methods/list) zero\_trust.cws.policy\_sets.list(PolicySetListParams\*\*kwargs) -> SyncCursorPagination\[[PolicySet]()] GET/accounts/{account\_id}/cws/policy-sets ##### [Get a policy set by ID](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/policy_sets/methods/get) zero\_trust.cws.policy\_sets.get(strpolicy\_set\_id, PolicySetGetParams\*\*kwargs) -> [PolicySet]() GET/accounts/{account\_id}/cws/policy-sets/{policy\_set\_id} ##### [Create a new policy set](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/policy_sets/methods/create) zero\_trust.cws.policy\_sets.create(PolicySetCreateParams\*\*kwargs) -> [PolicySet]() POST/accounts/{account\_id}/cws/policy-sets ##### [Update a policy set](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/policy_sets/methods/update) zero\_trust.cws.policy\_sets.update(strpolicy\_set\_id, PolicySetUpdateParams\*\*kwargs) -> [PolicySet]() PUT/accounts/{account\_id}/cws/policy-sets/{policy\_set\_id} ##### [Delete a policy set](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/policy_sets/methods/delete) zero\_trust.cws.policy\_sets.delete(strpolicy\_set\_id, PolicySetDeleteParams\*\*kwargs) -> [PolicySetDeleteResponse]() DELETE/accounts/{account\_id}/cws/policy-sets/{policy\_set\_id} ##### ModelsExpand Collapse
class PolicySet: … id: str Server-assigned UUID formatuuid Link to this property created\_at: datetime formatdate-time Link to this property exclude\_workload\_ids: Optional\[List\[str]] IDs of workloads that exclude matching requests. Exclusions take precedence. Link to this property include\_workload\_ids: Optional\[List\[str]] IDs of workloads that include matching requests. Empty includes all requests before exclusions. Link to this property name: str Human-readable name; unique per account maxLength100 minLength1 Link to this property
policies: Optional\[List\[Policy]] Member policies and their per-membership enforcement mode enforce: bool Whether this policy should enforce when it matches. False keeps the policy attached for non-enforcing evaluation. Link to this property policy\_id: str ID of the member policy formatuuid Link to this property
Link to this property tags: Dict\[str, str] Tags attached to this policy set Link to this property updated\_at: datetime formatdate-time Link to this property description: Optional\[str] 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)>)
class PolicySetDeleteResponse: … id: str 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/python/resources/zero_trust/subresources/cws/subresources/rego_metadata/methods/list) zero\_trust.cws.rego\_metadata.list(RegoMetadataListParams\*\*kwargs) -> SyncCursorPagination\[[RegoMetadata]()] GET/accounts/{account\_id}/cws/rego-metadata ##### [Get a rego metadata document by ID](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/rego_metadata/methods/get) zero\_trust.cws.rego\_metadata.get(strrego\_metadata\_id, RegoMetadataGetParams\*\*kwargs) -> [RegoMetadata]() GET/accounts/{account\_id}/cws/rego-metadata/{rego\_metadata\_id} ##### [Create a new rego metadata document](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/rego_metadata/methods/create) zero\_trust.cws.rego\_metadata.create(RegoMetadataCreateParams\*\*kwargs) -> [RegoMetadata]() POST/accounts/{account\_id}/cws/rego-metadata ##### [Update a rego metadata document](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/rego_metadata/methods/update) zero\_trust.cws.rego\_metadata.update(strrego\_metadata\_id, RegoMetadataUpdateParams\*\*kwargs) -> [RegoMetadata]() PUT/accounts/{account\_id}/cws/rego-metadata/{rego\_metadata\_id} ##### [Delete a rego metadata document](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/rego_metadata/methods/delete) zero\_trust.cws.rego\_metadata.delete(strrego\_metadata\_id, RegoMetadataDeleteParams\*\*kwargs) -> [RegoMetadataDeleteResponse]() DELETE/accounts/{account\_id}/cws/rego-metadata/{rego\_metadata\_id} ##### ModelsExpand Collapse
class RegoMetadata: … id: str Server-assigned UUID formatuuid Link to this property created\_at: datetime formatdate-time Link to this property data: object Link to this property import\_path: str 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: str Human-readable name; unique per account maxLength100 minLength1 Link to this property updated\_at: datetime 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)>)
class RegoMetadataDeleteResponse: … id: str 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/python/resources/zero_trust/subresources/cws/subresources/rego_modules/methods/list) zero\_trust.cws.rego\_modules.list(RegoModuleListParams\*\*kwargs) -> SyncCursorPagination\[[RegoModule]()] GET/accounts/{account\_id}/cws/rego-modules ##### [Get a Rego module by ID](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/rego_modules/methods/get) zero\_trust.cws.rego\_modules.get(strrego\_module\_id, RegoModuleGetParams\*\*kwargs) -> [RegoModule]() GET/accounts/{account\_id}/cws/rego-modules/{rego\_module\_id} ##### [Create a new Rego module](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/rego_modules/methods/create) zero\_trust.cws.rego\_modules.create(RegoModuleCreateParams\*\*kwargs) -> [RegoModule]() POST/accounts/{account\_id}/cws/rego-modules ##### [Update a Rego module](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/rego_modules/methods/update) zero\_trust.cws.rego\_modules.update(strrego\_module\_id, RegoModuleUpdateParams\*\*kwargs) -> [RegoModule]() PUT/accounts/{account\_id}/cws/rego-modules/{rego\_module\_id} ##### [Delete a Rego module](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/rego_modules/methods/delete) zero\_trust.cws.rego\_modules.delete(strrego\_module\_id, RegoModuleDeleteParams\*\*kwargs) -> [RegoModuleDeleteResponse]() DELETE/accounts/{account\_id}/cws/rego-modules/{rego\_module\_id} ##### ModelsExpand Collapse
class RegoModule: … id: str Server-assigned UUID formatuuid Link to this property created\_at: datetime formatdate-time Link to this property name: str Human-readable name; unique per account maxLength100 minLength1 Link to this property package\_path: str Dotted path derived from rego\_source. Begins with lib. and is unique per account. maxLength1024 Link to this property rego\_source: str Library Rego source with a package beginning with “lib.” Maximum 16384 UTF-8 bytes. maxLength16384 minLength1 Link to this property updated\_at: datetime 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)>)
class RegoModuleDeleteResponse: … id: str 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/python/resources/zero_trust/subresources/cws/subresources/tenant_structures/methods/list) zero\_trust.cws.tenant\_structures.list(TenantStructureListParams\*\*kwargs) -> SyncCursorPagination\[[TenantStructure]()] GET/accounts/{account\_id}/cws/tenant-structures ##### [Get a tenant structure by ID](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/tenant_structures/methods/get) zero\_trust.cws.tenant\_structures.get(strstructure\_id, TenantStructureGetParams\*\*kwargs) -> [TenantStructure]() GET/accounts/{account\_id}/cws/tenant-structures/{structure\_id} ##### [Create a tenant structure](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/tenant_structures/methods/create) zero\_trust.cws.tenant\_structures.create(TenantStructureCreateParams\*\*kwargs) -> [TenantStructure]() POST/accounts/{account\_id}/cws/tenant-structures ##### [Update a tenant structure](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/tenant_structures/methods/update) zero\_trust.cws.tenant\_structures.update(strstructure\_id, TenantStructureUpdateParams\*\*kwargs) -> [TenantStructure]() PUT/accounts/{account\_id}/cws/tenant-structures/{structure\_id} ##### [Delete a tenant structure](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/tenant_structures/methods/delete) zero\_trust.cws.tenant\_structures.delete(strstructure\_id, TenantStructureDeleteParams\*\*kwargs) -> [TenantStructureDeleteResponse]() DELETE/accounts/{account\_id}/cws/tenant-structures/{structure\_id} ##### ModelsExpand Collapse
class TenantStructure: … id: str Server-assigned UUID formatuuid Link to this property
application: Literal\["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: datetime formatdate-time Link to this property name: str Human-readable name; unique per account maxLength100 minLength1 Link to this property updated\_at: datetime formatdate-time Link to this property import\_path: Optional\[str] 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)>)
class TenantStructureDeleteResponse: … id: str 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/python/resources/zero_trust/subresources/cws/subresources/tenant_structures/subresources/nodes/methods/list) zero\_trust.cws.tenant\_structures.nodes.list(strstructure\_id, NodeListParams\*\*kwargs) -> SyncCursorPagination\[[TenantStructureNode]()] GET/accounts/{account\_id}/cws/tenant-structures/{structure\_id}/nodes ##### [Get a tenant node by ID](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/tenant_structures/subresources/nodes/methods/get) zero\_trust.cws.tenant\_structures.nodes.get(strnode\_id, NodeGetParams\*\*kwargs) -> [TenantStructureNode]() GET/accounts/{account\_id}/cws/tenant-structures/{structure\_id}/nodes/{node\_id} ##### [Add a node to a tenant structure](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/tenant_structures/subresources/nodes/methods/create) zero\_trust.cws.tenant\_structures.nodes.create(strstructure\_id, NodeCreateParams\*\*kwargs) -> [TenantStructureNode]() POST/accounts/{account\_id}/cws/tenant-structures/{structure\_id}/nodes ##### [Update a tenant node](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/tenant_structures/subresources/nodes/methods/update) zero\_trust.cws.tenant\_structures.nodes.update(strnode\_id, NodeUpdateParams\*\*kwargs) -> [TenantStructureNode]() PUT/accounts/{account\_id}/cws/tenant-structures/{structure\_id}/nodes/{node\_id} ##### [Delete a tenant node](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/tenant_structures/subresources/nodes/methods/delete) zero\_trust.cws.tenant\_structures.nodes.delete(strnode\_id, NodeDeleteParams\*\*kwargs) -> [NodeDeleteResponse]() DELETE/accounts/{account\_id}/cws/tenant-structures/{structure\_id}/nodes/{node\_id} ##### [Apply a batch of tenant node mutations](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/tenant_structures/subresources/nodes/methods/batch) zero\_trust.cws.tenant\_structures.nodes.batch(strstructure\_id, NodeBatchParams\*\*kwargs) -> [NodeBatchResponse]() POST/accounts/{account\_id}/cws/tenant-structures/{structure\_id}/nodes/batch ##### ModelsExpand Collapse
class TenantStructureNode: … id: str Server-assigned UUID formatuuid Link to this property created\_at: datetime formatdate-time Link to this property native\_id: str 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: str 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: datetime formatdate-time Link to this property name: Optional\[str] Display name (e.g. an OU or account name), mutable. Optional; empty by default. maxLength100 Link to this property parent: Optional\[str] 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)>)
class NodeDeleteResponse: … id: str 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)>)
class NodeBatchResponse: …
created: List\[TenantStructureNode] id: str Server-assigned UUID formatuuid Link to this property created\_at: datetime formatdate-time Link to this property native\_id: str 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: str 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: datetime formatdate-time Link to this property name: Optional\[str] Display name (e.g. an OU or account name), mutable. Optional; empty by default. maxLength100 Link to this property parent: Optional\[str] 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
deleted: List\[Deleted] id: str formatuuid Link to this property
Link to this property
updated: List\[TenantStructureNode] id: str Server-assigned UUID formatuuid Link to this property created\_at: datetime formatdate-time Link to this property native\_id: str 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: str 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: datetime formatdate-time Link to this property name: Optional\[str] Display name (e.g. an OU or account name), mutable. Optional; empty by default. maxLength100 Link to this property parent: Optional\[str] 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
[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/python/resources/zero_trust/subresources/cws/subresources/workloads/methods/list) zero\_trust.cws.workloads.list(WorkloadListParams\*\*kwargs) -> SyncCursorPagination\[[Workload]()] GET/accounts/{account\_id}/cws/workloads ##### [Get a workload by ID](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/workloads/methods/get) zero\_trust.cws.workloads.get(strworkload\_id, WorkloadGetParams\*\*kwargs) -> [Workload]() GET/accounts/{account\_id}/cws/workloads/{workload\_id} ##### [Create a new workload](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/workloads/methods/create) zero\_trust.cws.workloads.create(WorkloadCreateParams\*\*kwargs) -> [Workload]() POST/accounts/{account\_id}/cws/workloads ##### [Update a workload](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/workloads/methods/update) zero\_trust.cws.workloads.update(strworkload\_id, WorkloadUpdateParams\*\*kwargs) -> [Workload]() PUT/accounts/{account\_id}/cws/workloads/{workload\_id} ##### [Delete a workload](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/cws/subresources/workloads/methods/delete) zero\_trust.cws.workloads.delete(strworkload\_id, WorkloadDeleteParams\*\*kwargs) -> [WorkloadDeleteResponse]() DELETE/accounts/{account\_id}/cws/workloads/{workload\_id} ##### ModelsExpand Collapse
class Workload: … id: str Server-assigned UUID formatuuid Link to this property created\_at: datetime formatdate-time Link to this property filter: str Filter expression selecting the requests this workload matches. Maximum 4096 UTF-8 bytes. maxLength4096 minLength1 Link to this property name: str Human-readable handle; unique per account. maxLength100 minLength1 Link to this property tags: Dict\[str, str] Tags attached to this workload Link to this property updated\_at: datetime formatdate-time Link to this property description: Optional\[str] 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)>)
class WorkloadDeleteResponse: … id: str 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)>)