ApiRequestBodyDescription

ApiRequestBodyDescription

Specification of the expected request body format, accepted content types, associated schemas, and requirement status for an operation.

JSON Example

{
    "description": "string",
    "failed_validation_request_body_action": "string",
    "mappings": [
        {
            "content_type": "string",
            "schema": {
                "max_value": "number",
                "min_value": "number",
                "schema_ref": "string",
                "string_enum_values": [
                    "string"
                ],
                "string_format": "string",
                "string_max_length": 0,
                "string_min_length": 0,
                "string_pattern": "string",
                "type": "string"
            }
        }
    ],
    "required": false,
    "unknown_content_type_action": "string"
}

string

description

Optional

Description of the request body from the OpenAPI specification. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

failed_validation_request_body_action

Optional

Constraints: default: API_ACTION_INHERIT_FROM_API_POLICY

Action on request body schema validation failures. Overrides the policy-level failed_validation_request_body_parameter_action when not INHERIT. 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.

array of ApiContentTypeMapping

mappings

Optional

Mapping of the content type to the request body schema. Field introduced in 32.1.4. Maximum of 128 items allowed. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean

required

Optional

Marks the request body as required. A missing body is treated as a violation; enforcement depends on the configured body validation actions. 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_INHERIT_FROM_API_POLICY

Action to take when the request body's content type is not defined for this endpoint. 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

ApiEndpoint