ApiValidationSettings

ApiValidationSettings
ApiValidationSettings

Default validation actions enforced when requests or responses violate policy specifications. These actions can be overridden at the path or endpoint level.

JSON Example
{
    "failed_validation_header_parameter_action": "string",
    "failed_validation_path_parameter_action": "string",
    "failed_validation_query_argument_action": "string",
    "failed_validation_request_body_parameter_action": "string",
    "missing_mandatory_header_parameter_action": "string",
    "missing_mandatory_query_argument_action": "string",
    "missing_mandatory_request_body_parameter_action": "string",
    "request_outside_path_prefix_action": "string",
    "unexpected_query_argument_action": "string",
    "unexpected_request_body_parameter_action": "string",
    "unexpected_request_header_action": "string",
    "unknown_content_type_action": "string",
    "unknown_http_method_action": "string",
    "unknown_path_action": "string",
    "unknown_response_content_type_action": "string",
    "unknown_response_status_code_action": "string"
}
string
failed_validation_header_parameter_action
Optional
Constraints: default: API_ACTION_FLAG

Action to take when a header parameter fails schema validation. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
failed_validation_path_parameter_action
Optional
Constraints: default: API_ACTION_FLAG

Action to take when a path parameter fails schema validation. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
failed_validation_query_argument_action
Optional
Constraints: default: API_ACTION_FLAG

Action to take when a query argument fails schema validation. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
failed_validation_request_body_parameter_action
Optional
Constraints: default: API_ACTION_FLAG

Action to take when the request body fails schema validation. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
missing_mandatory_header_parameter_action
Optional
Constraints: default: API_ACTION_FLAG

Action to take when a mandatory header parameter is missing. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
missing_mandatory_query_argument_action
Optional
Constraints: default: API_ACTION_FLAG

Action to take when a mandatory query argument is missing. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
missing_mandatory_request_body_parameter_action
Optional
Constraints: default: API_ACTION_FLAG

Action to take when a mandatory request body parameter is missing. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
request_outside_path_prefix_action
Optional
Constraints: default: API_ACTION_PASS

Action to take when a request does not match any server URL defined in this policy. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
unexpected_query_argument_action
Optional
Constraints: default: API_ACTION_FLAG

Action to take when a query argument is present but not defined in the schema. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
unexpected_request_body_parameter_action
Optional
Constraints: default: API_ACTION_FLAG

Action to take when a request body parameter is present but not defined in the schema. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
unexpected_request_header_action
Optional
Constraints: default: API_ACTION_PASS

Action to take when a header parameter is present but not defined in the schema. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
unknown_content_type_action
Optional
Constraints: default: API_ACTION_PASS

Action to take on an unknown request content type, can be overridden per path. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
unknown_http_method_action
Optional
Constraints: default: API_ACTION_FLAG

Action to take when a request matches a defined path but uses an HTTP method not defined for that path. Can be overridden per path. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
unknown_path_action
Optional
Constraints: default: API_ACTION_FLAG

Action to take when a request matches a server URL but does not match any defined API path. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
unknown_response_content_type_action
Optional
Constraints: default: API_ACTION_FLAG

Action to take on unknown response content type, can be overridden per path. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
unknown_response_status_code_action
Optional
Constraints: default: API_ACTION_FLAG

Action to take on unknown response status code, can be overridden per path. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

Property Of