api-shield_operation_feature_schema_info

APIs.ioEngineeringPlatform

Properties

Name Type Description
schema_info object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-api-shield-operation-feature-schema-info-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api-shield_operation_feature_schema_info",
  "title": "api-shield_operation_feature_schema_info",
  "properties": {
    "schema_info": {
      "properties": {
        "active_schema": {
          "description": "Schema active on endpoint.",
          "properties": {
            "created_at": {
              "$ref": "#/components/schemas/api-shield_timestamp"
            },
            "id": {
              "$ref": "#/components/schemas/api-shield_schemas-uuid"
            },
            "is_learned": {
              "description": "True if schema is Cloudflare-provided.",
              "example": true,
              "type": "boolean"
            },
            "name": {
              "description": "Schema file name.",
              "example": "api-endpoints-8694824bf5c04d019edcbf399c03c103-api-discovery.example.com-thresholds.json",
              "type": "string"
            }
          },
          "type": "object"
        },
        "learned_available": {
          "description": "True if a Cloudflare-provided learned schema is available for this endpoint.",
          "example": true,
          "type": "boolean"
        },
        "mitigation_action": {
          "description": "Action taken on requests failing validation.",
          "enum": [
            "none",
            "log",
            "block"
          ],
          "example": "block",
          "nullable": true,
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "readOnly": true,
  "type": "object"
}