deployment_groups

Creates, updates, deletes, gets or lists a deployment_groups resource.

Overview

Name	deployment_groups
Type	Resource
Id	cloudflare.zero_trust.deployment_groups

Fields

The following fields are returned by SELECT queries:

get

Gets deployment group response.

Name	Datatype	Description
id	string	The ID of the deployment group. (example: 550e8400-e29b-41d4-a716-446655440000)
name	string	A user-friendly name for the deployment group. (example: Engineering Ring 0)
created_at	string	The RFC3339Nano timestamp when the deployment group was created. (example: 2026-02-14T13:17:00.123456789Z)
policy_ids	array	Contains a list of policy IDs assigned to this deployment group.
updated_at	string	The RFC3339Nano timestamp when the deployment group was last updated. (example: 2026-02-14T13:17:00.123456789Z)
version_config	array	Contains version configurations for different target environments.

list

Lists deployment group response.

Name	Datatype	Description
id	string	The ID of the deployment group. (example: 550e8400-e29b-41d4-a716-446655440000)
name	string	A user-friendly name for the deployment group. (example: Engineering Ring 0)
created_at	string	The RFC3339Nano timestamp when the deployment group was created. (example: 2026-02-14T13:17:00.123456789Z)
policy_ids	array	Contains a list of policy IDs assigned to this deployment group.
updated_at	string	The RFC3339Nano timestamp when the deployment group was last updated. (example: 2026-02-14T13:17:00.123456789Z)
version_config	array	Contains version configurations for different target environments.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, group_id		Fetches a single deployment group by its ID. This endpoint is in Beta.
list	select	account_id	page, per_page	Lists all deployment groups for an account. Use deployment groups to assign target WARP client versions to specific devices. This endpoint is in Beta.
create	insert	account_id, name, version_config		Creates a new deployment group. Policy IDs must be unique across all deployment groups. This endpoint is in Beta.
edit	update	account_id, group_id		Updates a deployment group. Returns 409 if any newly added policy IDs already belong to another deployment group. This endpoint is in Beta.
delete	delete	account_id, group_id		Deletes a deployment group. Associated policies no longer apply and devices stop receiving version targets. This endpoint is in Beta.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_id	string	The Cloudflare account ID.
group_id	string	The Access group ID.
page	integer	The page number to return.
per_page	integer	The maximum number of deployment groups to return per page.

SELECT examples

get

Fetches a single deployment group by its ID. This endpoint is in Beta.

SELECT
id,
name,
created_at,
policy_ids,
updated_at,
version_config
FROM cloudflare.zero_trust.deployment_groups
WHERE account_id = '{{ account_id }}' -- required
AND group_id = '{{ group_id }}' -- required
;

list

Lists all deployment groups for an account. Use deployment groups to assign target WARP client versions to specific devices. This endpoint is in Beta.

SELECT
id,
name,
created_at,
policy_ids,
updated_at,
version_config
FROM cloudflare.zero_trust.deployment_groups
WHERE account_id = '{{ account_id }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
;

INSERT examples

create

Creates a new deployment group. Policy IDs must be unique across all deployment groups. This endpoint is in Beta.

INSERT INTO cloudflare.zero_trust.deployment_groups (
name,
policy_ids,
version_config,
account_id
)
SELECT 
'{{ name }}' /* required */,
'{{ policy_ids }}',
'{{ version_config }}' /* required */,
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: deployment_groups
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the deployment_groups resource.
  - name: name
    value: "{{ name }}"
    description: |
      A user-friendly name for the deployment group.
  - name: policy_ids
    value:
      - "{{ policy_ids }}"
    description: |
      Contains an optional list of policy IDs assigned to a group.
  - name: version_config
    description: |
      Contains at least one version configuration.
    value:
      - target_environment: "{{ target_environment }}"
        version: "{{ version }}"

UPDATE examples

edit

Updates a deployment group. Returns 409 if any newly added policy IDs already belong to another deployment group. This endpoint is in Beta.

UPDATE cloudflare.zero_trust.deployment_groups
SET 
name = '{{ name }}',
policy_ids = '{{ policy_ids }}',
version_config = '{{ version_config }}'
WHERE 
account_id = '{{ account_id }}' --required
AND group_id = '{{ group_id }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Deletes a deployment group. Associated policies no longer apply and devices stop receiving version targets. This endpoint is in Beta.

DELETE FROM cloudflare.zero_trust.deployment_groups
WHERE account_id = '{{ account_id }}' --required
AND group_id = '{{ group_id }}' --required
;