API Reference

API Gateway

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Labels

Retrieve all labels

GET/zones/{zone_id}/api_gateway/labels

ModelsExpand Collapse

LabelListResponse = object { created_at, description, last_updated, 4 more }

created_at: string

formatdate-time

description: string

The description of the label

last_updated: string

formatdate-time

metadata: unknown

Metadata for the label

name: string

The name of the label

source: "user" or "managed"

• user - label is owned by the user
• managed - label is owned by cloudflare

One of the following:

"user"

"managed"

mapped_resources: optional unknown

Provides counts of what resources are linked to this label

LabelsUser

Create user labels

POST/zones/{zone_id}/api_gateway/labels/user

Delete user labels

DELETE/zones/{zone_id}/api_gateway/labels/user

Retrieve user label

GET/zones/{zone_id}/api_gateway/labels/user/{name}

Update user label

PUT/zones/{zone_id}/api_gateway/labels/user/{name}

Patch user label

PATCH/zones/{zone_id}/api_gateway/labels/user/{name}

Delete user label

DELETE/zones/{zone_id}/api_gateway/labels/user/{name}

ModelsExpand Collapse

UserBulkCreateResponse = object { created_at, description, last_updated, 3 more }

created_at: string

formatdate-time

description: string

The description of the label

last_updated: string

formatdate-time

metadata: unknown

Metadata for the label

name: string

The name of the label

source: "user" or "managed"

• user - label is owned by the user
• managed - label is owned by cloudflare

One of the following:

"user"

"managed"

UserBulkDeleteResponse = object { created_at, description, last_updated, 3 more }

created_at: string

formatdate-time

description: string

The description of the label

last_updated: string

formatdate-time

metadata: unknown

Metadata for the label

name: string

The name of the label

source: "user" or "managed"

• user - label is owned by the user
• managed - label is owned by cloudflare

One of the following:

"user"

"managed"

UserGetResponse = object { created_at, description, last_updated, 4 more }

created_at: string

formatdate-time

description: string

The description of the label

last_updated: string

formatdate-time

metadata: unknown

Metadata for the label

name: string

The name of the label

source: "user" or "managed"

• user - label is owned by the user
• managed - label is owned by cloudflare

One of the following:

"user"

"managed"

mapped_resources: optional unknown

Provides counts of what resources are linked to this label

UserUpdateResponse = object { created_at, description, last_updated, 3 more }

created_at: string

formatdate-time

description: string

The description of the label

last_updated: string

formatdate-time

metadata: unknown

Metadata for the label

name: string

The name of the label

source: "user" or "managed"

• user - label is owned by the user
• managed - label is owned by cloudflare

One of the following:

"user"

"managed"

UserEditResponse = object { created_at, description, last_updated, 3 more }

created_at: string

formatdate-time

description: string

The description of the label

last_updated: string

formatdate-time

metadata: unknown

Metadata for the label

name: string

The name of the label

source: "user" or "managed"

• user - label is owned by the user
• managed - label is owned by cloudflare

One of the following:

"user"

"managed"

UserDeleteResponse = object { created_at, description, last_updated, 3 more }

created_at: string

formatdate-time

description: string

The description of the label

last_updated: string

formatdate-time

metadata: unknown

Metadata for the label

name: string

The name of the label

source: "user" or "managed"

• user - label is owned by the user
• managed - label is owned by cloudflare

One of the following:

"user"

"managed"

LabelsUserResources

LabelsUserResourcesOperation

Replace operation(s) attached to a user label

PUT/zones/{zone_id}/api_gateway/labels/user/{name}/resources/operation

ModelsExpand Collapse

OperationUpdateResponse = object { created_at, description, last_updated, 4 more }

created_at: string

formatdate-time

description: string

The description of the label

last_updated: string

formatdate-time

metadata: unknown

Metadata for the label

name: string

The name of the label

source: "user" or "managed"

• user - label is owned by the user
• managed - label is owned by cloudflare

One of the following:

"user"

"managed"

mapped_resources: optional unknown

Provides counts of what resources are linked to this label

LabelsManaged

Retrieve managed label

GET/zones/{zone_id}/api_gateway/labels/managed/{name}

ModelsExpand Collapse

ManagedGetResponse = object { created_at, description, last_updated, 4 more }

created_at: string

formatdate-time

description: string

The description of the label

last_updated: string

formatdate-time

metadata: unknown

Metadata for the label

name: string

The name of the label

source: "user" or "managed"

• user - label is owned by the user
• managed - label is owned by cloudflare

One of the following:

"user"

"managed"

mapped_resources: optional unknown

Provides counts of what resources are linked to this label

LabelsManagedResources

LabelsManagedResourcesOperation

Replace operation(s) attached to a managed label

PUT/zones/{zone_id}/api_gateway/labels/managed/{name}/resources/operation

ModelsExpand Collapse

OperationUpdateResponse = object { created_at, description, last_updated, 4 more }

created_at: string

formatdate-time

description: string

The description of the label

last_updated: string

formatdate-time

metadata: unknown

Metadata for the label

name: string

The name of the label

source: "user" or "managed"

• user - label is owned by the user
• managed - label is owned by cloudflare

One of the following:

"user"

"managed"

mapped_resources: optional unknown

Provides counts of what resources are linked to this label