Retrieve operation-level schema validation settings

client.apiGateway.operations.schemaValidation.get(, , ?): SchemaValidationGetResponse { mitigation_action, operation_id }

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

Retrieves operation-level schema validation settings on the zone

Security

API Token

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

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Account API GatewayAccount API Gateway ReadDomain API GatewayDomain API Gateway Read

ParametersExpand Collapse

operationId: string

UUID.

maxLength36

params: SchemaValidationGetParams { zone_id }

zone_id: string

Identifier.

maxLength32

ReturnsExpand Collapse

SchemaValidationGetResponse { mitigation_action, operation_id }

mitigation_action?: "log" | "block" | "none" | null

When set, this applies a mitigation action to this operation

log log request when request does not conform to schema for this operation
block deny access to the site when request does not conform to schema for this operation
none will skip mitigation for this operation
null indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied

One of the following:

"log"

"block"

"none"

operation_id?: string

UUID.

maxLength36

minLength36

Retrieve operation-level schema validation settings

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const schemaValidation = await client.apiGateway.operations.schemaValidation.get(
  'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
  { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
);

console.log(schemaValidation.operation_id);

{
  "mitigation_action": "block",
  "operation_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
}

Returns Examples

{
  "mitigation_action": "block",
  "operation_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
}