API Reference

Resource Tagging

Account Tags

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Set tags for an account-level resource

resource_tagging.account_tags.update(AccountTagUpdateParams**kwargs) -> AccountTagUpdateResponse

PUT/accounts/{account_id}/tags

Creates or updates tags for a specific account-level resource.

Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

ParametersExpand Collapse

account_id: str

Identifier.

maxLength32

minLength32

resource_id: str

Identifies the unique resource.

resource_type: Literal["access_application", "access_group", "account", 17 more]

Enum for base account-level resource types (those with no extra required fields).

One of the following:

"access_application"

"access_group"

"account"

"ai_gateway"

"alerting_policy"

"alerting_webhook"

"cloudflared_tunnel"

"d1_database"

"durable_object_namespace"

"gateway_list"

"gateway_rule"

"image"

"kv_namespace"

"queue"

"r2_bucket"

"resource_share"

"stream_live_input"

"stream_video"

"worker"

"worker_version"

worker_id: str

Worker ID is required only for worker_version resources

tags: Optional[Dict[str, str]]

Contains key-value pairs of tags.

if_match: Optional[str]

ReturnsExpand Collapse

AccountTagUpdateResponse

Response for access_application resources

One of the following:

class ResourceTaggingTaggedResourceObjectAccessApplication: …

Response for access_application resources

id: str

Identifies the unique resource.

etag: str

ETag identifier for optimistic concurrency control. Formatted as “v1:” where the hash is the base64url-encoded SHA-256 (truncated to 128 bits) of the tags map canonicalized using RFC 8785 (JSON Canonicalization Scheme). Clients should treat ETags as opaque strings and pass them back via the If-Match header on write operations.

name: str

Human-readable name of the resource.

tags: Dict[str, str]

Contains key-value pairs of tags.

type: Literal["access_application"]

class ResourceTaggingTaggedResourceObjectAccessApplicationPolicy: …

Response for access_application_policy resources

id: str

Identifies the unique resource.

access_application_id: str

Access application ID is required only for access_application_policy resources

formatuuid

etag: str

ETag identifier for optimistic concurrency control. Formatted as “v1:” where the hash is the base64url-encoded SHA-256 (truncated to 128 bits) of the tags map canonicalized using RFC 8785 (JSON Canonicalization Scheme). Clients should treat ETags as opaque strings and pass them back via the If-Match header on write operations.

name: str

Human-readable name of the resource.

tags: Dict[str, str]

Contains key-value pairs of tags.

type: Literal["access_application_policy"]

zone_id: str

Zone ID is required only for zone-level resources

maxLength32

minLength32

class ResourceTaggingTaggedResourceObjectAccessGroup: …

Response for access_group resources

id: str

Identifies the unique resource.

etag: str

ETag identifier for optimistic concurrency control. Formatted as “v1:” where the hash is the base64url-encoded SHA-256 (truncated to 128 bits) of the tags map canonicalized using RFC 8785 (JSON Canonicalization Scheme). Clients should treat ETags as opaque strings and pass them back via the If-Match header on write operations.

name: str

Human-readable name of the resource.

tags: Dict[str, str]

Contains key-value pairs of tags.

type: Literal["access_group"]

class ResourceTaggingTaggedResourceObjectAccount: …

Response for account resources

id: str

Identifies the unique resource.

etag: str

ETag identifier for optimistic concurrency control. Formatted as “v1:” where the hash is the base64url-encoded SHA-256 (truncated to 128 bits) of the tags map canonicalized using RFC 8785 (JSON Canonicalization Scheme). Clients should treat ETags as opaque strings and pass them back via the If-Match header on write operations.

name: str

Human-readable name of the resource.

tags: Dict[str, str]

Contains key-value pairs of tags.

type: Literal["account"]

class ResourceTaggingTaggedResourceObjectAIGateway: …

Response for ai_gateway resources

id: str

Identifies the unique resource.

etag: str

ETag identifier for optimistic concurrency control. Formatted as “v1:” where the hash is the base64url-encoded SHA-256 (truncated to 128 bits) of the tags map canonicalized using RFC 8785 (JSON Canonicalization Scheme). Clients should treat ETags as opaque strings and pass them back via the If-Match header on write operations.

name: str

Human-readable name of the resource.

tags: Dict[str, str]

Contains key-value pairs of tags.

type: Literal["ai_gateway"]

class ResourceTaggingTaggedResourceObjectAlertingPolicy: …

Response for alerting_policy resources

id: str

Identifies the unique resource.

etag: str

ETag identifier for optimistic concurrency control. Formatted as “v1:” where the hash is the base64url-encoded SHA-256 (truncated to 128 bits) of the tags map canonicalized using RFC 8785 (JSON Canonicalization Scheme). Clients should treat ETags as opaque strings and pass them back via the If-Match header on write operations.

