api.md

APIGateway

Configurations

Types:

from cloudflare.types.api_gateway import Configuration

Methods:

• client.api_gateway.configurations.update(*, zone_id, **params) -> Configuration
• client.api_gateway.configurations.get(*, zone_id, **params) -> Configuration

Discovery

Types:

from cloudflare.types.api_gateway import DiscoveryOperation, DiscoveryGetResponse

Methods:

• client.api_gateway.discovery.get(*, zone_id) -> DiscoveryGetResponse

Operations

Types:

from cloudflare.types.api_gateway.discovery import OperationBulkEditResponse, OperationEditResponse

Methods:

• client.api_gateway.discovery.operations.list(*, zone_id, **params) -> SyncV4PagePaginationArray[DiscoveryOperation]
• client.api_gateway.discovery.operations.bulk_edit(*, zone_id, **params) -> OperationBulkEditResponse
• client.api_gateway.discovery.operations.edit(operation_id, *, zone_id, **params) -> OperationEditResponse

Labels

Types:

from cloudflare.types.api_gateway import LabelListResponse

Methods:

• client.api_gateway.labels.list(*, zone_id, **params) -> SyncV4PagePaginationArray[LabelListResponse]

User

Types:

from cloudflare.types.api_gateway.labels import (
    UserUpdateResponse,
    UserDeleteResponse,
    UserBulkCreateResponse,
    UserBulkDeleteResponse,
    UserEditResponse,
    UserGetResponse,
)

Methods:

• client.api_gateway.labels.user.update(name, *, zone_id, **params) -> UserUpdateResponse
• client.api_gateway.labels.user.delete(name, *, zone_id) -> UserDeleteResponse
• client.api_gateway.labels.user.bulk_create(*, zone_id, **params) -> SyncSinglePage[UserBulkCreateResponse]
• client.api_gateway.labels.user.bulk_delete(*, zone_id) -> SyncSinglePage[UserBulkDeleteResponse]
• client.api_gateway.labels.user.edit(name, *, zone_id, **params) -> UserEditResponse
• client.api_gateway.labels.user.get(name, *, zone_id, **params) -> UserGetResponse

Resources

Operation

Types:

from cloudflare.types.api_gateway.labels.user.resources import OperationUpdateResponse

Methods:

• client.api_gateway.labels.user.resources.operation.update(name, *, zone_id, **params) -> OperationUpdateResponse

Managed

Types:

from cloudflare.types.api_gateway.labels import ManagedGetResponse

Methods:

• client.api_gateway.labels.managed.get(name, *, zone_id, **params) -> ManagedGetResponse

Resources

Operation

Types:

from cloudflare.types.api_gateway.labels.managed.resources import OperationUpdateResponse

Methods:

• client.api_gateway.labels.managed.resources.operation.update(name, *, zone_id, **params) -> OperationUpdateResponse

Operations

Types:

from cloudflare.types.api_gateway import (
    APIShield,
    OperationCreateResponse,
    OperationListResponse,
    OperationDeleteResponse,
    OperationBulkCreateResponse,
    OperationBulkDeleteResponse,
    OperationGetResponse,
)

Methods:

• client.api_gateway.operations.create(*, zone_id, **params) -> OperationCreateResponse
• client.api_gateway.operations.list(*, zone_id, **params) -> SyncV4PagePaginationArray[OperationListResponse]
• client.api_gateway.operations.delete(operation_id, *, zone_id) -> OperationDeleteResponse
• client.api_gateway.operations.bulk_create(*, zone_id, **params) -> SyncSinglePage[OperationBulkCreateResponse]
• client.api_gateway.operations.bulk_delete(*, zone_id) -> OperationBulkDeleteResponse
• client.api_gateway.operations.get(operation_id, *, zone_id, **params) -> OperationGetResponse

Labels

Types:

from cloudflare.types.api_gateway.operations import (
    LabelCreateResponse,
    LabelUpdateResponse,
    LabelDeleteResponse,
    LabelBulkCreateResponse,
    LabelBulkDeleteResponse,
    LabelBulkUpdateResponse,
)

Methods:

• client.api_gateway.operations.labels.create(operation_id, *, zone_id, **params) -> LabelCreateResponse
• client.api_gateway.operations.labels.update(operation_id, *, zone_id, **params) -> LabelUpdateResponse
• client.api_gateway.operations.labels.delete(operation_id, *, zone_id) -> LabelDeleteResponse
• client.api_gateway.operations.labels.bulk_create(*, zone_id, **params) -> SyncSinglePage[LabelBulkCreateResponse]
• client.api_gateway.operations.labels.bulk_delete(*, zone_id) -> SyncSinglePage[LabelBulkDeleteResponse]
• client.api_gateway.operations.labels.bulk_update(*, zone_id, **params) -> SyncSinglePage[LabelBulkUpdateResponse]

SchemaValidation

Types:

from cloudflare.types.api_gateway.operations import (
    SettingsMultipleRequest,
    SchemaValidationUpdateResponse,
    SchemaValidationGetResponse,
)

Methods:

• client.api_gateway.operations.schema_validation.update(operation_id, *, zone_id, **params) -> SchemaValidationUpdateResponse
• client.api_gateway.operations.schema_validation.edit(*, zone_id, **params) -> SettingsMultipleRequest
• client.api_gateway.operations.schema_validation.get(operation_id, *, zone_id) -> SchemaValidationGetResponse

Schemas

Types:

from cloudflare.types.api_gateway import SchemaListResponse

Methods:

• client.api_gateway.schemas.list(*, zone_id, **params) -> SchemaListResponse

Settings

Types:

from cloudflare.types.api_gateway import Settings

SchemaValidation

Methods:

• client.api_gateway.settings.schema_validation.update(*, zone_id, **params) -> Settings
• client.api_gateway.settings.schema_validation.edit(*, zone_id, **params) -> Settings
• client.api_gateway.settings.schema_validation.get(*, zone_id) -> Settings

UserSchemas

Types:

from cloudflare.types.api_gateway import (
    Message,
    OldPublicSchema,
    UserSchemaCreateResponse,
    UserSchemaDeleteResponse,
)

Methods:

• client.api_gateway.user_schemas.create(*, zone_id, **params) -> UserSchemaCreateResponse
• client.api_gateway.user_schemas.list(*, zone_id, **params) -> SyncV4PagePaginationArray[OldPublicSchema]
• client.api_gateway.user_schemas.delete(schema_id, *, zone_id) -> UserSchemaDeleteResponse
• client.api_gateway.user_schemas.edit(schema_id, *, zone_id, **params) -> OldPublicSchema
• client.api_gateway.user_schemas.get(schema_id, *, zone_id, **params) -> OldPublicSchema

Operations

Types:

from cloudflare.types.api_gateway.user_schemas import OperationListResponse

Methods:

• client.api_gateway.user_schemas.operations.list(schema_id, *, zone_id, **params) -> SyncV4PagePaginationArray[OperationListResponse]

Hosts

Types:

from cloudflare.types.api_gateway.user_schemas import HostListResponse

Methods:

• client.api_gateway.user_schemas.hosts.list(*, zone_id, **params) -> SyncV4PagePaginationArray[HostListResponse]

ExpressionTemplate

Fallthrough

Types:

from cloudflare.types.api_gateway.expression_template import FallthroughCreateResponse

Methods:

• client.api_gateway.expression_template.fallthrough.create(*, zone_id, **params) -> FallthroughCreateResponse