API Reference

Zero Trust

Devices

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Deployment Groups

List deployment groups

client.zeroTrust.devices.deploymentGroups.list(DeploymentGroupListParams { account_id, page, per_page } params, RequestOptionsoptions?): V4PagePaginationArray<DeploymentGroup { id, created_at, name, 3 more } >

GET/accounts/{account_id}/devices/deployment-groups

Get deployment group

client.zeroTrust.devices.deploymentGroups.get(stringgroupId, DeploymentGroupGetParams { account_id } params, RequestOptionsoptions?): DeploymentGroup { id, created_at, name, 3 more }

GET/accounts/{account_id}/devices/deployment-groups/{group_id}

Create deployment group

client.zeroTrust.devices.deploymentGroups.create(DeploymentGroupCreateParams { account_id, name, version_config, policy_ids } params, RequestOptionsoptions?): DeploymentGroup { id, created_at, name, 3 more }

POST/accounts/{account_id}/devices/deployment-groups

Update deployment group

client.zeroTrust.devices.deploymentGroups.edit(stringgroupId, DeploymentGroupEditParams { account_id, name, policy_ids, version_config } params, RequestOptionsoptions?): DeploymentGroup { id, created_at, name, 3 more }

PATCH/accounts/{account_id}/devices/deployment-groups/{group_id}

Delete deployment group

client.zeroTrust.devices.deploymentGroups.delete(stringgroupId, DeploymentGroupDeleteParams { account_id } params, RequestOptionsoptions?): DeploymentGroupDeleteResponse { id }

DELETE/accounts/{account_id}/devices/deployment-groups/{group_id}

ModelsExpand Collapse

DeploymentGroup { id, created_at, name, 3 more }

id: string

The ID of the deployment group.

created_at: string

The RFC3339Nano timestamp when the deployment group was created.

name: string

A user-friendly name for the deployment group.

maxLength255

minLength1

updated_at: string

The RFC3339Nano timestamp when the deployment group was last updated.

version_config: Array<VersionConfig>

Contains version configurations for different target environments.

target_environment: string | null

The target environment for the client version (e.g., windows, macos).

version: string

The specific client version to deploy.

policy_ids?: Array<string> | null

Contains a list of policy IDs assigned to this deployment group.

DeploymentGroupDeleteResponse { id }

id?: string

The ID of a deleted deployment group.