Get per-operation schema validation setting

client.schemaValidation.settings.operations.get(, , ?): OperationGetResponse { mitigation_action, operation_id }

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

Retrieves the schema validation settings configured for a specific API operation.

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: OperationGetParams { zone_id }

zone_id: string

Identifier.

maxLength32

ReturnsExpand Collapse

OperationGetResponse { mitigation_action, operation_id }

mitigation_action: "log" | "block" | "none"

When set, this applies a mitigation action to this operation which supersedes a global schema validation setting just for 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

One of the following:

"log"

"block"

"none"

operation_id: string

UUID.

maxLength36

minLength36

Get per-operation schema validation setting

import Cloudflare from 'cloudflare';

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

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

console.log(operation.operation_id);

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "mitigation_action": "block",
    "operation_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "mitigation_action": "block",
    "operation_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  },
  "success": true
}