name: str

Human-readable name of the resource.

tags: Dict[str, str]

Contains key-value pairs of tags.

type: Literal["alerting_policy"]

class ResourceTaggingTaggedResourceObjectAlertingWebhook: …

Response for alerting_webhook resources

id: str

Identifies the unique resource.

etag: str

ETag identifier for optimistic concurrency control. Formatted as “v1:” where the hash is the base64url-encoded SHA-256 (truncated to 128 bits) of the tags map canonicalized using RFC 8785 (JSON Canonicalization Scheme). Clients should treat ETags as opaque strings and pass them back via the If-Match header on write operations.

name: str

Human-readable name of the resource.

tags: Dict[str, str]

Contains key-value pairs of tags.

type: Literal["alerting_webhook"]

class ResourceTaggingTaggedResourceObjectAPIGatewayOperation: …

Response for api_gateway_operation resources

id: str

Identifies the unique resource.

etag: str

ETag identifier for optimistic concurrency control. Formatted as “v1:” where the hash is the base64url-encoded SHA-256 (truncated to 128 bits) of the tags map canonicalized using RFC 8785 (JSON Canonicalization Scheme). Clients should treat ETags as opaque strings and pass them back via the If-Match header on write operations.

name: str

Human-readable name of the resource.

tags: Dict[str, str]

Contains key-value pairs of tags.

type: Literal["api_gateway_operation"]

zone_id: str

Zone ID is required only for zone-level resources

maxLength32

minLength32

class ResourceTaggingTaggedResourceObjectCloudflaredTunnel: …

Response for cloudflared_tunnel resources

id: str

Identifies the unique resource.

etag: str

ETag identifier for optimistic concurrency control. Formatted as “v1:” where the hash is the base64url-encoded SHA-256 (truncated to 128 bits) of the tags map canonicalized using RFC 8785 (JSON Canonicalization Scheme). Clients should treat ETags as opaque strings and pass them back via the If-Match header on write operations.

name: str

Human-readable name of the resource.

tags: Dict[str, str]

Contains key-value pairs of tags.

type: Literal["cloudflared_tunnel"]

class ResourceTaggingTaggedResourceObjectCustomCertificate: …

Response for custom_certificate resources

id: str

Identifies the unique resource.

etag: str

ETag identifier for optimistic concurrency control. Formatted as “v1:” where the hash is the base64url-encoded SHA-256 (truncated to 128 bits) of the tags map canonicalized using RFC 8785 (JSON Canonicalization Scheme). Clients should treat ETags as opaque strings and pass them back via the If-Match header on write operations.

name: str

Human-readable name of the resource.

tags: Dict[str, str]

Contains key-value pairs of tags.

type: Literal["custom_certificate"]

zone_id: str

Zone ID is required only for zone-level resources

maxLength32

minLength32

class ResourceTaggingTaggedResourceObjectCustomHostname: …

Response for custom_hostname resources

id: str

Identifies the unique resource.

etag: str

ETag identifier for optimistic concurrency control. Formatted as “v1:” where the hash is the base64url-encoded SHA-256 (truncated to 128 bits) of the tags map canonicalized using RFC 8785 (JSON Canonicalization Scheme). Clients should treat ETags as opaque strings and pass them back via the If-Match header on write operations.

name: str

Human-readable name of the resource.

tags: Dict[str, str]

Contains key-value pairs of tags.

type: Literal["custom_hostname"]

zone_id: str

Zone ID is required only for zone-level resources

maxLength32

minLength32

class ResourceTaggingTaggedResourceObjectD1Database: …

Response for d1_database resources

id: str

Identifies the unique resource.

etag: str

ETag identifier for optimistic concurrency control. Formatted as “v1:” where the hash is the base64url-encoded SHA-256 (truncated to 128 bits) of the tags map canonicalized using RFC 8785 (JSON Canonicalization Scheme). Clients should treat ETags as opaque strings and pass them back via the If-Match header on write operations.

name: str

Human-readable name of the resource.

tags: Dict[str, str]

Contains key-value pairs of tags.

type: Literal["d1_database"]

class ResourceTaggingTaggedResourceObjectDNSRecord: …

Response for dns_record resources

id: str

Identifies the unique resource.

etag: str

ETag identifier for optimistic concurrency control. Formatted as “v1:” where the hash is the base64url-encoded SHA-256 (truncated to 128 bits) of the tags map canonicalized using RFC 8785 (JSON Canonicalization Scheme). Clients should treat ETags as opaque strings and pass them back via the If-Match header on write operations.

name: str

Human-readable name of the resource.

tags: Dict[str, str]

Contains key-value pairs of tags.

type: Literal["dns_record"]

zone_id: str

Zone ID is required only for zone-level resources

maxLength32

minLength32

