User Schemas

Retrieve information about all schemas on a zone

Deprecated

GET/zones/{zone_id}/api_gateway/user_schemas

Retrieve information about a specific schema on a zone

Deprecated

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

Upload a schema to a zone

Deprecated

POST/zones/{zone_id}/api_gateway/user_schemas

Enable validation for a schema

Deprecated

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

Delete a schema

Deprecated

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

ModelsExpand Collapse

Message = array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

OldPublicSchema = object { created_at, kind, name, 3 more }

created_at: string

formatdate-time

kind: "openapi_v3"

Kind of schema

Name of the schema

schema_id: string

UUID.

maxLength36

minLength36

source: optional string

Source of the schema

validation_enabled: optional boolean

Flag whether schema is enabled for validation.

UserSchemaCreateResponse = object { schema, upload_details }

schema: OldPublicSchema { created_at, kind, name, 3 more }

upload_details: optional object { warnings }

warnings: optional array of object { code, locations, message }

Diagnostic warning events that occurred during processing. These events are non-critical errors found within the schema.

code: number

Code that identifies the event that occurred.

locations: optional array of string

JSONPath location(s) in the schema where these events were encountered. See https://goessner.net/articles/JsonPath/ for JSONPath specification.

message: optional string

Diagnostic message that describes the event.

UserSchemaDeleteResponse = object { errors, messages, success }

errors: Message { code, message, documentation_url, source }

messages: Message { code, message, documentation_url, source }

success: true

Whether the API call was successful.

User SchemasOperations

Retrieve all operations from a schema.

Deprecated

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

ModelsExpand Collapse

OperationListResponse = object { endpoint, host, last_updated, 3 more } or object { endpoint, host, method }

One of the following:

APIShieldOperation = object { endpoint, host, last_updated, 3 more }

endpoint: string

The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/.

formaturi-template

maxLength4096

host: string

RFC3986-compliant host.

formathostname

maxLength255

last_updated: string

formatdate-time

method: "GET" or "POST" or "HEAD" or 6 more

The HTTP method used to access the endpoint.

One of the following:

"GET"

"POST"

"HEAD"

"OPTIONS"

"PUT"

"DELETE"

"CONNECT"

"PATCH"

"TRACE"

operation_id: string

UUID.

maxLength36

minLength36

features: optional object { thresholds } or object { parameter_schemas } or object { api_routing } or 2 more

One of the following:

APIShieldOperationFeatureThresholds = object { thresholds }

thresholds: optional object { auth_id_tokens, data_points, last_updated, 6 more }

auth_id_tokens: optional number

The total number of auth-ids seen across this calculation.

data_points: optional number

The number of data points used for the threshold suggestion calculation.

last_updated: optional string

formatdate-time

p50: optional number

The p50 quantile of requests (in period_seconds).

p90: optional number

The p90 quantile of requests (in period_seconds).

p99: optional number

The p99 quantile of requests (in period_seconds).

period_seconds: optional number

The period over which this threshold is suggested.

requests: optional number

The estimated number of requests covered by these calculations.

suggested_threshold: optional number

The suggested threshold in requests done by the same auth_id or period_seconds.

APIShieldOperationFeatureParameterSchemas = object { parameter_schemas }

parameter_schemas: object { last_updated, parameter_schemas }

last_updated: optional string

formatdate-time

parameter_schemas: optional object { parameters, responses }

An operation schema object containing a response.

parameters: optional array of unknown

An array containing the learned parameter schemas.

responses: optional unknown

An empty response object. This field is required to yield a valid operation schema.

APIShieldOperationFeatureAPIRouting = object { api_routing }

api_routing: optional object { last_updated, route }

API Routing settings on endpoint.

last_updated: optional string

formatdate-time

route: optional string

Target route.

APIShieldOperationFeatureConfidenceIntervals = object { confidence_intervals }

confidence_intervals: optional object { last_updated, suggested_threshold }

last_updated: optional string

formatdate-time

suggested_threshold: optional object { confidence_intervals, mean }

confidence_intervals: optional object { p90, p95, p99 }

p90: optional object { lower, upper }

Upper and lower bound for percentile estimate

lower: optional number

Lower bound for percentile estimate

upper: optional number

Upper bound for percentile estimate

p95: optional object { lower, upper }

Upper and lower bound for percentile estimate

lower: optional number

Lower bound for percentile estimate

upper: optional number

Upper bound for percentile estimate

p99: optional object { lower, upper }

Upper and lower bound for percentile estimate

lower: optional number

Lower bound for percentile estimate

upper: optional number

Upper bound for percentile estimate

mean: optional number

Suggested threshold.

APIShieldOperationFeatureSchemaInfo = object { schema_info }

schema_info: optional object { active_schema, learned_available, mitigation_action }

active_schema: optional object { id, created_at, is_learned, name }

Schema active on endpoint.

id: optional string

UUID.

maxLength36

minLength36

created_at: optional string

formatdate-time

is_learned: optional boolean

True if schema is Cloudflare-provided.

Schema file name.

learned_available: optional boolean

True if a Cloudflare-provided learned schema is available for this endpoint.

mitigation_action: optional "none" or "log" or "block"

Action taken on requests failing validation.

One of the following:

"none"

"log"

"block"

APIShieldBasicOperation = object { endpoint, host, method }

endpoint: string

formaturi-template

maxLength4096

host: string

RFC3986-compliant host.

formathostname

maxLength255

method: "GET" or "POST" or "HEAD" or 6 more

The HTTP method used to access the endpoint.

One of the following:

"GET"

"POST"

"HEAD"

"OPTIONS"

"PUT"

"DELETE"

"CONNECT"

"PATCH"

"TRACE"

User SchemasHosts

Retrieve schema hosts in a zone

Deprecated

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

ModelsExpand Collapse

HostListResponse = object { created_at, hosts, name, schema_id }

created_at: string

formatdate-time

hosts: array of string

Hosts serving the schema, e.g zone.host.com

Name of the schema

schema_id: string

UUID.

maxLength36

minLength36