API Reference

API Gateway

Operations

Schema Validation

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Retrieve operation-level schema validation settings

Deprecated

client.APIGateway.Operations.SchemaValidation.Get(ctx, operationID, query) (*OperationSchemaValidationGetResponse, error)

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

query OperationSchemaValidationGetParams

ZoneID param.Field[string]

Identifier.

maxLength32

ReturnsExpand Collapse

type OperationSchemaValidationGetResponse struct{…}

MitigationAction OperationSchemaValidationGetResponseMitigationActionoptional

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:

const OperationSchemaValidationGetResponseMitigationActionLog OperationSchemaValidationGetResponseMitigationAction = "log"

const OperationSchemaValidationGetResponseMitigationActionBlock OperationSchemaValidationGetResponseMitigationAction = "block"

const OperationSchemaValidationGetResponseMitigationActionNone OperationSchemaValidationGetResponseMitigationAction = "none"

OperationID stringoptional

UUID.

maxLength36

minLength36

Retrieve operation-level schema validation settings

Go

HTTP

TypeScript

Python

Go

Terraform

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/api_gateway"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  schemaValidation, err := client.APIGateway.Operations.SchemaValidation.Get(
    context.TODO(),
    "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    api_gateway.OperationSchemaValidationGetParams{
      ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", schemaValidation.OperationID)
}

200 example

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

Returns Examples

200 example

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