Schema Validation

schema_validation

Schema Validation

Schemas

schema_validation.schemas

Methods

List All Uploaded Schemas -> V4PagePaginationArray<

PublicSchema

get/zones/{zone_id}/schema_validation/schemas

Lists all OpenAPI schemas uploaded to API Shield with pagination support.

Get Details Of A Schema -> Envelope<

PublicSchema

get/zones/{zone_id}/schema_validation/schemas/{schema_id}

Gets the contents and metadata of a specific OpenAPI schema uploaded to API Shield.

Upload A Schema -> Envelope<

PublicSchema

post/zones/{zone_id}/schema_validation/schemas

Uploads a new OpenAPI schema for API Shield schema validation. The schema defines expected request/response formats for API endpoints.

Edit Details Of A Schema To Enable Validation -> Envelope<

PublicSchema

patch/zones/{zone_id}/schema_validation/schemas/{schema_id}

Modifies an existing OpenAPI schema in API Shield, updating the validation rules for associated API operations.

Delete A Schema -> Envelope<{ id }>

delete/zones/{zone_id}/schema_validation/schemas/{schema_id}

Permanently removes an uploaded OpenAPI schema from API Shield. Operations using this schema will lose their validation rules.

Domain types

PublicSchema = { created_at, kind, name, 3 more... }

A schema used in schema validation

Schema Validation

Settings

schema_validation.settings

Methods

Get Global Schema Validation Settings -> Envelope<{ validation_default_mitigation_action, validation_override_mitigation_action }>

get/zones/{zone_id}/schema_validation/settings

Retrieves the current global schema validation settings for a zone.

Update Global Schema Validation Settings -> Envelope<{ validation_default_mitigation_action, validation_override_mitigation_action }>

put/zones/{zone_id}/schema_validation/settings

Fully updates global schema validation settings for a zone, replacing existing configuration.

Edit Global Schema Validation Settings -> Envelope<{ validation_default_mitigation_action, validation_override_mitigation_action }>

patch/zones/{zone_id}/schema_validation/settings

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

Schema Validation Settings

Operations

schema_validation.settings.operations

Methods

List Per Operation Schema Validation Settings -> V4PagePaginationArray<{ mitigation_action, operation_id }>

get/zones/{zone_id}/schema_validation/settings/operations

Lists all per-operation schema validation settings configured for the zone.

Get Per Operation Schema Validation Setting -> Envelope<{ mitigation_action, operation_id }>

get/zones/{zone_id}/schema_validation/settings/operations/{operation_id}

Retrieves the schema validation settings configured for a specific API operation.

Update Per Operation Schema Validation Setting -> Envelope<{ mitigation_action, operation_id }>

put/zones/{zone_id}/schema_validation/settings/operations/{operation_id}

Fully updates schema validation settings for a specific API operation.

Bulk Edit Per Operation Schema Validation Settings -> Envelope<Record<string, { mitigation_action, operation_id }>>

patch/zones/{zone_id}/schema_validation/settings/operations

Updates schema validation settings for multiple API operations in a single request. Efficient for applying consistent validation rules across endpoints.

Delete Per Operation Schema Validation Setting -> Envelope<{ operation_id }>

delete/zones/{zone_id}/schema_validation/settings/operations/{operation_id}

Removes custom schema validation settings for a specific API operation, reverting to zone-level defaults.