class ResourceTaggingTaggedResourceObjectDurableObjectNamespace: …

Response for durable_object_namespace resources

id: str

Identifies the unique resource.

etag: str

ETag identifier for optimistic concurrency control. Formatted as “v1:” where the hash is the base64url-encoded SHA-256 (truncated to 128 bits) of the tags map canonicalized using RFC 8785 (JSON Canonicalization Scheme). Clients should treat ETags as opaque strings and pass them back via the If-Match header on write operations.

name: str

Human-readable name of the resource.

tags: Dict[str, str]

Contains key-value pairs of tags.

type: Literal["durable_object_namespace"]

class ResourceTaggingTaggedResourceObjectGatewayList: …

Response for gateway_list resources

id: str

Identifies the unique resource.

etag: str

ETag identifier for optimistic concurrency control. Formatted as “v1:” where the hash is the base64url-encoded SHA-256 (truncated to 128 bits) of the tags map canonicalized using RFC 8785 (JSON Canonicalization Scheme). Clients should treat ETags as opaque strings and pass them back via the If-Match header on write operations.

name: str

Human-readable name of the resource.

tags: Dict[str, str]

Contains key-value pairs of tags.

type: Literal["gateway_list"]

class ResourceTaggingTaggedResourceObjectGatewayRule: …

Response for gateway_rule resources

id: str

Identifies the unique resource.

etag: str

ETag identifier for optimistic concurrency control. Formatted as “v1:” where the hash is the base64url-encoded SHA-256 (truncated to 128 bits) of the tags map canonicalized using RFC 8785 (JSON Canonicalization Scheme). Clients should treat ETags as opaque strings and pass them back via the If-Match header on write operations.

name: str

Human-readable name of the resource.

tags: Dict[str, str]

Contains key-value pairs of tags.

type: Literal["gateway_rule"]

class ResourceTaggingTaggedResourceObjectImage: …

Response for image resources

id: str

Identifies the unique resource.

etag: str

ETag identifier for optimistic concurrency control. Formatted as “v1:” where the hash is the base64url-encoded SHA-256 (truncated to 128 bits) of the tags map canonicalized using RFC 8785 (JSON Canonicalization Scheme). Clients should treat ETags as opaque strings and pass them back via the If-Match header on write operations.

name: str

Human-readable name of the resource.

tags: Dict[str, str]

Contains key-value pairs of tags.

type: Literal["image"]

class ResourceTaggingTaggedResourceObjectKVNamespace: …

Response for kv_namespace resources

id: str

Identifies the unique resource.

etag: str

ETag identifier for optimistic concurrency control. Formatted as “v1:” where the hash is the base64url-encoded SHA-256 (truncated to 128 bits) of the tags map canonicalized using RFC 8785 (JSON Canonicalization Scheme). Clients should treat ETags as opaque strings and pass them back via the If-Match header on write operations.

name: str

Human-readable name of the resource.

tags: Dict[str, str]

Contains key-value pairs of tags.

type: Literal["kv_namespace"]

class ResourceTaggingTaggedResourceObjectManagedClientCertificate: …

Response for managed_client_certificate resources

id: str

Identifies the unique resource.

etag: str

ETag identifier for optimistic concurrency control. Formatted as “v1:” where the hash is the base64url-encoded SHA-256 (truncated to 128 bits) of the tags map canonicalized using RFC 8785 (JSON Canonicalization Scheme). Clients should treat ETags as opaque strings and pass them back via the If-Match header on write operations.

name: str

Human-readable name of the resource.

tags: Dict[str, str]

Contains key-value pairs of tags.

type: Literal["managed_client_certificate"]

zone_id: str

Zone ID is required only for zone-level resources

maxLength32

minLength32

class ResourceTaggingTaggedResourceObjectQueue: …

Response for queue resources

id: str

Identifies the unique resource.

etag: str

ETag identifier for optimistic concurrency control. Formatted as “v1:” where the hash is the base64url-encoded SHA-256 (truncated to 128 bits) of the tags map canonicalized using RFC 8785 (JSON Canonicalization Scheme). Clients should treat ETags as opaque strings and pass them back via the If-Match header on write operations.

name: str

Human-readable name of the resource.

tags: Dict[str, str]

Contains key-value pairs of tags.

type: Literal["queue"]

class ResourceTaggingTaggedResourceObjectR2Bucket: …

Response for r2_bucket resources

id: str

Identifies the unique resource.

etag: str

ETag identifier for optimistic concurrency control. Formatted as “v1:” where the hash is the base64url-encoded SHA-256 (truncated to 128 bits) of the tags map canonicalized using RFC 8785 (JSON Canonicalization Scheme). Clients should treat ETags as opaque strings and pass them back via the If-Match header on write operations.

name: str

Human-readable name of the resource.

tags: Dict[str, str]

Contains key-value pairs of tags.

