Akamai API Security · Schema

config-post

Specifies the details of a security config.

API DiscoveryAPI SecurityCloud SecurityPosture ManagementRuntime ProtectionThreat Protection

Properties

Name Type Description
contractId string Contract ID.
createFrom object Contains details about a source configuration and version for cloning a new security configuration.
description string Describes the security configuration.
groupId integer Group ID.
hostnames array List of hostnames to be added to the configuration.
name string The name you assigned to the security configuration.
View JSON Schema on GitHub

JSON Schema

api-security-config-post-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/akamai-api-security/refs/heads/main/json-schema/api-security-config-post-schema.json",
  "title": "config-post",
  "description": "Specifies the details of a security config.",
  "type": "object",
  "properties": {
    "contractId": {
      "description": "Contract ID.",
      "type": "string"
    },
    "createFrom": {
      "additionalProperties": false,
      "description": "Contains details about a source configuration and version for cloning a new security configuration.",
      "properties": {
        "configId": {
          "description": "Uniquely identifies the security configuration.",
          "type": "integer"
        },
        "version": {
          "description": "The configuration version to clone from.",
          "type": "integer"
        }
      },
      "required": [
        "configId",
        "version"
      ],
      "type": "object"
    },
    "description": {
      "description": "Describes the security configuration.",
      "type": "string"
    },
    "groupId": {
      "description": "Group ID.",
      "type": "integer"
    },
    "hostnames": {
      "description": "List of hostnames to be added to the configuration.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "name": {
      "description": "The name you assigned to the security configuration.",
      "type": "string"
    }
  },
  "required": [
    "name",
    "description",
    "hostnames"
  ],
  "additionalProperties": false
}