---
title: Deployment Groups
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/typescript)

[Zero Trust](https://developers.cloudflare.com/api/typescript/resources/zero_trust)

[Devices](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/devices)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Deployment Groups

##### [List deployment groups](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/devices/subresources/deployment_groups/methods/list)

client.zeroTrust.devices.deploymentGroups.list(DeploymentGroupListParams {account\_id, page, per\_page } params, RequestOptionsoptions?): V4PagePaginationArray< [DeploymentGroup](<https://developers.cloudflare.com/api/typescript/resources/zero_trust#(resource)%20zero_trust.devices.deployment_groups%20%3E%20(model)%20deployment_group%20%3E%20(schema)>) {id, created\_at, name, 3 more } >

GET/accounts/{account\_id}/devices/deployment-groups

##### [Get deployment group](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/devices/subresources/deployment_groups/methods/get)

client.zeroTrust.devices.deploymentGroups.get(stringgroupID, DeploymentGroupGetParams {account\_id } params, RequestOptionsoptions?): [DeploymentGroup](<https://developers.cloudflare.com/api/typescript/resources/zero_trust#(resource)%20zero_trust.devices.deployment_groups%20%3E%20(model)%20deployment_group%20%3E%20(schema)>) {id, created\_at, name, 3 more }

GET/accounts/{account\_id}/devices/deployment-groups/{group\_id}

##### [Create deployment group](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/devices/subresources/deployment_groups/methods/create)

client.zeroTrust.devices.deploymentGroups.create(DeploymentGroupCreateParams {account\_id, name, version\_config, policy\_ids } params, RequestOptionsoptions?): [DeploymentGroup](<https://developers.cloudflare.com/api/typescript/resources/zero_trust#(resource)%20zero_trust.devices.deployment_groups%20%3E%20(model)%20deployment_group%20%3E%20(schema)>) {id, created\_at, name, 3 more }

POST/accounts/{account\_id}/devices/deployment-groups

##### [Update deployment group](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/devices/subresources/deployment_groups/methods/edit)

client.zeroTrust.devices.deploymentGroups.edit(stringgroupID, DeploymentGroupEditParams {account\_id, name, policy\_ids, version\_config } params, RequestOptionsoptions?): [DeploymentGroup](<https://developers.cloudflare.com/api/typescript/resources/zero_trust#(resource)%20zero_trust.devices.deployment_groups%20%3E%20(model)%20deployment_group%20%3E%20(schema)>) {id, created\_at, name, 3 more }

PATCH/accounts/{account\_id}/devices/deployment-groups/{group\_id}

##### [Delete deployment group](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/devices/subresources/deployment_groups/methods/delete)

client.zeroTrust.devices.deploymentGroups.delete(stringgroupID, DeploymentGroupDeleteParams {account\_id } params, RequestOptionsoptions?): [DeploymentGroupDeleteResponse](<https://developers.cloudflare.com/api/typescript/resources/zero_trust#(resource)%20zero_trust.devices.deployment_groups%20%3E%20(model)%20deployment_group_delete_response%20%3E%20(schema)>) {id }

DELETE/accounts/{account\_id}/devices/deployment-groups/{group\_id}

##### ModelsExpand Collapse

<details>

<summary>

DeploymentGroup {id, created\_at, name, 3 more }

</summary>

id: string

The ID of the deployment group.

<a href="#(resource)%20zero_trust.devices.deployment_groups%20%3E%20(model)%20deployment_group%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

created\_at: string

The RFC3339Nano timestamp when the deployment group was created.

<a href="#(resource)%20zero_trust.devices.deployment_groups%20%3E%20(model)%20deployment_group%20%3E%20(schema)%20%3E%20(property)%20created_at">Link to this property</a>

name: string

A user-friendly name for the deployment group.

maxLength255

minLength1

<a href="#(resource)%20zero_trust.devices.deployment_groups%20%3E%20(model)%20deployment_group%20%3E%20(schema)%20%3E%20(property)%20name">Link to this property</a>

updated\_at: string

The RFC3339Nano timestamp when the deployment group was last updated.

<a href="#(resource)%20zero_trust.devices.deployment_groups%20%3E%20(model)%20deployment_group%20%3E%20(schema)%20%3E%20(property)%20updated_at">Link to this property</a>

<details>

<summary>

version\_config: Array&lt;VersionConfig&gt;

Contains version configurations for different target environments.

</summary>

target\_environment: string| null

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

<a href="#(resource)%20zero_trust.devices.deployment_groups%20%3E%20(model)%20deployment_group%20%3E%20(schema)%20%3E%20(property)%20version_config%20%3E%20(items)%20%3E%20(property)%20target_environment">Link to this property</a>

version: string

The specific client version to deploy.

<a href="#(resource)%20zero_trust.devices.deployment_groups%20%3E%20(model)%20deployment_group%20%3E%20(schema)%20%3E%20(property)%20version_config%20%3E%20(items)%20%3E%20(property)%20version">Link to this property</a>

</details>

<a href="#(resource)%20zero_trust.devices.deployment_groups%20%3E%20(model)%20deployment_group%20%3E%20(schema)%20%3E%20(property)%20version_config">Link to this property</a>

policy\_ids?: Array&lt;string&gt;| null

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

<a href="#(resource)%20zero_trust.devices.deployment_groups%20%3E%20(model)%20deployment_group%20%3E%20(schema)%20%3E%20(property)%20policy_ids">Link to this property</a>

</details>

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

<details>

<summary>

DeploymentGroupDeleteResponse {id }

</summary>

id?: string

The ID of a deleted deployment group.

<a href="#(resource)%20zero_trust.devices.deployment_groups%20%3E%20(model)%20deployment_group_delete_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

</details>

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