type: Literal["r2_bucket"]

class ResourceTaggingTaggedResourceObjectResourceShare: …

Response for resource_share resources

id: str

Identifies the unique resource.

etag: str

ETag identifier for optimistic concurrency control. Formatted as “v1:” where the hash is the base64url-encoded SHA-256 (truncated to 128 bits) of the tags map canonicalized using RFC 8785 (JSON Canonicalization Scheme). Clients should treat ETags as opaque strings and pass them back via the If-Match header on write operations.

name: str

Human-readable name of the resource.

tags: Dict[str, str]

Contains key-value pairs of tags.

type: Literal["resource_share"]

class ResourceTaggingTaggedResourceObjectStreamLiveInput: …

Response for stream_live_input resources

id: str

Identifies the unique resource.

etag: str

ETag identifier for optimistic concurrency control. Formatted as “v1:” where the hash is the base64url-encoded SHA-256 (truncated to 128 bits) of the tags map canonicalized using RFC 8785 (JSON Canonicalization Scheme). Clients should treat ETags as opaque strings and pass them back via the If-Match header on write operations.

name: str

Human-readable name of the resource.

tags: Dict[str, str]

Contains key-value pairs of tags.

type: Literal["stream_live_input"]

class ResourceTaggingTaggedResourceObjectStreamVideo: …

Response for stream_video resources

id: str

Identifies the unique resource.

etag: str

ETag identifier for optimistic concurrency control. Formatted as “v1:” where the hash is the base64url-encoded SHA-256 (truncated to 128 bits) of the tags map canonicalized using RFC 8785 (JSON Canonicalization Scheme). Clients should treat ETags as opaque strings and pass them back via the If-Match header on write operations.

name: str

Human-readable name of the resource.

tags: Dict[str, str]

Contains key-value pairs of tags.

type: Literal["stream_video"]

class ResourceTaggingTaggedResourceObjectWorker: …

Response for worker resources

id: str

Identifies the unique resource.

etag: str

ETag identifier for optimistic concurrency control. Formatted as “v1:” where the hash is the base64url-encoded SHA-256 (truncated to 128 bits) of the tags map canonicalized using RFC 8785 (JSON Canonicalization Scheme). Clients should treat ETags as opaque strings and pass them back via the If-Match header on write operations.

name: str

Human-readable name of the resource.

tags: Dict[str, str]

Contains key-value pairs of tags.

type: Literal["worker"]

class ResourceTaggingTaggedResourceObjectWorkerVersion: …

Response for worker_version resources

id: str

Identifies the unique resource.

etag: str

ETag identifier for optimistic concurrency control. Formatted as “v1:” where the hash is the base64url-encoded SHA-256 (truncated to 128 bits) of the tags map canonicalized using RFC 8785 (JSON Canonicalization Scheme). Clients should treat ETags as opaque strings and pass them back via the If-Match header on write operations.

name: str

Human-readable name of the resource.

tags: Dict[str, str]

Contains key-value pairs of tags.

type: Literal["worker_version"]

worker_id: str

Worker ID is required only for worker_version resources

class ResourceTaggingTaggedResourceObjectZone: …

Response for zone resources

id: str

Identifies the unique resource.

etag: str

ETag identifier for optimistic concurrency control. Formatted as “v1:” where the hash is the base64url-encoded SHA-256 (truncated to 128 bits) of the tags map canonicalized using RFC 8785 (JSON Canonicalization Scheme). Clients should treat ETags as opaque strings and pass them back via the If-Match header on write operations.

name: str

Human-readable name of the resource.

tags: Dict[str, str]

Contains key-value pairs of tags.

type: Literal["zone"]

zone_id: str

Zone ID is required only for zone-level resources

maxLength32

minLength32

Set tags for an account-level resource

Python

HTTP

TypeScript

Python

Go

Terraform

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_email=os.environ.get("CLOUDFLARE_EMAIL"),  # This is the default and can be omitted
    api_key=os.environ.get("CLOUDFLARE_API_KEY"),  # This is the default and can be omitted
)
account_tag = client.resource_tagging.account_tags.update(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
    resource_id="023e105f4ecef8ad9ca31a8372d0c353",
    resource_type="worker",
    worker_id="3f72a691-44b3-4c11-8642-c18a88ddaa5e",
)
print(account_tag)

200 example

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "etag": "v1:RBNvo1WzZ4oRRq0W9-hkng",
    "name": "my-worker-script",
    "tags": {
      "environment": "production",
      "team": "engineering"
    },
    "type": "access_application"
  }
}

Returns Examples

200 example

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "etag": "v1:RBNvo1WzZ4oRRq0W9-hkng",
    "name": "my-worker-script",
    "tags": {
      "environment": "production",
      "team": "engineering"
    },
    "type": "access_application"
  }
}