schemas_operations

Creates, updates, deletes, gets or lists a schemas_operations resource.

Overview

Name	schemas_operations
Type	Resource
Id	cloudflare.schema_validation.schemas_operations

Fields

The following fields are returned by SELECT queries:

list_by_zone

All operations in the schema

Name	Datatype	Description
operation_id	string	UUID. (example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415)
endpoint	string (uri-template)	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/. (example: /api/v1/users/{var1})
features	object
host	string (hostname)	RFC3986-compliant host. (example: www.example.com)
last_updated	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)
method	string	The HTTP method used to access the endpoint. (GET, POST, HEAD, OPTIONS, PUT, DELETE, CONNECT, PATCH, TRACE) (example: GET)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_zone	select	zone_id, schema_id	feature, host, method, endpoint, page, per_page, operation_status	Retrieves all operations from the schema. Operations that already exist in API Shield Endpoint Management will be returned as full operations.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
schema_id	string (uuid)	The unique identifier of the schema
zone_id	string	The Cloudflare zone ID.
endpoint	string
feature	array	Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
host	array
method	array
operation_status	string	Filter results by whether operations exist in Web Asset Management or not. new will just return operations from the schema that do not exist otherwise. existing will just return operations from the schema that already exist.
page	integer	Page number of paginated results.
per_page	integer	Maximum number of results per page.

SELECT examples

list_by_zone

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

SELECT
operation_id,
endpoint,
features,
host,
last_updated,
method
FROM cloudflare.schema_validation.schemas_operations
WHERE zone_id = '{{ zone_id }}' -- required
AND schema_id = '{{ schema_id }}' -- required
AND feature = '{{ feature }}'
AND host = '{{ host }}'
AND method = '{{ method }}'
AND endpoint = '{{ endpoint }}'
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
AND operation_status = '{{ operation_status }}'
;