Cloudflare API | IAM › Resource Groups › List Resource Groups

API Reference

Account & User Management

Permission Groups

Resource Groups

Create Resource Group

Remove Resource Group

Resource Group Details

List Resource Groups

Update Resource Group

Resource Sharing

AI

Certificate Management

Certificate Authorities

Client Certificates

Custom Certificates

Custom Hostnames

Keyless Certificates

MTLS Certificates

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

Cloudflare One

DNS

Account Custom Nameservers

Domain/Zone Management

IP Addresses

Media

Networking

Magic Network Monitoring

Network Interconnects

Observability

Security Center

Radar

Routing & Performance

Rules

Cloud Connector

Managed Transforms

URL Normalization

Security

Content Scanning

Leaked Credential Checks

Storage & Databases

Threat Intelligence

Brand Protection

Workers & Pages

Browser Rendering

Durable Objects

Workers For Platforms

Shared

IAM

iam

Permission Groups

iam.permission_groups

Methods

Permission Group Details -> { id, meta, name }

get/accounts/{account_id}/iam/permission_groups/{permission_group_id}

Get information about a specific permission group in an account.

List Account Permission Groups -> V4PagePaginationArray<{ id, meta, name }>

get/accounts/{account_id}/iam/permission_groups

List all the permissions groups for an account.

Resource Groups

iam.resource_groups

Methods

Create Resource Group -> { id, meta, scope }

post/accounts/{account_id}/iam/resource_groups

Create a new Resource Group under the specified account.

Remove Resource Group -> Envelope<{ id }>

delete/accounts/{account_id}/iam/resource_groups/{resource_group_id}

Remove a resource group from an account.

Resource Group Details -> { id, scope, meta, 1 more... }

get/accounts/{account_id}/iam/resource_groups/{resource_group_id}

Get information about a specific resource group in an account.

List Resource Groups -> V4PagePaginationArray<{ id, scope, meta, 1 more... }>

get/accounts/{account_id}/iam/resource_groups

List all the resource groups for an account.

Security

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

SCIM Provisioning Account Settings Write Account Settings Read

Parameters

account_id: string

(maxLength: 32)

Account identifier tag.

id: string

Optional

(maxLength: 32, minLength: 32)

ID of the resource group to be fetched.

name: string

Optional

Name of the resource group to be fetched.

page: number

Optional

(minimum: 1)

Page number of paginated results.

per_page: number

Optional

(maximum: 50, minimum: 5)

Maximum number of results per page.

Response fields

errors: Array<

>

messages: Array<

>

success: true

Whether the API call was successful

result: Array<{ id, scope, meta, 1 more... }>

Optional

A list of resource groups that the policy applies to.

result_info: { count, page, per_page, 1 more... }

Optional

Request example

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/iam/resource_groups \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "success": true,
  "result": [
    {
      "scope": [
        {
          "objects": [
            {}
          ]
        }
      ],
      "meta": {
        "key": "key",
        "value": "value"
      }
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}

Update Resource Group -> { id, scope, meta, 1 more... }

put/accounts/{account_id}/iam/resource_groups/{resource_group_id}

Modify an existing resource group.