Cloudflare API | API Gateway › Discovery › Operations › Retrieve Discovered Operations On A Zone

ML - Discovered operations that were sourced using ML API Discovery
SessionIdentifier - Discovered operations that were sourced using Session Identifier API Discovery

"ML"

"SessionIdentifier"

page: number

Optional

(minimum: 1)

Page number of paginated results.

per_page: number

Optional

(maximum: 50, minimum: 5)

Maximum number of results per page.

state:

Optional

Filter results to only include discovery results in a particular state. States are as follows

review - Discovered operations that are not saved into API Shield Endpoint Management
saved - Discovered operations that are already saved into API Shield Endpoint Management
ignored - Discovered operations that have been marked as ignored

"review"

"saved"

"ignored"

Response fields

errors:

Message

messages:

Message

result: Array<

DiscoveryOperation

success: true

Whether the API call was successful

result_info: { count, page, per_page, 1 more... }

Optional

Request example

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/api_gateway/discovery/operations \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "result": [
    {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "endpoint": "/api/v1/users/{var1}",
      "host": "www.example.com",
      "last_updated": "2014-01-01T05:20:00.12345Z",
      "method": "GET",
      "origin": [
        "ML"
      ],
      "state": "review",
      "features": {
        "traffic_stats": {
          "last_updated": "2014-01-01T05:20:00.12345Z",
          "period_seconds": 3600,
          "requests": 1987.06
        }
      }
    }
  ],
  "success": true,
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}

API Gateway

Expression Template

api_gateway.expression_template

API Gateway Expression Template

Fallthrough

api_gateway.expression_template.fallthrough

Methods

Generate Fallthrough WAF Expression Template From A Set Of API Hosts -> Envelope<{ expression, title }>

post/zones/{zone_id}/api_gateway/expression-template/fallthrough

Generate fallthrough WAF expression template from a set of API hosts

API Gateway

Operations

api_gateway.operations

Methods

Add Operations To A Zone -> Envelope<Array<{ endpoint, host, last_updated, 3 more... }>>

post/zones/{zone_id}/api_gateway/operations

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.

Delete Multiple Operations -> { errors, messages, success }

delete/zones/{zone_id}/api_gateway/operations

Delete multiple operations

Add One Operation To A Zone -> Envelope<{ endpoint, host, last_updated, 3 more... }>

post/zones/{zone_id}/api_gateway/operations/item

Add one operation 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.

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.