INTEGRITY Cloudflare Docs

Get started

This guide walks you through verifying that tagging works on your account and making your first API calls.

Prerequisites

1. Verify tagging is enabled

Test the API to confirm tagging is active on your account:

curl -X GET "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/tags/keys" \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json"

Interpreting the response

Response Meaning Action
200 OK with {"success": true, "result": [...]} Tagging is enabled. An empty array is normal if no tags exist yet. Proceed to the next step.
403 mentioning "permission" or "role" The caller lacks required permissions. Verify the caller has a Super Admin, Workers Admin, or Tag Admin role, or that the token has #com.cloudflare.api.account.tag.list scope.
403 mentioning "feature" or "gate" Tagging is not enabled for this account. Contact Cloudflare support for assistance.
401 Unauthorized Authentication failed. Verify the token is valid, not expired, and formatted correctly in the Authorization: Bearer header.
Any other response Unexpected error. Capture the full response body and contact Cloudflare support with the Account ID, request details, and timestamp.

2. Create your first tags

Set tags on a resource using PUT:

curl -X PUT "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/tags" \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "resource_type": "worker",
    "resource_id": "'"$RESOURCE_ID"'",
    "tags": {
      "environment": "production",
      "team": "platform"
    }
  }'

Then retrieve the tags:

curl -X GET "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/tags?resource_type=worker&resource_id=$RESOURCE_ID" \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json"

3. List tagged resources

Query all tagged resources in the account, optionally filtering by tag:

# All tagged resources
curl -X GET "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/tags/resources" \
  -H "Authorization: Bearer $API_TOKEN"

# Filter: only resources with environment=production
curl -X GET "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/tags/resources?tag=environment=production" \
  -H "Authorization: Bearer $API_TOKEN"

Next steps