Akamai API Security · JSON Structure

Api Security Configs Get Structure

Specifies the details of a security config.

Type: object Properties: 1 Required: 1
API DiscoveryAPI SecurityCloud SecurityPosture ManagementRuntime ProtectionThreat Protection

configs-get is a JSON Structure definition published by Akamai API Security, describing 1 property, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

configurations

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/akamai-api-security/refs/heads/main/json-structure/api-security-configs-get-structure.json",
  "name": "configs-get",
  "description": "Specifies the details of a security config.",
  "type": "object",
  "properties": {
    "configurations": {
      "description": "A list of security configurations.",
      "items": {
        "additionalProperties": false,
        "description": "Contains details about a security configuration.",
        "properties": {
          "description": {
            "description": "__Read-only__ Describes the security configuration.",
            "readOnly": true,
            "type": "string"
          },
          "id": {
            "description": "__Read-only__ Uniquely identifies the security configuration.",
            "readOnly": true,
            "type": "int32"
          },
          "latestVersion": {
            "description": "__Read-only__ The latest version of the security configuration.",
            "readOnly": true,
            "type": "int32"
          },
          "name": {
            "description": "__Read-only__ The security configuration name.",
            "readOnly": true,
            "type": "string"
          },
          "productionHostnames": {
            "description": "__Read-only__ The list of hostnames protected by this security configuration in the production network.",
            "items": {
              "type": "string"
            },
            "readOnly": true,
            "type": "array"
          },
          "productionVersion": {
            "description": "__Read-only__ The latest security configuration version active in the production network.",
            "readOnly": true,
            "type": "int32"
          },
          "stagingVersion": {
            "description": "__Read-only__ The latest security configuration version active in the staging network.",
            "readOnly": true,
            "type": "int32"
          }
        },
        "required": [
          "id",
          "latestVersion",
          "name"
        ],
        "type": "object",
        "x-akamai": {
          "file-path": "schemas/config-get.yaml"
        }
      },
      "type": "array"
    }
  },
  "required": [
    "configurations"
  ],
  "additionalProperties": false
}