API Reference

API Gateway

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Labels

Retrieve all labels

client.apiGateway.labels.list(LabelListParams { zone_id, direction, filter, 5 more } params, RequestOptionsoptions?): V4PagePaginationArray<LabelListResponse { created_at, description, last_updated, 4 more } >

GET/zones/{zone_id}/api_gateway/labels

ModelsExpand Collapse

LabelListResponse { 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" | "managed"

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

One of the following:

"user"

"managed"

mapped_resources?: unknown

Provides counts of what resources are linked to this label

LabelsUser

Create user labels

client.apiGateway.labels.user.bulkCreate(UserBulkCreateParams { zone_id, body } params, RequestOptionsoptions?): SinglePage<UserBulkCreateResponse { created_at, description, last_updated, 3 more } >

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

Delete user labels

client.apiGateway.labels.user.bulkDelete(UserBulkDeleteParams { zone_id } params, RequestOptionsoptions?): SinglePage<UserBulkDeleteResponse { created_at, description, last_updated, 3 more } >

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

Retrieve user label

client.apiGateway.labels.user.get(stringname, UserGetParams { zone_id, with_mapped_resource_counts } params, RequestOptionsoptions?): UserGetResponse { created_at, description, last_updated, 4 more }

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

Update user label

client.apiGateway.labels.user.update(stringname, UserUpdateParams { zone_id, description, metadata } params, RequestOptionsoptions?): UserUpdateResponse { created_at, description, last_updated, 3 more }

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

Patch user label

client.apiGateway.labels.user.edit(stringname, UserEditParams { zone_id, description, metadata } params, RequestOptionsoptions?): UserEditResponse { created_at, description, last_updated, 3 more }

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

Delete user label

client.apiGateway.labels.user.delete(stringname, UserDeleteParams { zone_id } params, RequestOptionsoptions?): UserDeleteResponse { created_at, description, last_updated, 3 more }

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

ModelsExpand Collapse

UserBulkCreateResponse { 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" | "managed"

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

One of the following:

"user"

"managed"

UserBulkDeleteResponse { 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" | "managed"

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

One of the following:

"user"

"managed"

UserGetResponse { 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" | "managed"

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

One of the following:

"user"

"managed"

mapped_resources?: unknown

Provides counts of what resources are linked to this label

UserUpdateResponse { 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" | "managed"

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

One of the following:

"user"

"managed"

UserEditResponse { 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" | "managed"

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

One of the following:

"user"

"managed"

UserDeleteResponse { 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" | "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

client.apiGateway.labels.user.resources.operation.update(stringname, OperationUpdateParams { zone_id, selector } params, RequestOptionsoptions?): OperationUpdateResponse { created_at, description, last_updated, 4 more }

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

ModelsExpand Collapse

OperationUpdateResponse { 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" | "managed"

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

One of the following:

"user"

"managed"

mapped_resources?: unknown

Provides counts of what resources are linked to this label

LabelsManaged

Retrieve managed label

client.apiGateway.labels.managed.get(stringname, ManagedGetParams { zone_id, with_mapped_resource_counts } params, RequestOptionsoptions?): ManagedGetResponse { created_at, description, last_updated, 4 more }

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

ModelsExpand Collapse

ManagedGetResponse { 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" | "managed"

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

One of the following:

"user"

"managed"

mapped_resources?: unknown

Provides counts of what resources are linked to this label

LabelsManagedResources

LabelsManagedResourcesOperation

Replace operation(s) attached to a managed label

client.apiGateway.labels.managed.resources.operation.update(stringname, OperationUpdateParams { zone_id, selector } params, RequestOptionsoptions?): OperationUpdateResponse { created_at, description, last_updated, 4 more }

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

ModelsExpand Collapse

OperationUpdateResponse { 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" | "managed"

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

One of the following:

"user"

"managed"

mapped_resources?: unknown

Provides counts of what resources are linked to this label