Cloudflare API | API Gateway › Operations › Add Operations To A Zone

Add one or more operations to a zone. Endpoints can contain path variables. Host, method, endpoint will be normalized to a canoncial form when creating an operation and must be unique on the zone. Inserting an operation that matches an existing one will return the record of the already existing operation and update its last_updated date.

Security

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Parameters

zone_id: string

Identifier

Response fields

errors:

Message

messages:

Message

result: Array<{ endpoint, host, last_updated, 3 more... }>

success: true

Whether the API call was successful

Request example

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/api_gateway/operations \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '[
      {
        "endpoint": "/api/v1/users/{var1}",
        "host": "www.example.com",
        "method": "GET"
      }
    ]'

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "result": [
    {
      "endpoint": "/api/v1/users/{var1}",
      "host": "www.example.com",
      "last_updated": "2014-01-01T05:20:00.12345Z",
      "method": "GET",
      "operation_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "features": {
        "thresholds": {
          "auth_id_tokens": 0,
          "data_points": 0,
          "last_updated": "2014-01-01T05:20:00.12345Z",
          "p50": 0,
          "p90": 0,
          "p99": 0,
          "period_seconds": 0,
          "requests": 0,
          "suggested_threshold": 0
        }
      }
    }
  ],
  "success": true
}

Delete An Operation -> { errors, messages, success }

delete/zones/{zone_id}/api_gateway/operations/{operation_id}

Delete an operation

Retrieve Information About An Operation -> Envelope<{ endpoint, host, last_updated, 3 more... }>

get/zones/{zone_id}/api_gateway/operations/{operation_id}

Retrieve information about an operation

Retrieve Information About All Operations On A Zone -> V4PagePaginationArray<{ endpoint, host, last_updated, 3 more... }>

get/zones/{zone_id}/api_gateway/operations

Retrieve information about all operations on a zone

Domain types

APIShield = { endpoint, host, last_updated, 2 more... }

API Gateway Operations

Schema Validation

api_gateway.operations.schema_validation

Methods

Update Multiple Operation Level Schema Validation Settings -> Envelope<

SettingsMultipleRequest

patch/zones/{zone_id}/api_gateway/operations/schema_validation

Updates multiple operation-level schema validation settings on the zone

Retrieve Operation Level Schema Validation Settings -> { mitigation_action }

get/zones/{zone_id}/api_gateway/operations/{operation_id}/schema_validation

Retrieves operation-level schema validation settings on the zone

Update Operation Level Schema Validation Settings -> { mitigation_action }

put/zones/{zone_id}/api_gateway/operations/{operation_id}/schema_validation

Updates operation-level schema validation settings on the zone

Domain types

SettingsMultipleRequest = Record<string, { mitigation_action }>

API Gateway

Schemas

api_gateway.schemas

Methods

Retrieve Operations And Features As OpenAPI Schemas -> Envelope<{ schemas, timestamp }>

get/zones/{zone_id}/api_gateway/schemas

Retrieve operations and features as OpenAPI schemas

API Gateway

Settings

api_gateway.settings

Domain types

Settings = { validation_default_mitigation_action, validation_override_mitigation_action }

API Gateway Settings

Schema Validation

api_gateway.settings.schema_validation

Methods

Update Zone Level Schema Validation Settings ->

Settings

patch/zones/{zone_id}/api_gateway/settings/schema_validation

Updates zone level schema validation settings on the zone

Retrieve Zone Level Schema Validation Settings ->

Settings

get/zones/{zone_id}/api_gateway/settings/schema_validation

Retrieves zone level schema validation settings currently set on the zone

Update Zone Level Schema Validation Settings ->

Settings

put/zones/{zone_id}/api_gateway/settings/schema_validation

Updates zone level schema validation settings on the zone

API Gateway

User Schemas

api_gateway.user_schemas

Methods

Upload A Schema To A Zone -> Envelope<

SchemaUpload

post/zones/{zone_id}/api_gateway/user_schemas

Upload a schema to a zone

Delete A Schema -> { errors, messages, success }

delete/zones/{zone_id}/api_gateway/user_schemas/{schema_id}

Delete a schema

Enable Validation For A Schema -> Envelope<

PublicSchema

patch/zones/{zone_id}/api_gateway/user_schemas/{schema_id}

Enable validation for a schema

Retrieve Information About A Specific Schema On A Zone -> Envelope<

PublicSchema

get/zones/{zone_id}/api_gateway/user_schemas/{schema_id}

Retrieve information about a specific schema on a zone

Retrieve Information About All Schemas On A Zone -> V4PagePaginationArray<

PublicSchema

get/zones/{zone_id}/api_gateway/user_schemas

Retrieve information about all schemas on a zone

Domain types

Message = Array<

ResponseInfo

PublicSchema = { created_at, kind, name, 3 more... }

SchemaUpload = { schema, upload_details }

API Gateway User Schemas

Hosts

api_gateway.user_schemas.hosts

Methods

Retrieve Schema Hosts In A Zone -> V4PagePaginationArray<{ created_at, hosts, name, 1 more... }>

get/zones/{zone_id}/api_gateway/user_schemas/hosts

Retrieve schema hosts in a zone

API Gateway User Schemas

Operations

api_gateway.user_schemas.operations

Methods

Retrieve All Operations From A Schema -> V4PagePaginationArray<{ endpoint, host, last_updated, 3 more... } | { endpoint, host, method }>

get/zones/{zone_id}/api_gateway/user_schemas/{schema_id}/operations

Retrieves all operations from the schema. Operations that already exist in API Shield Endpoint Management will be returned as full operations.