API Gateway
API GatewayConfigurations
Retrieve information about specific configuration properties
Update configuration properties
ModelsExpand Collapse
Configuration object { auth_id_characteristics }
auth_id_characteristics: array of object { name, type } or object { name, type }
APIShieldAuthIDCharacteristicJWTClaim object { name, type } Auth ID Characteristic extracted from JWT Token Claims
Auth ID Characteristic extracted from JWT Token Claims
Claim location expressed as $(token_config_id):$(json_path), where token_config_id
is the ID of the token configuration used in validating the JWT, and json_path is a RFC 9535
JSONPath (https://goessner.net/articles/JsonPath/, https://www.rfc-editor.org/rfc/rfc9535.html).
The JSONPath expression may be in dot or bracket notation, may only specify literal keys
or array indexes, and must return a singleton value, which will be interpreted as a string.
API GatewayDiscovery
Retrieve discovered operations on a zone rendered as OpenAPI schemas
ModelsExpand Collapse
DiscoveryOperation object { id, endpoint, host, 5 more }
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/.
origin: array of "ML" or "SessionIdentifier" or "LabelDiscovery"API discovery engine(s) that discovered this operation
API discovery engine(s) that discovered this operation
state: "review" or "saved" or "ignored"State of operation in API Discovery
review - Operation is not saved into API Shield Endpoint Managementsaved - Operation is saved into API Shield Endpoint Managementignored - Operation is marked as ignored
State of operation in API Discovery
review- Operation is not saved into API Shield Endpoint Managementsaved- Operation is saved into API Shield Endpoint Managementignored- Operation is marked as ignored
API GatewayDiscoveryOperations
Retrieve discovered operations on a zone
Patch discovered operation
Patch discovered operations
ModelsExpand Collapse
API GatewayLabels
Retrieve all labels
API GatewayLabelsUser
Create user labels
Delete user labels
Retrieve user label
Update user label
Patch user label
Delete user label
ModelsExpand Collapse
API GatewayLabelsUserResources
API GatewayLabelsUserResourcesOperation
Replace operation(s) attached to a user label
API GatewayLabelsManaged
Retrieve managed label
API GatewayLabelsManagedResources
API GatewayLabelsManagedResourcesOperation
Replace operation(s) attached to a managed label
API GatewayOperations
Retrieve information about all operations on a zone
Retrieve information about an operation
Add one operation to a zone
Delete an operation
Add operations to a zone
Delete multiple operations
ModelsExpand Collapse
APIShield object { endpoint, host, last_updated, 2 more }
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/.
OperationListResponse object { endpoint, host, last_updated, 3 more }
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/.
features: optional object { thresholds } or object { parameter_schemas } or object { api_routing } or 2 more
APIShieldOperationFeatureThresholds object { thresholds }
APIShieldOperationFeatureParameterSchemas object { parameter_schemas }
APIShieldOperationFeatureConfidenceIntervals object { confidence_intervals }
confidence_intervals: optional object { last_updated, suggested_threshold }
APIShieldOperationFeatureSchemaInfo object { schema_info }
OperationGetResponse object { endpoint, host, last_updated, 3 more }
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/.
features: optional object { thresholds } or object { parameter_schemas } or object { api_routing } or 2 more
APIShieldOperationFeatureThresholds object { thresholds }
APIShieldOperationFeatureParameterSchemas object { parameter_schemas }
APIShieldOperationFeatureConfidenceIntervals object { confidence_intervals }
confidence_intervals: optional object { last_updated, suggested_threshold }
APIShieldOperationFeatureSchemaInfo object { schema_info }
OperationCreateResponse object { endpoint, host, last_updated, 3 more }
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/.
features: optional object { thresholds } or object { parameter_schemas } or object { api_routing } or 2 more
APIShieldOperationFeatureThresholds object { thresholds }
APIShieldOperationFeatureParameterSchemas object { parameter_schemas }
APIShieldOperationFeatureConfidenceIntervals object { confidence_intervals }
confidence_intervals: optional object { last_updated, suggested_threshold }
APIShieldOperationFeatureSchemaInfo object { schema_info }
OperationBulkCreateResponse object { endpoint, host, last_updated, 3 more }
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/.
features: optional object { thresholds } or object { parameter_schemas } or object { api_routing } or 2 more
APIShieldOperationFeatureThresholds object { thresholds }
APIShieldOperationFeatureParameterSchemas object { parameter_schemas }
APIShieldOperationFeatureConfidenceIntervals object { confidence_intervals }
confidence_intervals: optional object { last_updated, suggested_threshold }
APIShieldOperationFeatureSchemaInfo object { schema_info }
API GatewayOperationsLabels
Replace label(s) on an operation in endpoint management
Attach label(s) on an operation in endpoint management
Remove label(s) on an operation in endpoint management
Bulk replace label(s) on operation(s) in endpoint management
Bulk attach label(s) on operation(s) in endpoint management
Bulk remove label(s) on operation(s) in endpoint management
ModelsExpand Collapse
LabelUpdateResponse object { endpoint, host, last_updated, 3 more }
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/.
LabelCreateResponse object { endpoint, host, last_updated, 3 more }
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/.
LabelDeleteResponse object { endpoint, host, last_updated, 3 more }
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/.
LabelBulkUpdateResponse object { endpoint, host, last_updated, 3 more }
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/.
LabelBulkCreateResponse object { endpoint, host, last_updated, 3 more }
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/.
LabelBulkDeleteResponse object { endpoint, host, last_updated, 3 more }
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/.
API GatewayOperationsSchema Validation
Retrieve operation-level schema validation settings
Update operation-level schema validation settings
Update multiple operation-level schema validation settings
ModelsExpand Collapse
SettingsMultipleRequest = map[object { mitigation_action } ]
mitigation_action: optional "log" or "block" or "none"When set, this applies a mitigation action to this operation
log log request when request does not conform to schema for this operationblock deny access to the site when request does not conform to schema for this operationnone will skip mitigation for this operationnull indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied
When set, this applies a mitigation action to this operation
loglog request when request does not conform to schema for this operationblockdeny access to the site when request does not conform to schema for this operationnonewill skip mitigation for this operationnullindicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied
SchemaValidationGetResponse object { mitigation_action, operation_id }
mitigation_action: optional "log" or "block" or "none"When set, this applies a mitigation action to this operation
log log request when request does not conform to schema for this operationblock deny access to the site when request does not conform to schema for this operationnone will skip mitigation for this operationnull indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied
When set, this applies a mitigation action to this operation
loglog request when request does not conform to schema for this operationblockdeny access to the site when request does not conform to schema for this operationnonewill skip mitigation for this operationnullindicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied
SchemaValidationUpdateResponse object { mitigation_action, operation_id }
mitigation_action: optional "log" or "block" or "none"When set, this applies a mitigation action to this operation
log log request when request does not conform to schema for this operationblock deny access to the site when request does not conform to schema for this operationnone will skip mitigation for this operationnull indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied
When set, this applies a mitigation action to this operation
loglog request when request does not conform to schema for this operationblockdeny access to the site when request does not conform to schema for this operationnonewill skip mitigation for this operationnullindicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied
API GatewaySchemas
Retrieve operations and features as OpenAPI schemas
API GatewaySettings
ModelsExpand Collapse
Settings object { validation_default_mitigation_action, validation_override_mitigation_action }
validation_default_mitigation_action: optional "none" or "log" or "block"The default mitigation action used when there is no mitigation action defined on the operation
Mitigation actions are as follows:
log - log request when request does not conform to schemablock - deny access to the site when request does not conform to schema
A special value of of none will skip running schema validation entirely for the request when there is no mitigation action defined on the operation
The default mitigation action used when there is no mitigation action defined on the operation
Mitigation actions are as follows:
log- log request when request does not conform to schemablock- deny access to the site when request does not conform to schema
A special value of of none will skip running schema validation entirely for the request when there is no mitigation action defined on the operation
API GatewaySettingsSchema Validation
Retrieve zone level schema validation settings
Update zone level schema validation settings
Update zone level schema validation settings
API GatewayUser Schemas
Retrieve information about all schemas on a zone
Retrieve information about a specific schema on a zone
ModelsExpand Collapse
UserSchemaCreateResponse object { schema, upload_details }
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.
Diagnostic warning events that occurred during processing. These events are non-critical errors found within the schema.
JSONPath location(s) in the schema where these events were encountered. See https://goessner.net/articles/JsonPath/ for JSONPath specification.
API GatewayUser SchemasOperations
Retrieve all operations from a schema.
ModelsExpand Collapse
OperationListResponse = object { endpoint, host, last_updated, 3 more } or object { endpoint, host, method }
APIShieldOperation object { endpoint, host, last_updated, 3 more }
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/.
features: optional object { thresholds } or object { parameter_schemas } or object { api_routing } or 2 more
APIShieldOperationFeatureThresholds object { thresholds }
APIShieldOperationFeatureParameterSchemas object { parameter_schemas }
APIShieldOperationFeatureConfidenceIntervals object { confidence_intervals }
confidence_intervals: optional object { last_updated, suggested_threshold }
APIShieldOperationFeatureSchemaInfo object { schema_info }
APIShieldBasicOperation object { endpoint, host, method }
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/.