Apache APISIX · JSON Structure

Ssl Structure

An SSL resource stores SSL certificates and keys for HTTPS traffic.

Type: object Properties: 9 Required: 3
ApacheAPI GatewayCloud NativeKubernetesLuaNGINXOpen SourceTraffic Management

Apache APISIX SSL is a JSON Structure definition published by Apache APISIX, describing 9 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

cert key certs keys snis client labels status type

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-apisix/refs/heads/main/json-structure/ssl-structure.json",
  "name": "Apache APISIX SSL",
  "description": "An SSL resource stores SSL certificates and keys for HTTPS traffic.",
  "type": "object",
  "properties": {
    "cert": {
      "type": "string",
      "description": "PEM-encoded SSL certificate."
    },
    "key": {
      "type": "string",
      "description": "PEM-encoded private key."
    },
    "certs": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Additional PEM-encoded certificates for multiple certificates."
    },
    "keys": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Additional PEM-encoded private keys."
    },
    "snis": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Server Name Indication values to match."
    },
    "client": {
      "type": "object",
      "description": "mTLS client verification configuration.",
      "properties": {
        "ca": {
          "type": "string",
          "description": "PEM-encoded CA certificate for client verification."
        },
        "depth": {
          "type": "integer",
          "default": 1,
          "description": "Maximum length of the client certificate chain."
        }
      }
    },
    "labels": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Key-value pairs for categorization."
    },
    "status": {
      "type": "integer",
      "enum": [
        0,
        1
      ],
      "default": 1,
      "description": "SSL status. 1 for enabled, 0 for disabled."
    },
    "type": {
      "type": "string",
      "enum": [
        "server",
        "client"
      ],
      "default": "server",
      "description": "Identifies the type of certificate."
    }
  },
  "required": [
    "cert",
    "key",
    "snis"
  ]
}