Updates zone level schema validation settings on the zone
/zones/{zone_id}/api_gateway/settings/schema_validation
put
API Shield Schema Validation 2.0
api-shield-schema-validation-update-zone-level-settings
null null [
{
"in": "path",
"name": "zone_id",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
}
] {
"content": {
"application/json": {
"schema": {
"properties": {
"validation_default_mitigation_action": {
"description": "The default mitigation action used when there is no mitigation action defined on the operation\n\nMitigation actions are as follows:\n\n * `log` - log request when request does not conform to schema\n * `block` - deny access to the site when request does not conform to schema\n\nA special value of of `none` will skip running schema validation entirely for the request when there is no mitigation action defined on the operation\n",
"enum": [
"none",
"log",
"block"
],
"example": "block",
"type": "string"
},
"validation_override_mitigation_action": {
"description": "When set, this overrides both zone level and operation level mitigation actions.\n\n - `none` will skip running schema validation entirely for the request\n - `null` indicates that no override is in place\n\nTo clear any override, use the special value `disable_override` or `null`\n",
"enum": [
"none",
"disable_override",
null
],
"example": "none",
"nullable": true,
"type": "string"
}
},
"required": [
"validation_default_mitigation_action"
],
"type": "object"
}
}
},
"required": true
} {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"validation_default_mitigation_action": {
"description": "The default mitigation action used when there is no mitigation action defined on the operation\n\nMitigation actions are as follows:\n\n * `log` - log request when request does not conform to schema\n * `block` - deny access to the site when request does not conform to schema\n\nA special value of of `none` will skip running schema validation entirely for the request when there is no mitigation action defined on the operation\n",
"enum": [
"none",
"log",
"block"
],
"example": "block",
"type": "string"
},
"validation_override_mitigation_action": {
"description": "When set, this overrides both zone level and operation level mitigation actions.\n\n - `none` will skip running schema validation entirely for the request\n - `null` indicates that no override is in place\n",
"enum": [
"none",
null
],
"example": "disable_override",
"nullable": true,
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Update zone level schema validation settings response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "Update zone level schema validation settings response failure"
}
} [
{
"api_email": [],
"api_key": []
}
]