Skip to content
Cloudflare API
Start here
API Reference
API Gateway

Labels

Retrieve all labels
api_gateway.labels.list(LabelListParams**kwargs) -> SyncV4PagePaginationArray[LabelListResponse]
GET/zones/{zone_id}/api_gateway/labels
ModelsExpand Collapse
class LabelListResponse: …
created_at: datetime
formatdate-time
description: str

The description of the label

last_updated: datetime
formatdate-time
metadata: object

Metadata for the label

name: str

The name of the label

source: Literal["user", "managed"]
  • user - label is owned by the user
  • managed - label is owned by cloudflare
One of the following:
"user"
"managed"
mapped_resources: Optional[object]

Provides counts of what resources are linked to this label

LabelsUser

Create user labels
api_gateway.labels.user.bulk_create(UserBulkCreateParams**kwargs) -> SyncSinglePage[UserBulkCreateResponse]
POST/zones/{zone_id}/api_gateway/labels/user
Delete user labels
api_gateway.labels.user.bulk_delete(UserBulkDeleteParams**kwargs) -> SyncSinglePage[UserBulkDeleteResponse]
DELETE/zones/{zone_id}/api_gateway/labels/user
Retrieve user label
api_gateway.labels.user.get(strname, UserGetParams**kwargs) -> UserGetResponse
GET/zones/{zone_id}/api_gateway/labels/user/{name}
Update user label
api_gateway.labels.user.update(strname, UserUpdateParams**kwargs) -> UserUpdateResponse
PUT/zones/{zone_id}/api_gateway/labels/user/{name}
Patch user label
api_gateway.labels.user.edit(strname, UserEditParams**kwargs) -> UserEditResponse
PATCH/zones/{zone_id}/api_gateway/labels/user/{name}
Delete user label
api_gateway.labels.user.delete(strname, UserDeleteParams**kwargs) -> UserDeleteResponse
DELETE/zones/{zone_id}/api_gateway/labels/user/{name}
ModelsExpand Collapse
class UserBulkCreateResponse: …
created_at: datetime
formatdate-time
description: str

The description of the label

last_updated: datetime
formatdate-time
metadata: object

Metadata for the label

name: str

The name of the label

source: Literal["user", "managed"]
  • user - label is owned by the user
  • managed - label is owned by cloudflare
One of the following:
"user"
"managed"
class UserBulkDeleteResponse: …
created_at: datetime
formatdate-time
description: str

The description of the label

last_updated: datetime
formatdate-time
metadata: object

Metadata for the label

name: str

The name of the label

source: Literal["user", "managed"]
  • user - label is owned by the user
  • managed - label is owned by cloudflare
One of the following:
"user"
"managed"
class UserGetResponse: …
created_at: datetime
formatdate-time
description: str

The description of the label

last_updated: datetime
formatdate-time
metadata: object

Metadata for the label

name: str

The name of the label

source: Literal["user", "managed"]
  • user - label is owned by the user
  • managed - label is owned by cloudflare
One of the following:
"user"
"managed"
mapped_resources: Optional[object]

Provides counts of what resources are linked to this label

class UserUpdateResponse: …
created_at: datetime
formatdate-time
description: str

The description of the label

last_updated: datetime
formatdate-time
metadata: object

Metadata for the label

name: str

The name of the label

source: Literal["user", "managed"]
  • user - label is owned by the user
  • managed - label is owned by cloudflare
One of the following:
"user"
"managed"
class UserEditResponse: …
created_at: datetime
formatdate-time
description: str

The description of the label

last_updated: datetime
formatdate-time
metadata: object

Metadata for the label

name: str

The name of the label

source: Literal["user", "managed"]
  • user - label is owned by the user
  • managed - label is owned by cloudflare
One of the following:
"user"
"managed"
class UserDeleteResponse: …
created_at: datetime
formatdate-time
description: str

The description of the label

last_updated: datetime
formatdate-time
metadata: object

Metadata for the label

name: str

The name of the label

source: Literal["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
api_gateway.labels.user.resources.operation.update(strname, OperationUpdateParams**kwargs) -> OperationUpdateResponse
PUT/zones/{zone_id}/api_gateway/labels/user/{name}/resources/operation
ModelsExpand Collapse
class OperationUpdateResponse: …
created_at: datetime
formatdate-time
description: str

The description of the label

last_updated: datetime
formatdate-time
metadata: object

Metadata for the label

name: str

The name of the label

source: Literal["user", "managed"]
  • user - label is owned by the user
  • managed - label is owned by cloudflare
One of the following:
"user"
"managed"
mapped_resources: Optional[object]

Provides counts of what resources are linked to this label

LabelsManaged

Retrieve managed label
api_gateway.labels.managed.get(strname, ManagedGetParams**kwargs) -> ManagedGetResponse
GET/zones/{zone_id}/api_gateway/labels/managed/{name}
ModelsExpand Collapse
class ManagedGetResponse: …
created_at: datetime
formatdate-time
description: str

The description of the label

last_updated: datetime
formatdate-time
metadata: object

Metadata for the label

name: str

The name of the label

source: Literal["user", "managed"]
  • user - label is owned by the user
  • managed - label is owned by cloudflare
One of the following:
"user"
"managed"
mapped_resources: Optional[object]

Provides counts of what resources are linked to this label

LabelsManagedResources

LabelsManagedResourcesOperation

Replace operation(s) attached to a managed label
api_gateway.labels.managed.resources.operation.update(strname, OperationUpdateParams**kwargs) -> OperationUpdateResponse
PUT/zones/{zone_id}/api_gateway/labels/managed/{name}/resources/operation
ModelsExpand Collapse
class OperationUpdateResponse: …
created_at: datetime
formatdate-time
description: str

The description of the label

last_updated: datetime
formatdate-time
metadata: object

Metadata for the label

name: str

The name of the label

source: Literal["user", "managed"]
  • user - label is owned by the user
  • managed - label is owned by cloudflare
One of the following:
"user"
"managed"
mapped_resources: Optional[object]

Provides counts of what resources are linked to this label