Search + K

Command Palette

Search for a command to run...

Sign In

Retrieve operation-level schema validation settings

Deprecated
GET /zones/{zone_id}/api_gateway/operations/{operation_id}/schema_validation
Copy endpoint
https://api.cloudflare.com/client/v4

Retrieves operation-level schema validation settings on the zone

Parameters

path Path Parameters

Name Type
zone_id required
type ApiShieldSchemasIdentifier = type ApiShieldIdentifier = string & string
operation_id required

Identifier for the operation

type ApiShieldUuid = string

Responses

200 application/json

Operation-level schema validation settings response

interface ApiShieldOperationSchemaValidationSettings {
mitigation_action?: ApiShieldOperationMitigationAction

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
type ApiShieldOperationMitigationAction = "log" | "block" | "none" | null
;
operation_id?: ApiShieldSchemasUuid
type ApiShieldSchemasUuid = string & ApiShieldUuid
;
}

Client Errors

4XX application/json

Operation-level schema validation settings response

interface ApiShieldApiResponseCommonFailure {
errors: ApiShieldMessages
type ApiShieldMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}
[]
;
messages: ApiShieldMessages
type ApiShieldMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}
[]
;
result: null;
success: false;
}