Edit global schema validation settings

client.SchemaValidation.Settings.Edit(ctx, params) (*SettingEditResponse, error)

PATCH/zones/{zone_id}/schema_validation/settings

Partially updates global schema validation settings for a zone using PATCH semantics.

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 GatewayDomain API Gateway

ParametersExpand Collapse

params SettingEditParams

ZoneID param.Field[string]

Path param: Identifier.

maxLength32

ValidationDefaultMitigationAction param.Field[SettingEditParamsValidationDefaultMitigationAction]optional

Body param: The default mitigation action used Mitigation actions are as follows:

"log" - log request when request does not conform to schema
"block" - deny access to the site when request does not conform to schema
"none" - skip running schema validation

const SettingEditParamsValidationDefaultMitigationActionNone SettingEditParamsValidationDefaultMitigationAction = "none"

const SettingEditParamsValidationDefaultMitigationActionLog SettingEditParamsValidationDefaultMitigationAction = "log"

const SettingEditParamsValidationDefaultMitigationActionBlock SettingEditParamsValidationDefaultMitigationAction = "block"

ValidationOverrideMitigationAction param.Field[SettingEditParamsValidationOverrideMitigationAction]optional

Body param: When set, this overrides both zone level and operation level mitigation actions.

"none" - skip running schema validation entirely for the request
null - clears any existing override

const SettingEditParamsValidationOverrideMitigationActionNone SettingEditParamsValidationOverrideMitigationAction = "none"

ReturnsExpand Collapse

type SettingEditResponse struct{…}

ValidationDefaultMitigationAction SettingEditResponseValidationDefaultMitigationAction

The default mitigation action used

Mitigation actions are as follows:

log - log request when request does not conform to schema
block - deny access to the site when request does not conform to schema
none - skip running schema validation

One of the following:

const SettingEditResponseValidationDefaultMitigationActionNone SettingEditResponseValidationDefaultMitigationAction = "none"

const SettingEditResponseValidationDefaultMitigationActionLog SettingEditResponseValidationDefaultMitigationAction = "log"

const SettingEditResponseValidationDefaultMitigationActionBlock SettingEditResponseValidationDefaultMitigationAction = "block"

ValidationOverrideMitigationAction SettingEditResponseValidationOverrideMitigationActionoptional

When not null, this overrides global both zone level and operation level mitigation actions. This can serve as a quick way to disable schema validation for the whole zone.

"none" will skip running schema validation entirely for the request

Edit global schema validation settings

package main

import (
  "context"
  "fmt"

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

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  response, err := client.SchemaValidation.Settings.Edit(context.TODO(), schema_validation.SettingEditParams{
    ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.ValidationDefaultMitigationAction)
}

{
  "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": {
    "validation_default_mitigation_action": "block",
    "validation_override_mitigation_action": "none"
  },
  "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": {
    "validation_default_mitigation_action": "block",
    "validation_override_mitigation_action": "none"
  },
  "success": true
}