{ "components": { "headers": { "location-header": { "description": "The unique identifier for the newly created resource. Append this ID to a subsequent GET call to view the resource details.", "schema": { "example": 1100, "type": "integer" }, "x-akamai": { "file-path": "headers/location-header.yaml" } } }, "parameters": { "alias-id-path": { "description": "The ACL alias ID.", "in": "path", "name": "aliasId", "required": true, "schema": { "example": 2, "type": "integer" }, "x-akamai": { "file-path": "parameters/alias-id-path.yaml" } }, "details-query": { "description": "When set to `true`, returns parsed rule details for every rule in the rule set for a version.", "in": "query", "name": "details", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/details-query.yaml" } }, "index-path": { "description": "The rule's index.", "in": "path", "name": "index", "required": true, "schema": { "example": 5, "type": "integer" }, "x-akamai": { "file-path": "parameters/index-path.yaml" } }, "ip-version-path": { "description": "The IP version, either `V4` or `V6`.", "in": "path", "name": "ipVersion", "required": true, "schema": { "enum": [ "V4", "V6" ], "example": "V4", "type": "string" }, "x-akamai": { "file-path": "parameters/ip-version-path.yaml" } }, "latest-query": { "description": "Returns the latest ACL versions for the account. If `true`, displays only ACL versions in `CONFIGURATION` and `DEPLOYED` states. If `false`, lists ACL versions in all states.", "in": "query", "name": "latest", "required": false, "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/latest-query.yaml" } }, "page-query": { "description": "Page number for pagination.", "in": "query", "name": "page", "required": false, "schema": { "example": 3, "type": "integer" }, "x-akamai": { "file-path": "parameters/page-query.yaml" } }, "size-query": { "description": "Number of items per page.", "in": "query", "name": "size", "required": false, "schema": { "example": 25, "type": "integer" }, "x-akamai": { "file-path": "parameters/size-query.yaml" } }, "sort-by-query": { "description": "ACL version content property to sort by. Either `accountId`, `version`, `description`, `state`, `rulesCount`, `createdBy`, `updatedBy`, `createdTimestamp`, or `updatedTimestamp`.", "in": "query", "name": "sortBy", "required": false, "schema": { "enum": [ "accountId", "version", "description", "state", "rulesCount", "createdBy", "updatedBy", "createdTimestamp", "updatedTimestamp" ], "example": "version", "type": "string" }, "x-akamai": { "file-path": "parameters/sort-by-query.yaml" } }, "sort-order-query": { "description": "The results sort order. Either `asc` (ascending) or `desc` (descending).", "in": "query", "name": "sortOrder", "required": false, "schema": { "enum": [ "asc", "desc" ], "example": "asc", "type": "string" }, "x-akamai": { "file-path": "parameters/sort-order-query.yaml" } }, "version-path": { "description": "The ACL version number.", "in": "path", "name": "version", "required": true, "schema": { "example": 15, "type": "integer" }, "x-akamai": { "file-path": "parameters/version-path.yaml" } } }, "responses": { "400-aliases": { "content": { "application/problem+json": { "examples": { "bad-request": { "summary": "Invalid operation", "value": { "$ref": "../examples/400-alias-invalid-operation.json" } }, "exceeds-limit": { "summary": "Exceeds limit", "value": { "$ref": "../examples/400-alias-exceeds-limit.json" } }, "field-missing": { "summary": "Field missing", "value": { "$ref": "../examples/400-field-missing.json" } }, "invalid-alias-count": { "summary": "Invalid count", "value": { "$ref": "../examples/400-alias-invalid-count.json" } }, "invalid-entries": { "summary": "Invalid entries", "value": { "$ref": "../examples/400-alias-invalid-entries.json" } } }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/network-cloud-firewall/reference/400).", "x-akamai": { "file-path": "errors/400-aliases.yaml" } }, "400-big-aliases": { "content": { "application/problem+json": { "examples": { "bad-request": { "summary": "Invalid operation", "value": { "$ref": "../examples/400-alias-invalid-operation.json" } }, "exceeds-limit": { "summary": "Exceeds limit", "value": { "$ref": "../examples/400-alias-exceeds-limit.json" } }, "file-missing": { "summary": "File missing", "value": { "$ref": "../examples/400-big-file-missing.json" } }, "invalid-alias-count": { "summary": "Invalid count", "value": { "$ref": "../examples/400-alias-invalid-count.json" } }, "invalid-entries": { "summary": "Invalid entries", "value": { "$ref": "../examples/400-alias-invalid-entries.json" } }, "parameter-missing": { "summary": "Parameter missing", "value": { "$ref": "../examples/400-big-param-missing.json" } } }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/network-cloud-firewall/reference/400).", "x-akamai": { "file-path": "errors/400-big-aliases.yaml" } }, "400-versions": { "content": { "application/problem+json": { "examples": { "any-not-allowed": { "summary": "Any Destination not allowed", "value": { "$ref": "../examples/400-versions-any-not-allowed.json" } }, "destination-not-allowed": { "summary": "Destination not allowed", "value": { "$ref": "../examples/400-versions-destination-not-allowed.json" } }, "duplicate-acl-text": { "summary": "ACL text duplicate", "value": { "$ref": "../examples/400-versions-duplicate-acl-text.json" } }, "field-invalid": { "summary": "Field invalid", "value": { "$ref": "../examples/400-versions-invalid-field.json" } }, "field-missing": { "summary": "Field missing", "value": { "$ref": "../examples/400-field-missing.json" } }, "invalid-acl-text": { "summary": "ACL text invalid", "value": { "$ref": "../examples/400-versions-invalid-acl-text.json" } }, "invalid-asn": { "summary": "ASN invalid", "value": { "$ref": "../examples/400-asn-invalid.json" } }, "version-config-exists": { "summary": "Version config already exists", "value": { "$ref": "../examples/400-versions-config-exists.json" } }, "version-invalid-index": { "summary": "Invalid version index", "value": { "$ref": "../examples/400-versions-invalid-index.json" } }, "version-limit-exceeded": { "summary": "Version exceeds limit", "value": { "$ref": "../examples/400-versions-exceeds-limit.json" } }, "versions-not-allowed": { "summary": "Versions not allowed", "value": { "$ref": "../examples/400-versions-not-allowed.json" } } }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/network-cloud-firewall/reference/400).", "x-akamai": { "file-path": "errors/400-versions.yaml" } }, "400-versions-invalid-page": { "content": { "application/problem+json": { "example": { "args": [ "GET" ], "errorCode": "BAD_REQUEST", "message": "Page size must not be less than one" }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/network-cloud-firewall/reference/400).", "x-akamai": { "file-path": "errors/400-versions-invalid-page.yaml" } }, "403-alias-invalid": { "content": { "application/problem+json": { "example": { "args": [ 212735, "C-0N7RAC7" ], "errorCode": "INVALID_ACCOUNT_ALIAS", "message": "AliasId = 212735 donot belong to the account C-0N7RAC7" }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/network-cloud-firewall/reference/403).", "x-akamai": { "file-path": "errors/403-alias-invalid.yaml" } }, "404-alias-not-found": { "content": { "application/problem+json": { "examples": { "alias-not-found": { "summary": "Alias not found", "value": { "$ref": "../examples/404-alias-not-found.json" } }, "prefix-not-found": { "summary": "Prefix not found", "value": { "$ref": "../examples/404-alias-prefix-not-found.json" } } }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/network-cloud-firewall/reference/404).", "x-akamai": { "file-path": "errors/404-alias-not-found.yaml" } }, "404-version-not-found": { "content": { "application/problem+json": { "examples": { "config-not-found": { "summary": "Version config not found", "value": { "$ref": "../examples/404-versions-config-not-found.json" } }, "index-not-found": { "summary": "Version index not found", "value": { "$ref": "../examples/400-versions-index-not-found.json" } }, "version-not-found": { "summary": "Version not found", "value": { "$ref": "../examples/404-versions-not-found.json" } } }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[ACL version doesn't exist](https://techdocs.akamai.com/network-cloud-firewall/reference/404).", "x-akamai": { "file-path": "errors/404-version-not-found.yaml" } }, "409-alias-already-exists": { "content": { "application/problem+json": { "example": { "args": [ "alias-stats-qa-test-src", "C-0N7RAC7" ], "errorCode": "ALREADY_EXISTS", "message": "alias-stats-qa-test-src with C-0N7RAC7 already exists." }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Conflict](https://techdocs.akamai.com/network-cloud-firewall/reference/409).", "x-akamai": { "file-path": "errors/409-alias-already-exists.yaml" } }, "409-version-already-exists": { "content": { "application/problem+json": { "example": { "args": [ "version", "same set of acl rules in CONFIGURATION state" ], "errorCode": "ALREADY_EXISTS", "message": "version with same set of acl rules in CONFIGURATION state already exists." }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Conflict](https://techdocs.akamai.com/network-cloud-firewall/reference/409).", "x-akamai": { "file-path": "errors/409-version-already-exists.yaml" } } }, "schemas": { "acl-alias-by-id-response": { "additionalProperties": false, "description": "Created or updated account alias.", "properties": { "accountId": { "description": "The account ID.", "minLength": 1, "type": "string" }, "aliasId": { "description": "Unique identifier of the alias.", "minimum": 1, "type": "integer" }, "aliasListType": { "description": "Alias list type. Either `SOURCE`, less than 50 source IP entries, `BIG`, 50 or more source IP entries, or `DIPA`, fewer than 50 destination IP entries.", "enum": [ "SOURCE", "BIG", "DIPA" ], "type": "string" }, "aliasName": { "description": "The alias name. Alias name needs to be unique to an account. An alias name needs to start with a lowercase letter and can't have any uppercase letters. Allowed characters are letters, numbers, dashes, and underscores.", "minLength": 1, "type": "string" }, "createdBy": { "description": "User who created the alias.", "minLength": 1, "type": "string" }, "createdTimestamp": { "description": "ISO 8601 timestamp marking when the alias was created.", "minLength": 1, "type": "string" }, "enabled": { "description": "Enables the account alias.", "type": "boolean" }, "entries": { "description": "Entries within the alias. Only allowed values are IP subnets belonging to the account and ISO standard country codes. If a subnet mask isn't included, defaults /32 for IPv4 or /128 for IPv6.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "entriesCount": { "description": "Number of entries within the alias.", "minimum": 0, "type": "integer" }, "hasAsns": { "description": "Whether the account alias contains AS numbers.", "type": "boolean" }, "hasCountryCodes": { "description": "Whether the account alias contains ISO country codes.", "type": "boolean" }, "ipVersion": { "description": "The IP version, either `V4` or `V6`.", "enum": [ "V4", "V6" ], "type": "string" }, "isCustomerEditable": { "description": "Whether you can edit an account alias.", "type": "boolean" }, "updatedBy": { "description": "User who last updated the alias.", "minLength": 1, "type": "string" }, "updatedTimestamp": { "description": "ISO 8601 timestamp marking the alias' last update.", "minLength": 1, "type": "string" } }, "required": [ "aliasId", "accountId", "aliasName", "aliasListType", "ipVersion", "entriesCount", "createdBy", "createdTimestamp", "updatedBy", "updatedTimestamp", "hasCountryCodes", "hasAsns", "isCustomerEditable", "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/acl-alias-by-id-response.yaml" } }, "acl-alias-create-request": { "additionalProperties": false, "properties": { "aliasListType": { "description": "Alias list type. Either `SOURCE`, less than 50 source IP entries or more source IP entries, or `DIPA`, fewer than 50 destination IP entries.", "enum": [ "SOURCE", "DIPA" ], "type": "string" }, "aliasName": { "description": "Alias name needs to be unique to an account. An alias needs to start with a lowercase letter and can't have any uppercase letters. Allowed characters are letters, numbers, dashes, and underscores.", "maxLength": 50, "minLength": 3, "pattern": "(^[a-z][a-z0-9-_]+$)", "type": "string" }, "entries": { "description": "Entries within the alias. Only allowed values are IP subnets belonging to the account and ISO standard country codes. If a subnet mask isn't included, defaults /32 for IPv4 or /128 for IPv6.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "ipVersion": { "description": "The IP version, either `V4` or `V6`.", "enum": [ "V4", "V6" ], "type": "string" } }, "required": [ "aliasName", "aliasListType", "ipVersion", "entries" ], "type": "object", "x-akamai": { "file-path": "schemas/acl-alias-create-request.yaml" } }, "acl-alias-list-response": { "description": "All aliases of an account including the global alias lists.", "items": { "additionalProperties": false, "description": "Created or updated account alias.", "properties": { "accountId": { "description": "The account ID.", "minLength": 1, "type": "string" }, "aliasId": { "description": "Unique identifier of the alias.", "minimum": 1, "type": "integer" }, "aliasListType": { "description": "Alias list type. Either `SOURCE`, less than 50 source IP entries, `BIG`, 50 or more source IP entries, or `DIPA`, fewer than 50 destination IP entries.", "enum": [ "SOURCE", "BIG", "DIPA" ], "type": "string" }, "aliasName": { "description": "The alias name. Alias name needs to be unique to an account. An alias name needs to start with a lowercase letter and can't have any uppercase letters. Allowed characters are letters, numbers, dashes, and underscores.", "minLength": 1, "type": "string" }, "createdBy": { "description": "User who created the alias.", "minLength": 1, "type": "string" }, "createdTimestamp": { "description": "ISO 8601 timestamp marking when the alias was created.", "minLength": 1, "type": "string" }, "enabled": { "description": "Enables the account alias.", "type": "boolean" }, "entries": { "description": "Entries within the alias. Only allowed values are IP subnets belonging to the account and ISO standard country codes. If a subnet mask isn't included, defaults /32 for IPv4 or /128 for IPv6.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "entriesCount": { "description": "Number of entries within the alias.", "minimum": 0, "type": "integer" }, "hasAsns": { "description": "Whether the account alias contains AS numbers.", "type": "boolean" }, "hasCountryCodes": { "description": "Whether the account alias contains ISO country codes.", "type": "boolean" }, "ipVersion": { "description": "The IP version, either `V4` or `V6`.", "enum": [ "V4", "V6" ], "type": "string" }, "isCustomerEditable": { "description": "Whether you can edit an account alias.", "type": "boolean" }, "updatedBy": { "description": "User who last updated the alias.", "minLength": 1, "type": "string" }, "updatedTimestamp": { "description": "ISO 8601 timestamp marking the alias' last update.", "minLength": 1, "type": "string" } }, "required": [ "aliasId", "accountId", "aliasName", "aliasListType", "ipVersion", "entriesCount", "createdBy", "createdTimestamp", "updatedBy", "updatedTimestamp", "hasCountryCodes", "hasAsns", "isCustomerEditable", "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/acl-alias-by-id-response.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/acl-alias-list-response.yaml" } }, "acl-alias-update-request": { "additionalProperties": false, "properties": { "aliasListType": { "description": "Alias list type. Either `SOURCE`, less than 50 source IP entries, `BIG`, 50 or more source IP entries, or `DIPA`, fewer than 50 destination IP entries.", "enum": [ "SOURCE", "DIPA" ], "nullable": true, "type": "string" }, "aliasName": { "description": "Alias names need to be unique to an account. They consist of lowercase alphanumeric characters, optionally separated by dashes or underscores. Their names need to start with a letter.", "maxLength": 50, "minLength": 3, "pattern": "(^[a-z][a-z0-9-_]+$)", "type": "string" }, "enabled": { "description": "Enables the account alias.", "type": "boolean" }, "entries": { "description": "Entries within the alias. Only allowed values are IP subnets and ISO standard country codes. IP subnets need to belong to the account. If a subnet mask isn't included, it defaults to `/32` for IPv4 or `/128` for IPv6.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "ipVersion": { "description": "The IP version, either `V4` or `V6`.", "enum": [ "V4", "V6" ], "nullable": true, "type": "string" } }, "required": [ "aliasName", "entries" ], "type": "object", "x-akamai": { "file-path": "schemas/acl-alias-update-request.yaml" } }, "acl-deployment-status": { "additionalProperties": false, "description": "ACL deployment status.", "properties": { "accountId": { "description": "Account ID.", "type": "string" }, "ruleSets": { "description": "Production, processing, and failed ACL versions.", "items": { "additionalProperties": false, "description": "ACL versions with deployment status. ", "properties": { "deploymentStatus": { "description": "The ACL version's deployment status. Either `PRODUCTION` for a rule set deployed to the network, `PROCESSING` for a version currently being prepared or staged, or `FAILED` when every rule in the rule set failed to deploy. Check `ruleSet` for the status of each rule set within the version.", "enum": [ "PRODUCTION", "PROCESSING", "FAILED" ], "type": "string" }, "hash": { "description": "The ACL version's hash value used to track updates.", "type": "string" }, "ruleSet": { "description": "Rule set contents and status of the rules within the set. ", "items": { "additionalProperties": false, "description": "Status of rules within the ACL rule set.", "properties": { "aclText": { "description": "ACL rule description. ", "type": "string" }, "installStatus": { "description": "The rule's install status. Either `INSTALLED`, `NOT_INSTALLED`, or `FAILED`.", "enum": [ "INSTALLED", "NOT_INSTALLED", "FAILED" ], "type": "string" }, "ruleUuid": { "description": "The rule's unique ID.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/acl-deployment-status-rule-set.yaml" } }, "type": "array" }, "rulesDeployStats": { "additionalProperties": false, "description": "ACL version rule statistics per deployment status.", "properties": { "failed": { "description": "Number of failed rules within the ACL version.", "minimum": 0, "type": "integer" }, "installed": { "description": "Number of successfully installed rules within the ACL version.", "minimum": 0, "type": "integer" }, "notInstalled": { "description": "Number of rules not yet installed within the ACL version.", "minimum": 0, "type": "integer" }, "total": { "description": "Total number of rules within the ACL version.", "minimum": 0, "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/acl-deployment-status-rules-deploy-stats.yaml" } }, "statusRetrievalTimestamp": { "description": "ISO 8601 timestamp of the status retrieval.", "format": "date-time", "type": "string" }, "version": { "description": "ACL version number.", "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/acl-deployment-status-by-state.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/acl-deployment-status.yaml" } }, "acl-deployment-status-by-state": { "additionalProperties": false, "description": "ACL versions with deployment status. ", "properties": { "deploymentStatus": { "description": "The ACL version's deployment status. Either `PRODUCTION` for a rule set deployed to the network, `PROCESSING` for a version currently being prepared or staged, or `FAILED` when every rule in the rule set failed to deploy. Check `ruleSet` for the status of each rule set within the version.", "enum": [ "PRODUCTION", "PROCESSING", "FAILED" ], "type": "string" }, "hash": { "description": "The ACL version's hash value used to track updates.", "type": "string" }, "ruleSet": { "description": "Rule set contents and status of the rules within the set. ", "items": { "additionalProperties": false, "description": "Status of rules within the ACL rule set.", "properties": { "aclText": { "description": "ACL rule description. ", "type": "string" }, "installStatus": { "description": "The rule's install status. Either `INSTALLED`, `NOT_INSTALLED`, or `FAILED`.", "enum": [ "INSTALLED", "NOT_INSTALLED", "FAILED" ], "type": "string" }, "ruleUuid": { "description": "The rule's unique ID.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/acl-deployment-status-rule-set.yaml" } }, "type": "array" }, "rulesDeployStats": { "additionalProperties": false, "description": "ACL version rule statistics per deployment status.", "properties": { "failed": { "description": "Number of failed rules within the ACL version.", "minimum": 0, "type": "integer" }, "installed": { "description": "Number of successfully installed rules within the ACL version.", "minimum": 0, "type": "integer" }, "notInstalled": { "description": "Number of rules not yet installed within the ACL version.", "minimum": 0, "type": "integer" }, "total": { "description": "Total number of rules within the ACL version.", "minimum": 0, "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/acl-deployment-status-rules-deploy-stats.yaml" } }, "statusRetrievalTimestamp": { "description": "ISO 8601 timestamp of the status retrieval.", "format": "date-time", "type": "string" }, "version": { "description": "ACL version number.", "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/acl-deployment-status-by-state.yaml" } }, "acl-deployment-status-rule-set": { "additionalProperties": false, "description": "Status of rules within the ACL rule set.", "properties": { "aclText": { "description": "ACL rule description. ", "type": "string" }, "installStatus": { "description": "The rule's install status. Either `INSTALLED`, `NOT_INSTALLED`, or `FAILED`.", "enum": [ "INSTALLED", "NOT_INSTALLED", "FAILED" ], "type": "string" }, "ruleUuid": { "description": "The rule's unique ID.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/acl-deployment-status-rule-set.yaml" } }, "acl-deployment-status-rules-deploy-stats": { "additionalProperties": false, "description": "ACL version rule statistics per deployment status.", "properties": { "failed": { "description": "Number of failed rules within the ACL version.", "minimum": 0, "type": "integer" }, "installed": { "description": "Number of successfully installed rules within the ACL version.", "minimum": 0, "type": "integer" }, "notInstalled": { "description": "Number of rules not yet installed within the ACL version.", "minimum": 0, "type": "integer" }, "total": { "description": "Total number of rules within the ACL version.", "minimum": 0, "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/acl-deployment-status-rules-deploy-stats.yaml" } }, "acl-rule-request": { "additionalProperties": false, "properties": { "aclText": { "description": "ACL text for the rule.", "type": "string" }, "comment": { "description": "User comments for the rule.", "type": "string" } }, "required": [ "aclText", "comment" ], "type": "object", "x-akamai": { "file-path": "schemas/acl-rule-request.yaml" } }, "acl-version-state-update-request": { "additionalProperties": false, "description": "ACL version state update properties.", "properties": { "state": { "description": "ACL version state. Either `DEPLOYED` or `DEPRECATED`. Only ACL versions in `CONFIGURATION` state can be updated.", "enum": [ "DEPLOYED", "DEPRECATED" ], "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/acl-version-state-update-request.yaml" } }, "all-versions-acl-response-with-pagination": { "additionalProperties": false, "description": "Paginated ACL versions.", "properties": { "content": { "description": "ACL versions.", "items": { "additionalProperties": false, "properties": { "accountId": { "description": "The unique account ID.", "minLength": 1, "type": "string" }, "createdBy": { "description": "The user who created the version.", "minLength": 1, "type": "string" }, "createdTimestamp": { "description": "ISO 8601 timestamp marking the version's creation.", "minLength": 1, "type": "string" }, "description": { "description": "A description of the version.", "minLength": 1, "type": "string" }, "links": { "description": "Links to related resources.", "items": { "additionalProperties": false, "properties": { "href": { "description": "The version URI.", "minLength": 1, "type": "string" }, "rel": { "description": "The relationship of the link to the version.", "minLength": 1, "type": "string" } }, "required": [ "rel", "href" ], "type": "object" }, "minItems": 0, "type": "array" }, "rulesCount": { "description": "The number of rules in the version.", "minimum": 0, "type": "integer" }, "state": { "description": "ACL version state. Either `CONFIGURATION`, `DEPLOYED`, or `DEPRECATED`.", "enum": [ "CONFIGURATION", "DEPLOYED", "DEPRECATED" ], "type": "string" }, "updatedBy": { "description": "The user who updated the version.", "minLength": 1, "type": "string" }, "updatedTimestamp": { "description": "ISO 8601 timestamp marking the version's last update.", "minLength": 1, "type": "string" }, "version": { "description": "The version number.", "minimum": 0, "type": "integer" } }, "required": [ "description", "version", "accountId", "state", "rulesCount", "createdBy", "createdTimestamp", "updatedBy", "updatedTimestamp", "links" ], "type": "object" }, "minItems": 0, "type": "array" }, "empty": { "description": "Indicates empty results.", "type": "boolean" }, "first": { "description": "Indicates if the first page of results.", "type": "boolean" }, "last": { "description": "Indicates if the last page of results.", "type": "boolean" }, "number": { "description": "The page number.", "minimum": 0, "type": "integer" }, "numberOfElements": { "description": "Number of elements on the page.", "minimum": 0, "type": "integer" }, "pageable": { "additionalProperties": false, "description": "Pagination details.", "properties": { "offset": { "description": "Indicates where to start fetching data or how many records to skip.", "minimum": 0, "type": "integer" }, "pageNumber": { "description": "The page number.", "minimum": 0, "type": "integer" }, "pageSize": { "description": "The page size.", "minimum": 0, "type": "integer" }, "paged": { "description": "Displays the results with pagination.", "type": "boolean" }, "sort": { "additionalProperties": false, "description": "Sorting details.", "properties": { "empty": { "description": "Whether the sorting option is empty.", "type": "boolean" }, "sorted": { "description": "Whether results are sorted.", "type": "boolean" }, "unsorted": { "description": "Whether results are unsorted.", "type": "boolean" } }, "required": [ "unsorted", "sorted", "empty" ], "type": "object" }, "unpaged": { "description": "Indicates if the results are unpaginated.", "type": "boolean" } }, "required": [ "sort", "pageNumber", "pageSize", "offset", "paged", "unpaged" ], "type": "object" }, "size": { "description": "The page size.", "minimum": 0, "type": "integer" }, "sort": { "additionalProperties": false, "description": "Sorting details.", "properties": { "empty": { "description": "Indicates that the sort order is empty.", "type": "boolean" }, "sorted": { "description": "Indicates that the results are unsorted.", "type": "boolean" }, "unsorted": { "description": "Indicates that the results are unsorted.", "type": "boolean" } }, "required": [ "unsorted", "sorted", "empty" ], "type": "object" }, "totalElements": { "description": "Total number of elements in the paginated results.", "minimum": 0, "type": "integer" }, "totalPages": { "description": "Total number of pages in the paginated results.", "minimum": 0, "type": "integer" } }, "required": [ "content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "number", "first", "sort", "size", "empty" ], "type": "object", "x-akamai": { "file-path": "schemas/all-versions-acl-response-with-pagination.yaml" } }, "big-alias-multi-part-request": { "additionalProperties": false, "properties": { "aliasName": { "description": "Alias name needs to be unique to an account. An alias needs to start with a lowercase letter and can't have any uppercase letters. Allowed characters are letters, numbers, dashes, and underscores.", "maxLength": 50, "minLength": 3, "pattern": "(^[a-z][a-z0-9-_]+$)", "type": "string" }, "file": { "description": "The local, absolute path to the text file containing IP entries you want to upload, one on each line.", "type": "string" }, "ipVersion": { "description": "The IP version, either `V4` or `V6`.", "enum": [ "V4", "V6" ], "type": "string" } }, "required": [ "file", "aliasName", "ipVersion" ], "type": "object", "x-akamai": { "file-path": "schemas/big-alias-multi-part-request.yaml" } }, "create-acl-version-request": { "additionalProperties": false, "description": "ACL version creation properties.", "properties": { "deploy": { "description": "This deploys the new ACL version. When `false`, it creates a new version in `CONFIGURATION` state. When `true`, it creates a new version in `DEPLOYED` state.", "type": "boolean" }, "description": { "description": "ACL version's description.", "minLength": 1, "type": "string" }, "ruleSet": { "description": "Rules within the rule set.", "items": { "additionalProperties": false, "properties": { "aclText": { "description": "A description of the ACL.", "minLength": 1, "type": "string" }, "comment": { "description": "A user-provided comment.", "minLength": 1, "type": "string" }, "index": { "description": "Indicates ordering of ACL rules.", "minimum": 1, "type": "integer" }, "ipVersion": { "description": "The IP version, either `V4` or `V6`.", "enum": [ "V4", "V6" ], "type": "string" }, "ruleUuid": { "description": "The ACL rule ID.", "minLength": 1, "type": "string" } }, "required": [ "index", "aclText" ], "type": "object" }, "minItems": 0, "type": "array" } }, "required": [ "deploy", "description", "ruleSet" ], "type": "object", "x-akamai": { "file-path": "schemas/create-acl-version-request.yaml" } }, "problem": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } }, "single-acl-version-ext-response": { "additionalProperties": false, "description": "Extended ACL version and rule set traffic data.", "properties": { "accountId": { "description": "Account ID.", "minLength": 1, "type": "string" }, "createdBy": { "description": "The user who created the version.", "minLength": 1, "type": "string" }, "createdTimestamp": { "description": "ISO 8601 timestamp marking the version's creation.", "minLength": 1, "type": "string" }, "description": { "description": "User description of the version.", "minLength": 1, "type": "string" }, "links": { "description": "Links to related version resources.", "items": { "additionalProperties": false, "properties": { "href": { "description": "The version URI.", "minLength": 1, "type": "string" }, "rel": { "description": "The relationship of the link to the version.", "type": "string" } }, "required": [ "rel", "href" ], "type": "object" }, "minItems": 0, "type": "array" }, "ruleSet": { "description": "Rules within the rule set.", "items": { "additionalProperties": false, "properties": { "aclText": { "description": "ACL user text.", "minLength": 1, "type": "string" }, "comment": { "description": "User provided comments.", "minLength": 1, "type": "string" }, "index": { "description": "ACL rule set order.", "minimum": 0, "type": "integer" }, "ipVersion": { "description": "The IP version, either `V4` or `V6`.", "enum": [ "V4", "V6" ], "type": "string" }, "parsed": { "additionalProperties": false, "description": "Parsed rule details for every rule.", "properties": { "action": { "description": "Rule action.", "minLength": 1, "type": "string" }, "description": { "description": "Rule description.", "minLength": 1, "type": "string" }, "destinationAddress": { "description": "Rule destination address.", "minLength": 1, "type": "string" }, "established": { "description": "Whether the rule is established.", "type": "boolean" }, "fragments": { "description": "Whether fragments exist.", "type": "boolean" }, "icmp": { "additionalProperties": false, "description": "ICMP details.", "nullable": true, "properties": { "icmpCode": { "description": "ICMP code.", "minimum": 0, "type": "integer" }, "icmpType": { "description": "ICMP type.", "minimum": 0, "type": "integer" } }, "required": [ "icmpType", "icmpCode" ], "type": "object" }, "ipVersion": { "description": "The IP version, either `v4` or `v6`.", "enum": [ "v4", "v6" ], "type": "string" }, "locations": { "description": "Version locations.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "log": { "additionalProperties": false, "description": "Logging details.", "nullable": true, "properties": { "interval": { "description": "Logging interval.", "minimum": 0, "type": "integer" }, "level": { "description": "Logging level number.", "minimum": 0, "type": "integer" } }, "required": [ "level", "interval" ], "type": "object" }, "name": { "description": "Rule name.", "minLength": 1, "type": "string" }, "oid": { "description": "Rule ID.", "minLength": 1, "type": "string" }, "packetLength": { "additionalProperties": false, "description": "Packet length.", "nullable": true, "properties": { "max": { "description": "The maximum packet length.", "minimum": 0, "type": "integer" }, "min": { "description": "The minimum packet length.", "minimum": 0, "type": "integer" } }, "required": [ "min", "max" ], "type": "object" }, "protocol": { "additionalProperties": false, "description": "Rule protocol.", "properties": { "max": { "description": "Maximum acceptable number.", "minimum": 0, "type": "integer" }, "min": { "description": "Minimum acceptable number.", "minimum": 0, "type": "integer" } }, "required": [ "min", "max" ], "type": "object" }, "sourceAddress": { "description": "Rule source address.", "minLength": 1, "type": "string" }, "tcp": { "additionalProperties": false, "description": "TCP details.", "nullable": true, "properties": { "destinationPort": { "additionalProperties": false, "description": "Destination port.", "properties": { "max": { "description": "The maximum destination port number.", "minimum": 0, "type": "integer" }, "min": { "description": "The minimum destination port number.", "minimum": 0, "type": "integer" } }, "required": [ "min", "max" ], "type": "object" }, "sourcePort": { "additionalProperties": false, "description": "The source port.", "properties": { "max": { "description": "The maximum source port number.", "minimum": 0, "type": "integer" }, "min": { "description": "The minimum source port number.", "minimum": 0, "type": "integer" } }, "required": [ "min", "max" ], "type": "object" } }, "required": [ "sourcePort", "destinationPort" ], "type": "object" }, "ttl": { "additionalProperties": false, "description": "A rule's time to live data.", "nullable": true, "properties": { "max": { "description": "The maximum acceptable TTL number.", "minimum": 0, "type": "integer" }, "min": { "description": "The minimum acceptable TTL number.", "minimum": 0, "type": "integer" } }, "required": [ "min", "max" ], "type": "object" }, "udp": { "additionalProperties": false, "description": "UDP details.", "nullable": true, "properties": { "destinationPort": { "additionalProperties": false, "description": "Destination port.", "properties": { "max": { "description": "The maximum destination port number.", "minimum": 0, "type": "integer" }, "min": { "description": "The minimum destination port number.", "minimum": 0, "type": "integer" } }, "required": [ "min", "max" ], "type": "object" }, "sourcePort": { "additionalProperties": false, "description": "Source port.", "properties": { "max": { "description": "The maximum source port number.", "minimum": 0, "type": "integer" }, "min": { "description": "The minimum source port number.", "minimum": 0, "type": "integer" } }, "required": [ "min", "max" ], "type": "object" } }, "required": [ "sourcePort", "destinationPort" ], "type": "object" } }, "required": [ "name", "description", "oid", "action", "protocol", "sourceAddress", "destinationAddress", "ipVersion", "ttl", "packetLength", "fragments", "established", "tcp", "udp", "icmp", "log", "locations" ], "type": "object" }, "ruleUuid": { "description": "The ACL rule ID.", "minLength": 1, "type": "string" } }, "required": [ "index", "aclText", "ruleUuid", "ipVersion", "comment" ], "type": "object" }, "minItems": 0, "type": "array" }, "state": { "description": "ACL version state. Either `CONFIGURATION`, `DEPLOYED`, or `DEPRECATED`.", "enum": [ "CONFIGURATION", "DEPLOYED", "DEPRECATED" ], "type": "string" }, "updatedBy": { "description": "The user who updated the version.", "minLength": 1, "nullable": true, "type": "string" }, "updatedTimestamp": { "description": "ISO 8601 timestamp marking the version's last update.", "minLength": 1, "nullable": true, "type": "string" }, "version": { "description": "Version number.", "minimum": 0, "type": "integer" } }, "required": [ "description", "version", "accountId", "state", "ruleSet", "createdBy", "createdTimestamp", "updatedBy", "updatedTimestamp", "links" ], "type": "object", "x-akamai": { "file-path": "schemas/single-acl-version-ext-response.yaml" } }, "single-acl-version-response": { "additionalProperties": false, "description": "ACL version and rule set traffic data.", "properties": { "accountId": { "description": "Account ID.", "minLength": 1, "type": "string" }, "createdBy": { "description": "The user who created the version.", "minLength": 1, "type": "string" }, "createdTimestamp": { "description": "ISO 8601 timestamp marking the version's creation.", "minLength": 1, "type": "string" }, "description": { "description": "A description of the version.", "minLength": 1, "type": "string" }, "ruleSet": { "description": "The rules within the rule set.", "items": { "additionalProperties": false, "properties": { "aclText": { "description": "ACL user text.", "minLength": 1, "type": "string" }, "comment": { "description": "User-provided comments.", "minLength": 1, "type": "string" }, "index": { "description": "The ACL rule order.", "minimum": 1, "type": "integer" }, "ipVersion": { "description": "The IP version, either `V4` or `V6`.", "enum": [ "V4", "V6" ], "type": "string" }, "ruleUuid": { "description": "A unique rule ID.", "minLength": 1, "type": "string" } }, "required": [ "index", "aclText", "ruleUuid", "ipVersion", "comment" ], "type": "object" }, "minItems": 0, "type": "array" }, "state": { "description": "ACL version state. Either `CONFIGURATION`, `DEPLOYED`, or `DEPRECATED`.", "enum": [ "CONFIGURATION", "DEPLOYED", "DEPRECATED" ], "type": "string" }, "updatedBy": { "description": "The user who updated the version.", "minLength": 1, "nullable": true, "type": "string" }, "updatedTimestamp": { "description": "ISO 8601 timestamp marking the version's last update.", "minLength": 1, "nullable": true, "type": "string" }, "version": { "description": "Version number.", "minimum": 1, "type": "integer" } }, "required": [ "description", "version", "accountId", "state", "ruleSet", "createdBy", "createdTimestamp", "updatedBy", "updatedTimestamp" ], "type": "object", "x-akamai": { "file-path": "schemas/single-acl-version-response.yaml" } }, "update-acl-version-request": { "additionalProperties": false, "description": "ACL version update properties.", "properties": { "deploy": { "description": "Whether the ACL config version needs to be deployed. When `false`, creates a new version in `CONFIGURATION` state. When `true`, creates a version in `DEPLOYED` state.", "type": "boolean" }, "description": { "description": "Version description.", "minLength": 1, "type": "string" }, "ruleSet": { "description": "The rules within the rule set.", "items": { "additionalProperties": false, "properties": { "aclText": { "description": "ACL user text.", "minLength": 1, "type": "string" }, "comment": { "description": "Comments.", "minLength": 1, "type": "string" }, "index": { "description": "ACL rules ordering.", "minimum": 1, "type": "integer" }, "ipVersion": { "description": "The IP version, either `V4` or `V6`.", "enum": [ "V4", "V6" ], "type": "string" }, "ruleUuid": { "description": "A unique rule ID.", "minLength": 1, "type": "string" } }, "required": [ "index", "aclText" ], "type": "object" }, "minItems": 0, "type": "array" } }, "required": [ "deploy", "description", "ruleSet" ], "type": "object", "x-akamai": { "file-path": "schemas/update-acl-version-request.yaml" } } } }, "externalDocs": { "description": "See documentation for Akamai's Prolexic Network Cloud Firewall API", "url": "https://techdocs.akamai.com/network-cloud-firewall/reference" }, "info": { "description": "Prolexic Network Cloud Firewall allows you to define and manage inbound access control lists (ACLs) enforced at the edge of the Prolexic cloud-based DDoS protection platform.\n", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "Akamai: Prolexic Network Cloud Firewall API", "version": "v1" }, "openapi": "3.0.0", "paths": { "/acls/aliases": { "post": { "description": "Creates an alias.", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Cloud Firewall API", "url": "https://techdocs.akamai.com/network-cloud-firewall/reference/post-alias" }, "operationId": "post-alias", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "aliasListType": "SOURCE", "aliasName": "a42_v4_alias_list", "entries": [ "192.0.2.32", "192.0.2.28/30", "ASN::1", "asn::2", "ASN::5", "GEO::AU", "ASN::3", "geo::AZ", "GEO::cn", "192.0.2.11/31", "geo::gb", "192.0.2.133/31", "GEO::IN", "asn::4" ], "ipVersion": "V4" }, "schema": { "additionalProperties": false, "properties": { "aliasListType": { "description": "Alias list type. Either `SOURCE`, less than 50 source IP entries or more source IP entries, or `DIPA`, fewer than 50 destination IP entries.", "enum": [ "SOURCE", "DIPA" ], "type": "string" }, "aliasName": { "description": "Alias name needs to be unique to an account. An alias needs to start with a lowercase letter and can't have any uppercase letters. Allowed characters are letters, numbers, dashes, and underscores.", "maxLength": 50, "minLength": 3, "pattern": "(^[a-z][a-z0-9-_]+$)", "type": "string" }, "entries": { "description": "Entries within the alias. Only allowed values are IP subnets belonging to the account and ISO standard country codes. If a subnet mask isn't included, defaults /32 for IPv4 or /128 for IPv6.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "ipVersion": { "description": "The IP version, either `V4` or `V6`.", "enum": [ "V4", "V6" ], "type": "string" } }, "required": [ "aliasName", "aliasListType", "ipVersion", "entries" ], "type": "object", "x-akamai": { "file-path": "schemas/acl-alias-create-request.yaml" } } } } }, "responses": { "201": { "content": { "application/json": { "example": { "accountId": "A-CCT7890", "aliasId": 20, "aliasListType": "SOURCE", "aliasName": "a42_v4_alias_list", "createdBy": "mrossi", "createdTimestamp": "2023-03-23T11:29:10.085+00:00", "enabled": true, "entries": [ "192.0.2.32/32", "192.0.2.11/31", "192.0.2.133/31", "192.0.2.28/30", "ASN::1", "ASN::2", "ASN::3", "ASN::4", "ASN::5", "GEO::AU", "GEO::AZ", "GEO::CN", "GEO::GB", "GEO::IN" ], "entriesCount": 4, "hasAsns": true, "hasCountryCodes": true, "ipVersion": "V4", "isCustomerEditable": true, "updatedBy": "jdupont", "updatedTimestamp": "2023-03-23T11:29:10.085+00:00" }, "schema": { "additionalProperties": false, "description": "Created or updated account alias.", "properties": { "accountId": { "description": "The account ID.", "minLength": 1, "type": "string" }, "aliasId": { "description": "Unique identifier of the alias.", "minimum": 1, "type": "integer" }, "aliasListType": { "description": "Alias list type. Either `SOURCE`, less than 50 source IP entries, `BIG`, 50 or more source IP entries, or `DIPA`, fewer than 50 destination IP entries.", "enum": [ "SOURCE", "BIG", "DIPA" ], "type": "string" }, "aliasName": { "description": "The alias name. Alias name needs to be unique to an account. An alias name needs to start with a lowercase letter and can't have any uppercase letters. Allowed characters are letters, numbers, dashes, and underscores.", "minLength": 1, "type": "string" }, "createdBy": { "description": "User who created the alias.", "minLength": 1, "type": "string" }, "createdTimestamp": { "description": "ISO 8601 timestamp marking when the alias was created.", "minLength": 1, "type": "string" }, "enabled": { "description": "Enables the account alias.", "type": "boolean" }, "entries": { "description": "Entries within the alias. Only allowed values are IP subnets belonging to the account and ISO standard country codes. If a subnet mask isn't included, defaults /32 for IPv4 or /128 for IPv6.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "entriesCount": { "description": "Number of entries within the alias.", "minimum": 0, "type": "integer" }, "hasAsns": { "description": "Whether the account alias contains AS numbers.", "type": "boolean" }, "hasCountryCodes": { "description": "Whether the account alias contains ISO country codes.", "type": "boolean" }, "ipVersion": { "description": "The IP version, either `V4` or `V6`.", "enum": [ "V4", "V6" ], "type": "string" }, "isCustomerEditable": { "description": "Whether you can edit an account alias.", "type": "boolean" }, "updatedBy": { "description": "User who last updated the alias.", "minLength": 1, "type": "string" }, "updatedTimestamp": { "description": "ISO 8601 timestamp marking the alias' last update.", "minLength": 1, "type": "string" } }, "required": [ "aliasId", "accountId", "aliasName", "aliasListType", "ipVersion", "entriesCount", "createdBy", "createdTimestamp", "updatedBy", "updatedTimestamp", "hasCountryCodes", "hasAsns", "isCustomerEditable", "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/acl-alias-by-id-response.yaml" } } } }, "description": "Successfully created alias for the account.", "headers": { "Location": { "description": "The unique identifier for the newly created resource. Append this ID to a subsequent GET call to view the resource details.", "schema": { "example": 1100, "type": "integer" }, "x-akamai": { "file-path": "headers/location-header.yaml" } } } }, "400": { "content": { "application/problem+json": { "examples": { "bad-request": { "summary": "Invalid operation", "value": { "$ref": "../examples/400-alias-invalid-operation.json" } }, "exceeds-limit": { "summary": "Exceeds limit", "value": { "$ref": "../examples/400-alias-exceeds-limit.json" } }, "field-missing": { "summary": "Field missing", "value": { "$ref": "../examples/400-field-missing.json" } }, "invalid-alias-count": { "summary": "Invalid count", "value": { "$ref": "../examples/400-alias-invalid-count.json" } }, "invalid-entries": { "summary": "Invalid entries", "value": { "$ref": "../examples/400-alias-invalid-entries.json" } } }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/network-cloud-firewall/reference/400).", "x-akamai": { "file-path": "errors/400-aliases.yaml" } }, "409": { "content": { "application/problem+json": { "example": { "args": [ "alias-stats-qa-test-src", "C-0N7RAC7" ], "errorCode": "ALREADY_EXISTS", "message": "alias-stats-qa-test-src with C-0N7RAC7 already exists." }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Conflict](https://techdocs.akamai.com/network-cloud-firewall/reference/409).", "x-akamai": { "file-path": "errors/409-alias-already-exists.yaml" } } }, "summary": "Create a source or DIPA alias", "tags": [ "ACL aliases" ] }, "get": { "description": "Retrieves all enabled aliases of an account including the global alias. The global alias is returned even if the account has no aliases.", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Cloud Firewall API", "url": "https://techdocs.akamai.com/network-cloud-firewall/reference/get-aliases" }, "operationId": "get-aliases", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "accountId": "A-CCT7890", "aliasId": 1, "aliasListType": "SOURCE", "aliasName": "origin_protection_ipv4", "createdBy": "hgildong", "createdTimestamp": "2023-02-25T21:28:06.000+00:00", "enabled": true, "entriesCount": 3, "hasAsns": true, "hasCountryCodes": true, "ipVersion": "V4", "isCustomerEditable": false, "updatedBy": "afero", "updatedTimestamp": "2023-02-25T21:28:06.000+00:00" }, { "accountId": "A-CCT1234", "aliasId": 2, "aliasListType": "SOURCE", "aliasName": "origin_protection_ipv6", "createdBy": "mrossi", "createdTimestamp": "2023-02-25T21:28:07.000+00:00", "enabled": true, "entriesCount": 1, "hasAsns": true, "hasCountryCodes": true, "ipVersion": "V6", "isCustomerEditable": false, "updatedBy": "adevi", "updatedTimestamp": "2023-02-25T21:28:07.000+00:00" } ], "schema": { "description": "All aliases of an account including the global alias lists.", "items": { "additionalProperties": false, "description": "Created or updated account alias.", "properties": { "accountId": { "description": "The account ID.", "minLength": 1, "type": "string" }, "aliasId": { "description": "Unique identifier of the alias.", "minimum": 1, "type": "integer" }, "aliasListType": { "description": "Alias list type. Either `SOURCE`, less than 50 source IP entries, `BIG`, 50 or more source IP entries, or `DIPA`, fewer than 50 destination IP entries.", "enum": [ "SOURCE", "BIG", "DIPA" ], "type": "string" }, "aliasName": { "description": "The alias name. Alias name needs to be unique to an account. An alias name needs to start with a lowercase letter and can't have any uppercase letters. Allowed characters are letters, numbers, dashes, and underscores.", "minLength": 1, "type": "string" }, "createdBy": { "description": "User who created the alias.", "minLength": 1, "type": "string" }, "createdTimestamp": { "description": "ISO 8601 timestamp marking when the alias was created.", "minLength": 1, "type": "string" }, "enabled": { "description": "Enables the account alias.", "type": "boolean" }, "entries": { "description": "Entries within the alias. Only allowed values are IP subnets belonging to the account and ISO standard country codes. If a subnet mask isn't included, defaults /32 for IPv4 or /128 for IPv6.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "entriesCount": { "description": "Number of entries within the alias.", "minimum": 0, "type": "integer" }, "hasAsns": { "description": "Whether the account alias contains AS numbers.", "type": "boolean" }, "hasCountryCodes": { "description": "Whether the account alias contains ISO country codes.", "type": "boolean" }, "ipVersion": { "description": "The IP version, either `V4` or `V6`.", "enum": [ "V4", "V6" ], "type": "string" }, "isCustomerEditable": { "description": "Whether you can edit an account alias.", "type": "boolean" }, "updatedBy": { "description": "User who last updated the alias.", "minLength": 1, "type": "string" }, "updatedTimestamp": { "description": "ISO 8601 timestamp marking the alias' last update.", "minLength": 1, "type": "string" } }, "required": [ "aliasId", "accountId", "aliasName", "aliasListType", "ipVersion", "entriesCount", "createdBy", "createdTimestamp", "updatedBy", "updatedTimestamp", "hasCountryCodes", "hasAsns", "isCustomerEditable", "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/acl-alias-by-id-response.yaml" } }, "minItems": 0, "type": "array", "x-akamai": { "file-path": "schemas/acl-alias-list-response.yaml" } } } }, "description": "Successfully retrieved aliases of an account including the global alias." } }, "summary": "List aliases", "tags": [ "ACL aliases" ] }, "x-akamai": { "file-path": "paths/acl-aliases.yaml", "path-info": "/acls/aliases" } }, "/acls/aliases/{aliasId}": { "get": { "description": "Retrieves all types of aliases for an account.", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Cloud Firewall API", "url": "https://techdocs.akamai.com/network-cloud-firewall/reference/get-alias" }, "operationId": "get-alias", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "accountId": "A-CCT7890", "aliasId": 20, "aliasListType": "SOURCE", "aliasName": "a42_v4_alias_list", "createdBy": "mrossi", "createdTimestamp": "2023-03-23T11:29:10.085+00:00", "enabled": true, "entries": [ "192.0.2.32/32", "192.0.2.11/31", "192.0.2.133/31", "192.0.2.28/30", "ASN::1", "ASN::2", "ASN::3", "ASN::4", "ASN::5", "GEO::AU", "GEO::AZ", "GEO::CN", "GEO::GB", "GEO::IN" ], "entriesCount": 4, "hasAsns": true, "hasCountryCodes": true, "ipVersion": "V4", "isCustomerEditable": true, "updatedBy": "jdupont", "updatedTimestamp": "2023-03-23T11:29:10.085+00:00" }, "schema": { "additionalProperties": false, "description": "Created or updated account alias.", "properties": { "accountId": { "description": "The account ID.", "minLength": 1, "type": "string" }, "aliasId": { "description": "Unique identifier of the alias.", "minimum": 1, "type": "integer" }, "aliasListType": { "description": "Alias list type. Either `SOURCE`, less than 50 source IP entries, `BIG`, 50 or more source IP entries, or `DIPA`, fewer than 50 destination IP entries.", "enum": [ "SOURCE", "BIG", "DIPA" ], "type": "string" }, "aliasName": { "description": "The alias name. Alias name needs to be unique to an account. An alias name needs to start with a lowercase letter and can't have any uppercase letters. Allowed characters are letters, numbers, dashes, and underscores.", "minLength": 1, "type": "string" }, "createdBy": { "description": "User who created the alias.", "minLength": 1, "type": "string" }, "createdTimestamp": { "description": "ISO 8601 timestamp marking when the alias was created.", "minLength": 1, "type": "string" }, "enabled": { "description": "Enables the account alias.", "type": "boolean" }, "entries": { "description": "Entries within the alias. Only allowed values are IP subnets belonging to the account and ISO standard country codes. If a subnet mask isn't included, defaults /32 for IPv4 or /128 for IPv6.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "entriesCount": { "description": "Number of entries within the alias.", "minimum": 0, "type": "integer" }, "hasAsns": { "description": "Whether the account alias contains AS numbers.", "type": "boolean" }, "hasCountryCodes": { "description": "Whether the account alias contains ISO country codes.", "type": "boolean" }, "ipVersion": { "description": "The IP version, either `V4` or `V6`.", "enum": [ "V4", "V6" ], "type": "string" }, "isCustomerEditable": { "description": "Whether you can edit an account alias.", "type": "boolean" }, "updatedBy": { "description": "User who last updated the alias.", "minLength": 1, "type": "string" }, "updatedTimestamp": { "description": "ISO 8601 timestamp marking the alias' last update.", "minLength": 1, "type": "string" } }, "required": [ "aliasId", "accountId", "aliasName", "aliasListType", "ipVersion", "entriesCount", "createdBy", "createdTimestamp", "updatedBy", "updatedTimestamp", "hasCountryCodes", "hasAsns", "isCustomerEditable", "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/acl-alias-by-id-response.yaml" } } } }, "description": "Successfully retrieved alias of an account of a given alias ID." }, "403": { "content": { "application/problem+json": { "example": { "args": [ 212735, "C-0N7RAC7" ], "errorCode": "INVALID_ACCOUNT_ALIAS", "message": "AliasId = 212735 donot belong to the account C-0N7RAC7" }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/network-cloud-firewall/reference/403).", "x-akamai": { "file-path": "errors/403-alias-invalid.yaml" } }, "404": { "content": { "application/problem+json": { "examples": { "alias-not-found": { "summary": "Alias not found", "value": { "$ref": "../examples/404-alias-not-found.json" } }, "prefix-not-found": { "summary": "Prefix not found", "value": { "$ref": "../examples/404-alias-prefix-not-found.json" } } }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/network-cloud-firewall/reference/404).", "x-akamai": { "file-path": "errors/404-alias-not-found.yaml" } } }, "summary": "Get an alias", "tags": [ "ACL aliases" ] }, "put": { "description": "Updates a source or DIPA alias for an account. If the alias is used within an account ACL rule, only updates the alias entries.", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Cloud Firewall API", "url": "https://techdocs.akamai.com/network-cloud-firewall/reference/put-alias" }, "operationId": "put-alias", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "aliasName": "a42_v4_alias_list", "entries": [ "192.0.2.32", "192.0.2.28/30", "ASN::1", "asn::2", "ASN::5", "GEO::AU", "ASN::3", "geo::AZ", "GEO::cn", "192.0.2.11/31", "geo::gb", "192.0.2.133/31", "GEO::IN", "asn::4" ] }, "schema": { "additionalProperties": false, "properties": { "aliasListType": { "description": "Alias list type. Either `SOURCE`, less than 50 source IP entries, `BIG`, 50 or more source IP entries, or `DIPA`, fewer than 50 destination IP entries.", "enum": [ "SOURCE", "DIPA" ], "nullable": true, "type": "string" }, "aliasName": { "description": "Alias names need to be unique to an account. They consist of lowercase alphanumeric characters, optionally separated by dashes or underscores. Their names need to start with a letter.", "maxLength": 50, "minLength": 3, "pattern": "(^[a-z][a-z0-9-_]+$)", "type": "string" }, "enabled": { "description": "Enables the account alias.", "type": "boolean" }, "entries": { "description": "Entries within the alias. Only allowed values are IP subnets and ISO standard country codes. IP subnets need to belong to the account. If a subnet mask isn't included, it defaults to `/32` for IPv4 or `/128` for IPv6.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "ipVersion": { "description": "The IP version, either `V4` or `V6`.", "enum": [ "V4", "V6" ], "nullable": true, "type": "string" } }, "required": [ "aliasName", "entries" ], "type": "object", "x-akamai": { "file-path": "schemas/acl-alias-update-request.yaml" } } } } }, "responses": { "200": { "content": { "application/json": { "example": { "accountId": "A-CCT7890", "aliasId": 20, "aliasListType": "SOURCE", "aliasName": "a42_v4_alias_list", "createdBy": "mrossi", "createdTimestamp": "2023-03-23T11:29:10.085+00:00", "enabled": true, "entries": [ "192.0.2.32/32", "192.0.2.11/31", "192.0.2.133/31", "192.0.2.28/30", "ASN::1", "ASN::2", "ASN::3", "ASN::4", "ASN::5", "GEO::AU", "GEO::AZ", "GEO::CN", "GEO::GB", "GEO::IN" ], "entriesCount": 4, "hasAsns": true, "hasCountryCodes": true, "ipVersion": "V4", "isCustomerEditable": true, "updatedBy": "jdupont", "updatedTimestamp": "2023-03-23T11:29:10.085+00:00" }, "schema": { "additionalProperties": false, "description": "Created or updated account alias.", "properties": { "accountId": { "description": "The account ID.", "minLength": 1, "type": "string" }, "aliasId": { "description": "Unique identifier of the alias.", "minimum": 1, "type": "integer" }, "aliasListType": { "description": "Alias list type. Either `SOURCE`, less than 50 source IP entries, `BIG`, 50 or more source IP entries, or `DIPA`, fewer than 50 destination IP entries.", "enum": [ "SOURCE", "BIG", "DIPA" ], "type": "string" }, "aliasName": { "description": "The alias name. Alias name needs to be unique to an account. An alias name needs to start with a lowercase letter and can't have any uppercase letters. Allowed characters are letters, numbers, dashes, and underscores.", "minLength": 1, "type": "string" }, "createdBy": { "description": "User who created the alias.", "minLength": 1, "type": "string" }, "createdTimestamp": { "description": "ISO 8601 timestamp marking when the alias was created.", "minLength": 1, "type": "string" }, "enabled": { "description": "Enables the account alias.", "type": "boolean" }, "entries": { "description": "Entries within the alias. Only allowed values are IP subnets belonging to the account and ISO standard country codes. If a subnet mask isn't included, defaults /32 for IPv4 or /128 for IPv6.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "entriesCount": { "description": "Number of entries within the alias.", "minimum": 0, "type": "integer" }, "hasAsns": { "description": "Whether the account alias contains AS numbers.", "type": "boolean" }, "hasCountryCodes": { "description": "Whether the account alias contains ISO country codes.", "type": "boolean" }, "ipVersion": { "description": "The IP version, either `V4` or `V6`.", "enum": [ "V4", "V6" ], "type": "string" }, "isCustomerEditable": { "description": "Whether you can edit an account alias.", "type": "boolean" }, "updatedBy": { "description": "User who last updated the alias.", "minLength": 1, "type": "string" }, "updatedTimestamp": { "description": "ISO 8601 timestamp marking the alias' last update.", "minLength": 1, "type": "string" } }, "required": [ "aliasId", "accountId", "aliasName", "aliasListType", "ipVersion", "entriesCount", "createdBy", "createdTimestamp", "updatedBy", "updatedTimestamp", "hasCountryCodes", "hasAsns", "isCustomerEditable", "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/acl-alias-by-id-response.yaml" } } } }, "description": "Successfully updated alias of the account." }, "400": { "content": { "application/problem+json": { "examples": { "bad-request": { "summary": "Invalid operation", "value": { "$ref": "../examples/400-alias-invalid-operation.json" } }, "exceeds-limit": { "summary": "Exceeds limit", "value": { "$ref": "../examples/400-alias-exceeds-limit.json" } }, "field-missing": { "summary": "Field missing", "value": { "$ref": "../examples/400-field-missing.json" } }, "invalid-alias-count": { "summary": "Invalid count", "value": { "$ref": "../examples/400-alias-invalid-count.json" } }, "invalid-entries": { "summary": "Invalid entries", "value": { "$ref": "../examples/400-alias-invalid-entries.json" } } }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/network-cloud-firewall/reference/400).", "x-akamai": { "file-path": "errors/400-aliases.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "args": [ 212735, "C-0N7RAC7" ], "errorCode": "INVALID_ACCOUNT_ALIAS", "message": "AliasId = 212735 donot belong to the account C-0N7RAC7" }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/network-cloud-firewall/reference/403).", "x-akamai": { "file-path": "errors/403-alias-invalid.yaml" } }, "404": { "content": { "application/problem+json": { "examples": { "alias-not-found": { "summary": "Alias not found", "value": { "$ref": "../examples/404-alias-not-found.json" } }, "prefix-not-found": { "summary": "Prefix not found", "value": { "$ref": "../examples/404-alias-prefix-not-found.json" } } }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/network-cloud-firewall/reference/404).", "x-akamai": { "file-path": "errors/404-alias-not-found.yaml" } }, "409": { "content": { "application/problem+json": { "example": { "args": [ "alias-stats-qa-test-src", "C-0N7RAC7" ], "errorCode": "ALREADY_EXISTS", "message": "alias-stats-qa-test-src with C-0N7RAC7 already exists." }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Conflict](https://techdocs.akamai.com/network-cloud-firewall/reference/409).", "x-akamai": { "file-path": "errors/409-alias-already-exists.yaml" } } }, "summary": "Update a source or DIPA alias", "tags": [ "ACL aliases" ] }, "delete": { "description": "Disables a source or DIPA alias for an account. If you use an alias in any of the account ACL rules, then you can't delete it.", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Cloud Firewall API", "url": "https://techdocs.akamai.com/network-cloud-firewall/reference/delete-alias" }, "operationId": "delete-alias", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "204": { "content": {}, "description": "Successfully deleted alias of the account." }, "400": { "content": { "application/problem+json": { "examples": { "bad-request": { "summary": "Invalid operation", "value": { "$ref": "../examples/400-alias-invalid-operation.json" } }, "exceeds-limit": { "summary": "Exceeds limit", "value": { "$ref": "../examples/400-alias-exceeds-limit.json" } }, "field-missing": { "summary": "Field missing", "value": { "$ref": "../examples/400-field-missing.json" } }, "invalid-alias-count": { "summary": "Invalid count", "value": { "$ref": "../examples/400-alias-invalid-count.json" } }, "invalid-entries": { "summary": "Invalid entries", "value": { "$ref": "../examples/400-alias-invalid-entries.json" } } }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/network-cloud-firewall/reference/400).", "x-akamai": { "file-path": "errors/400-aliases.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "args": [ 212735, "C-0N7RAC7" ], "errorCode": "INVALID_ACCOUNT_ALIAS", "message": "AliasId = 212735 donot belong to the account C-0N7RAC7" }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/network-cloud-firewall/reference/403).", "x-akamai": { "file-path": "errors/403-alias-invalid.yaml" } }, "404": { "content": { "application/problem+json": { "examples": { "alias-not-found": { "summary": "Alias not found", "value": { "$ref": "../examples/404-alias-not-found.json" } }, "prefix-not-found": { "summary": "Prefix not found", "value": { "$ref": "../examples/404-alias-prefix-not-found.json" } } }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/network-cloud-firewall/reference/404).", "x-akamai": { "file-path": "errors/404-alias-not-found.yaml" } } }, "summary": "Delete an alias", "tags": [ "ACL aliases" ] }, "parameters": [ { "description": "The ACL alias ID.", "in": "path", "name": "aliasId", "required": true, "schema": { "example": 2, "type": "integer" }, "x-akamai": { "file-path": "parameters/alias-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/acl-aliases-by-id.yaml", "path-info": "/acls/aliases/{aliasId}" } }, "/acls/big-aliases/upload": { "post": { "description": "Creates a big alias for an account. Specify a path to a text file containing the entries for the big alias. ", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Cloud Firewall API", "url": "https://techdocs.akamai.com/network-cloud-firewall/reference/post-big-alias" }, "operationId": "post-big-alias", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "additionalProperties": false, "properties": { "aliasName": { "description": "Alias name needs to be unique to an account. An alias needs to start with a lowercase letter and can't have any uppercase letters. Allowed characters are letters, numbers, dashes, and underscores.", "maxLength": 50, "minLength": 3, "pattern": "(^[a-z][a-z0-9-_]+$)", "type": "string" }, "file": { "description": "The local, absolute path to the text file containing IP entries you want to upload, one on each line.", "type": "string" }, "ipVersion": { "description": "The IP version, either `V4` or `V6`.", "enum": [ "V4", "V6" ], "type": "string" } }, "required": [ "file", "aliasName", "ipVersion" ], "type": "object", "x-akamai": { "file-path": "schemas/big-alias-multi-part-request.yaml" } } } } }, "responses": { "201": { "content": { "application/json": { "example": { "accountId": "A-CCT7890", "aliasId": 20, "aliasListType": "SOURCE", "aliasName": "a42_v4_alias_list", "createdBy": "mrossi", "createdTimestamp": "2023-03-23T11:29:10.085+00:00", "enabled": true, "entries": [ "192.0.2.32/32", "192.0.2.11/31", "192.0.2.133/31", "192.0.2.28/30", "ASN::1", "ASN::2", "ASN::3", "ASN::4", "ASN::5", "GEO::AU", "GEO::AZ", "GEO::CN", "GEO::GB", "GEO::IN" ], "entriesCount": 4, "hasAsns": true, "hasCountryCodes": true, "ipVersion": "V4", "isCustomerEditable": true, "updatedBy": "jdupont", "updatedTimestamp": "2023-03-23T11:29:10.085+00:00" }, "schema": { "additionalProperties": false, "description": "Created or updated account alias.", "properties": { "accountId": { "description": "The account ID.", "minLength": 1, "type": "string" }, "aliasId": { "description": "Unique identifier of the alias.", "minimum": 1, "type": "integer" }, "aliasListType": { "description": "Alias list type. Either `SOURCE`, less than 50 source IP entries, `BIG`, 50 or more source IP entries, or `DIPA`, fewer than 50 destination IP entries.", "enum": [ "SOURCE", "BIG", "DIPA" ], "type": "string" }, "aliasName": { "description": "The alias name. Alias name needs to be unique to an account. An alias name needs to start with a lowercase letter and can't have any uppercase letters. Allowed characters are letters, numbers, dashes, and underscores.", "minLength": 1, "type": "string" }, "createdBy": { "description": "User who created the alias.", "minLength": 1, "type": "string" }, "createdTimestamp": { "description": "ISO 8601 timestamp marking when the alias was created.", "minLength": 1, "type": "string" }, "enabled": { "description": "Enables the account alias.", "type": "boolean" }, "entries": { "description": "Entries within the alias. Only allowed values are IP subnets belonging to the account and ISO standard country codes. If a subnet mask isn't included, defaults /32 for IPv4 or /128 for IPv6.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "entriesCount": { "description": "Number of entries within the alias.", "minimum": 0, "type": "integer" }, "hasAsns": { "description": "Whether the account alias contains AS numbers.", "type": "boolean" }, "hasCountryCodes": { "description": "Whether the account alias contains ISO country codes.", "type": "boolean" }, "ipVersion": { "description": "The IP version, either `V4` or `V6`.", "enum": [ "V4", "V6" ], "type": "string" }, "isCustomerEditable": { "description": "Whether you can edit an account alias.", "type": "boolean" }, "updatedBy": { "description": "User who last updated the alias.", "minLength": 1, "type": "string" }, "updatedTimestamp": { "description": "ISO 8601 timestamp marking the alias' last update.", "minLength": 1, "type": "string" } }, "required": [ "aliasId", "accountId", "aliasName", "aliasListType", "ipVersion", "entriesCount", "createdBy", "createdTimestamp", "updatedBy", "updatedTimestamp", "hasCountryCodes", "hasAsns", "isCustomerEditable", "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/acl-alias-by-id-response.yaml" } } } }, "description": "Successfully created alias for the account.", "headers": { "Location": { "description": "The unique identifier for the newly created resource. Append this ID to a subsequent GET call to view the resource details.", "schema": { "example": 1100, "type": "integer" }, "x-akamai": { "file-path": "headers/location-header.yaml" } } } }, "400": { "content": { "application/problem+json": { "examples": { "bad-request": { "summary": "Invalid operation", "value": { "$ref": "../examples/400-alias-invalid-operation.json" } }, "exceeds-limit": { "summary": "Exceeds limit", "value": { "$ref": "../examples/400-alias-exceeds-limit.json" } }, "file-missing": { "summary": "File missing", "value": { "$ref": "../examples/400-big-file-missing.json" } }, "invalid-alias-count": { "summary": "Invalid count", "value": { "$ref": "../examples/400-alias-invalid-count.json" } }, "invalid-entries": { "summary": "Invalid entries", "value": { "$ref": "../examples/400-alias-invalid-entries.json" } }, "parameter-missing": { "summary": "Parameter missing", "value": { "$ref": "../examples/400-big-param-missing.json" } } }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/network-cloud-firewall/reference/400).", "x-akamai": { "file-path": "errors/400-big-aliases.yaml" } }, "409": { "content": { "application/problem+json": { "example": { "args": [ "alias-stats-qa-test-src", "C-0N7RAC7" ], "errorCode": "ALREADY_EXISTS", "message": "alias-stats-qa-test-src with C-0N7RAC7 already exists." }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Conflict](https://techdocs.akamai.com/network-cloud-firewall/reference/409).", "x-akamai": { "file-path": "errors/409-alias-already-exists.yaml" } } }, "summary": "Create a big alias", "tags": [ "Big aliases" ] }, "x-akamai": { "file-path": "paths/big-aliases-upload.yaml", "path-info": "/acls/big-aliases/upload" } }, "/acls/big-aliases/upload/{aliasId}": { "put": { "description": "Updates a big alias for an account. Specify a path to a text file containing the entries to update for the big alias. If you use the alias in an account ACL rule, this updates only the alias entries.", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Cloud Firewall API", "url": "https://techdocs.akamai.com/network-cloud-firewall/reference/put-big-alias" }, "operationId": "put-big-alias", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "additionalProperties": false, "properties": { "aliasName": { "description": "Alias name needs to be unique to an account. An alias needs to start with a lowercase letter and can't have any uppercase letters. Allowed characters are letters, numbers, dashes, and underscores.", "maxLength": 50, "minLength": 3, "pattern": "(^[a-z][a-z0-9-_]+$)", "type": "string" }, "file": { "description": "The local, absolute path to the text file containing IP entries you want to upload, one on each line.", "type": "string" }, "ipVersion": { "description": "The IP version, either `V4` or `V6`.", "enum": [ "V4", "V6" ], "type": "string" } }, "required": [ "file", "aliasName", "ipVersion" ], "type": "object", "x-akamai": { "file-path": "schemas/big-alias-multi-part-request.yaml" } } } } }, "responses": { "200": { "content": { "application/json": { "example": { "accountId": "A-CCT7890", "aliasId": 20, "aliasListType": "SOURCE", "aliasName": "a42_v4_alias_list", "createdBy": "mrossi", "createdTimestamp": "2023-03-23T11:29:10.085+00:00", "enabled": true, "entries": [ "192.0.2.32/32", "192.0.2.11/31", "192.0.2.133/31", "192.0.2.28/30", "ASN::1", "ASN::2", "ASN::3", "ASN::4", "ASN::5", "GEO::AU", "GEO::AZ", "GEO::CN", "GEO::GB", "GEO::IN" ], "entriesCount": 4, "hasAsns": true, "hasCountryCodes": true, "ipVersion": "V4", "isCustomerEditable": true, "updatedBy": "jdupont", "updatedTimestamp": "2023-03-23T11:29:10.085+00:00" }, "schema": { "additionalProperties": false, "description": "Created or updated account alias.", "properties": { "accountId": { "description": "The account ID.", "minLength": 1, "type": "string" }, "aliasId": { "description": "Unique identifier of the alias.", "minimum": 1, "type": "integer" }, "aliasListType": { "description": "Alias list type. Either `SOURCE`, less than 50 source IP entries, `BIG`, 50 or more source IP entries, or `DIPA`, fewer than 50 destination IP entries.", "enum": [ "SOURCE", "BIG", "DIPA" ], "type": "string" }, "aliasName": { "description": "The alias name. Alias name needs to be unique to an account. An alias name needs to start with a lowercase letter and can't have any uppercase letters. Allowed characters are letters, numbers, dashes, and underscores.", "minLength": 1, "type": "string" }, "createdBy": { "description": "User who created the alias.", "minLength": 1, "type": "string" }, "createdTimestamp": { "description": "ISO 8601 timestamp marking when the alias was created.", "minLength": 1, "type": "string" }, "enabled": { "description": "Enables the account alias.", "type": "boolean" }, "entries": { "description": "Entries within the alias. Only allowed values are IP subnets belonging to the account and ISO standard country codes. If a subnet mask isn't included, defaults /32 for IPv4 or /128 for IPv6.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "entriesCount": { "description": "Number of entries within the alias.", "minimum": 0, "type": "integer" }, "hasAsns": { "description": "Whether the account alias contains AS numbers.", "type": "boolean" }, "hasCountryCodes": { "description": "Whether the account alias contains ISO country codes.", "type": "boolean" }, "ipVersion": { "description": "The IP version, either `V4` or `V6`.", "enum": [ "V4", "V6" ], "type": "string" }, "isCustomerEditable": { "description": "Whether you can edit an account alias.", "type": "boolean" }, "updatedBy": { "description": "User who last updated the alias.", "minLength": 1, "type": "string" }, "updatedTimestamp": { "description": "ISO 8601 timestamp marking the alias' last update.", "minLength": 1, "type": "string" } }, "required": [ "aliasId", "accountId", "aliasName", "aliasListType", "ipVersion", "entriesCount", "createdBy", "createdTimestamp", "updatedBy", "updatedTimestamp", "hasCountryCodes", "hasAsns", "isCustomerEditable", "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/acl-alias-by-id-response.yaml" } } } }, "description": "Successfully updated alias of the account." }, "400": { "content": { "application/problem+json": { "examples": { "bad-request": { "summary": "Invalid operation", "value": { "$ref": "../examples/400-alias-invalid-operation.json" } }, "exceeds-limit": { "summary": "Exceeds limit", "value": { "$ref": "../examples/400-alias-exceeds-limit.json" } }, "file-missing": { "summary": "File missing", "value": { "$ref": "../examples/400-big-file-missing.json" } }, "invalid-alias-count": { "summary": "Invalid count", "value": { "$ref": "../examples/400-alias-invalid-count.json" } }, "invalid-entries": { "summary": "Invalid entries", "value": { "$ref": "../examples/400-alias-invalid-entries.json" } }, "parameter-missing": { "summary": "Parameter missing", "value": { "$ref": "../examples/400-big-param-missing.json" } } }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/network-cloud-firewall/reference/400).", "x-akamai": { "file-path": "errors/400-big-aliases.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "args": [ 212735, "C-0N7RAC7" ], "errorCode": "INVALID_ACCOUNT_ALIAS", "message": "AliasId = 212735 donot belong to the account C-0N7RAC7" }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/network-cloud-firewall/reference/403).", "x-akamai": { "file-path": "errors/403-alias-invalid.yaml" } }, "404": { "content": { "application/problem+json": { "examples": { "alias-not-found": { "summary": "Alias not found", "value": { "$ref": "../examples/404-alias-not-found.json" } }, "prefix-not-found": { "summary": "Prefix not found", "value": { "$ref": "../examples/404-alias-prefix-not-found.json" } } }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/network-cloud-firewall/reference/404).", "x-akamai": { "file-path": "errors/404-alias-not-found.yaml" } }, "409": { "content": { "application/problem+json": { "example": { "args": [ "alias-stats-qa-test-src", "C-0N7RAC7" ], "errorCode": "ALREADY_EXISTS", "message": "alias-stats-qa-test-src with C-0N7RAC7 already exists." }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Conflict](https://techdocs.akamai.com/network-cloud-firewall/reference/409).", "x-akamai": { "file-path": "errors/409-alias-already-exists.yaml" } } }, "summary": "Update a big alias", "tags": [ "Big aliases" ] }, "parameters": [ { "description": "The ACL alias ID.", "in": "path", "name": "aliasId", "required": true, "schema": { "example": 2, "type": "integer" }, "x-akamai": { "file-path": "parameters/alias-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/big-aliases-by-id.yaml", "path-info": "/acls/big-aliases/upload/{aliasId}" } }, "/acls/ip-versions/{ipVersion}/rules/{index}": { "post": { "description": "Adds a new rule in `CONFIGURATION` state at the specified index in the ACL version's rule set.", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Cloud Firewall API", "url": "https://techdocs.akamai.com/network-cloud-firewall/reference/post-acl-version-rule" }, "operationId": "post-acl-version-rule", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "aclText": "deny icmp any 198.51.100.0/24 net-redirect", "comment": "deny acl rule" }, "schema": { "additionalProperties": false, "properties": { "aclText": { "description": "ACL text for the rule.", "type": "string" }, "comment": { "description": "User comments for the rule.", "type": "string" } }, "required": [ "aclText", "comment" ], "type": "object", "x-akamai": { "file-path": "schemas/acl-rule-request.yaml" } } } } }, "responses": { "201": { "content": { "application/json": { "example": { "accountId": "A-CCT3456", "createdBy": "asingh", "createdTimestamp": "2022-07-15T21:56:57.000+00:00", "description": "Cloning version 9 with all rules enabled", "ruleSet": [ { "aclText": "remark test", "comment": "test comment", "index": 1, "ipVersion": "V4", "ruleUuid": "b7378dab-4f19-4699-a34c-d623fdf5a769" }, { "aclText": "deny icmp any 198.51.100.0/24 net-redirect", "comment": "test comment", "index": 2, "ipVersion": "V4", "ruleUuid": "63cbc7c4-b5e8-482e-881b-43bf8b512450" }, { "aclText": "deny tcp any 198.51.100.1/32", "comment": "test comment", "index": 3, "ipVersion": "V4", "ruleUuid": "e12105a6-da45-494e-b931-b8f51158e373" }, { "aclText": "permit udp any 198.51.100.1/32", "comment": "test comment", "index": 4, "ipVersion": "V4", "ruleUuid": "a4f177a9-37e6-451b-85a7-604066d2765a" }, { "aclText": "deny udp GEO::CA 198.51.100.0/32", "comment": "Blocking all udp traffic from Canada", "index": 5, "ipVersion": "V4", "ruleUuid": "a5f177a9-37e6-451b-85a7-604066d2765a" }, { "aclText": "deny tcp any 2606:6c00:127:0:0:0:0:d8/127", "comment": "test comment", "index": 1, "ipVersion": "V6", "ruleUuid": "a56177a9-37e6-451b-85a7-604066d2765a" } ], "state": "CONFIGURATION", "updatedBy": "alfulani", "updatedTimestamp": "2022-08-15T21:56:57.000+00:00", "version": 10 }, "schema": { "additionalProperties": false, "description": "ACL version and rule set traffic data.", "properties": { "accountId": { "description": "Account ID.", "minLength": 1, "type": "string" }, "createdBy": { "description": "The user who created the version.", "minLength": 1, "type": "string" }, "createdTimestamp": { "description": "ISO 8601 timestamp marking the version's creation.", "minLength": 1, "type": "string" }, "description": { "description": "A description of the version.", "minLength": 1, "type": "string" }, "ruleSet": { "description": "The rules within the rule set.", "items": { "additionalProperties": false, "properties": { "aclText": { "description": "ACL user text.", "minLength": 1, "type": "string" }, "comment": { "description": "User-provided comments.", "minLength": 1, "type": "string" }, "index": { "description": "The ACL rule order.", "minimum": 1, "type": "integer" }, "ipVersion": { "description": "The IP version, either `V4` or `V6`.", "enum": [ "V4", "V6" ], "type": "string" }, "ruleUuid": { "description": "A unique rule ID.", "minLength": 1, "type": "string" } }, "required": [ "index", "aclText", "ruleUuid", "ipVersion", "comment" ], "type": "object" }, "minItems": 0, "type": "array" }, "state": { "description": "ACL version state. Either `CONFIGURATION`, `DEPLOYED`, or `DEPRECATED`.", "enum": [ "CONFIGURATION", "DEPLOYED", "DEPRECATED" ], "type": "string" }, "updatedBy": { "description": "The user who updated the version.", "minLength": 1, "nullable": true, "type": "string" }, "updatedTimestamp": { "description": "ISO 8601 timestamp marking the version's last update.", "minLength": 1, "nullable": true, "type": "string" }, "version": { "description": "Version number.", "minimum": 1, "type": "integer" } }, "required": [ "description", "version", "accountId", "state", "ruleSet", "createdBy", "createdTimestamp", "updatedBy", "updatedTimestamp" ], "type": "object", "x-akamai": { "file-path": "schemas/single-acl-version-response.yaml" } } } }, "description": "Successfully added a new rule.", "headers": { "Location": { "description": "The unique identifier for the newly created resource. Append this ID to a subsequent GET call to view the resource details.", "schema": { "example": 1100, "type": "integer" }, "x-akamai": { "file-path": "headers/location-header.yaml" } } } }, "400": { "content": { "application/problem+json": { "examples": { "any-not-allowed": { "summary": "Any Destination not allowed", "value": { "$ref": "../examples/400-versions-any-not-allowed.json" } }, "destination-not-allowed": { "summary": "Destination not allowed", "value": { "$ref": "../examples/400-versions-destination-not-allowed.json" } }, "duplicate-acl-text": { "summary": "ACL text duplicate", "value": { "$ref": "../examples/400-versions-duplicate-acl-text.json" } }, "field-invalid": { "summary": "Field invalid", "value": { "$ref": "../examples/400-versions-invalid-field.json" } }, "field-missing": { "summary": "Field missing", "value": { "$ref": "../examples/400-field-missing.json" } }, "invalid-acl-text": { "summary": "ACL text invalid", "value": { "$ref": "../examples/400-versions-invalid-acl-text.json" } }, "invalid-asn": { "summary": "ASN invalid", "value": { "$ref": "../examples/400-asn-invalid.json" } }, "version-config-exists": { "summary": "Version config already exists", "value": { "$ref": "../examples/400-versions-config-exists.json" } }, "version-invalid-index": { "summary": "Invalid version index", "value": { "$ref": "../examples/400-versions-invalid-index.json" } }, "version-limit-exceeded": { "summary": "Version exceeds limit", "value": { "$ref": "../examples/400-versions-exceeds-limit.json" } }, "versions-not-allowed": { "summary": "Versions not allowed", "value": { "$ref": "../examples/400-versions-not-allowed.json" } } }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/network-cloud-firewall/reference/400).", "x-akamai": { "file-path": "errors/400-versions.yaml" } }, "409": { "content": { "application/problem+json": { "example": { "args": [ "version", "same set of acl rules in CONFIGURATION state" ], "errorCode": "ALREADY_EXISTS", "message": "version with same set of acl rules in CONFIGURATION state already exists." }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Conflict](https://techdocs.akamai.com/network-cloud-firewall/reference/409).", "x-akamai": { "file-path": "errors/409-version-already-exists.yaml" } } }, "summary": "Create a rule in an ACL version's rule set", "tags": [ "ACL rules" ] }, "put": { "description": "Updates a rule in `CONFIGURATION` state at the specified index in the ACL version's rule set.", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Cloud Firewall API", "url": "https://techdocs.akamai.com/network-cloud-firewall/reference/put-acl-version-rule" }, "operationId": "put-acl-version-rule", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "aclText": "deny icmp any 198.51.100.0/24 net-redirect", "comment": "deny acl rule" }, "schema": { "additionalProperties": false, "properties": { "aclText": { "description": "ACL text for the rule.", "type": "string" }, "comment": { "description": "User comments for the rule.", "type": "string" } }, "required": [ "aclText", "comment" ], "type": "object", "x-akamai": { "file-path": "schemas/acl-rule-request.yaml" } } } } }, "responses": { "200": { "content": { "application/json": { "example": { "accountId": "A-CCT3456", "createdBy": "asingh", "createdTimestamp": "2022-07-15T21:56:57.000+00:00", "description": "Cloning version 9 with all rules enabled", "ruleSet": [ { "aclText": "remark test", "comment": "test comment", "index": 1, "ipVersion": "V4", "ruleUuid": "b7378dab-4f19-4699-a34c-d623fdf5a769" }, { "aclText": "deny icmp any 198.51.100.0/24 net-redirect", "comment": "test comment", "index": 2, "ipVersion": "V4", "ruleUuid": "63cbc7c4-b5e8-482e-881b-43bf8b512450" }, { "aclText": "deny tcp any 198.51.100.1/32", "comment": "test comment", "index": 3, "ipVersion": "V4", "ruleUuid": "e12105a6-da45-494e-b931-b8f51158e373" }, { "aclText": "permit udp any 198.51.100.1/32", "comment": "test comment", "index": 4, "ipVersion": "V4", "ruleUuid": "a4f177a9-37e6-451b-85a7-604066d2765a" }, { "aclText": "deny udp GEO::CA 198.51.100.0/32", "comment": "Blocking all udp traffic from Canada", "index": 5, "ipVersion": "V4", "ruleUuid": "a5f177a9-37e6-451b-85a7-604066d2765a" }, { "aclText": "deny tcp any 2606:6c00:127:0:0:0:0:d8/127", "comment": "test comment", "index": 1, "ipVersion": "V6", "ruleUuid": "a56177a9-37e6-451b-85a7-604066d2765a" } ], "state": "CONFIGURATION", "updatedBy": "alfulani", "updatedTimestamp": "2022-08-15T21:56:57.000+00:00", "version": 10 }, "schema": { "additionalProperties": false, "description": "ACL version and rule set traffic data.", "properties": { "accountId": { "description": "Account ID.", "minLength": 1, "type": "string" }, "createdBy": { "description": "The user who created the version.", "minLength": 1, "type": "string" }, "createdTimestamp": { "description": "ISO 8601 timestamp marking the version's creation.", "minLength": 1, "type": "string" }, "description": { "description": "A description of the version.", "minLength": 1, "type": "string" }, "ruleSet": { "description": "The rules within the rule set.", "items": { "additionalProperties": false, "properties": { "aclText": { "description": "ACL user text.", "minLength": 1, "type": "string" }, "comment": { "description": "User-provided comments.", "minLength": 1, "type": "string" }, "index": { "description": "The ACL rule order.", "minimum": 1, "type": "integer" }, "ipVersion": { "description": "The IP version, either `V4` or `V6`.", "enum": [ "V4", "V6" ], "type": "string" }, "ruleUuid": { "description": "A unique rule ID.", "minLength": 1, "type": "string" } }, "required": [ "index", "aclText", "ruleUuid", "ipVersion", "comment" ], "type": "object" }, "minItems": 0, "type": "array" }, "state": { "description": "ACL version state. Either `CONFIGURATION`, `DEPLOYED`, or `DEPRECATED`.", "enum": [ "CONFIGURATION", "DEPLOYED", "DEPRECATED" ], "type": "string" }, "updatedBy": { "description": "The user who updated the version.", "minLength": 1, "nullable": true, "type": "string" }, "updatedTimestamp": { "description": "ISO 8601 timestamp marking the version's last update.", "minLength": 1, "nullable": true, "type": "string" }, "version": { "description": "Version number.", "minimum": 1, "type": "integer" } }, "required": [ "description", "version", "accountId", "state", "ruleSet", "createdBy", "createdTimestamp", "updatedBy", "updatedTimestamp" ], "type": "object", "x-akamai": { "file-path": "schemas/single-acl-version-response.yaml" } } } }, "description": "Successfully updated rule." }, "400": { "content": { "application/problem+json": { "examples": { "any-not-allowed": { "summary": "Any Destination not allowed", "value": { "$ref": "../examples/400-versions-any-not-allowed.json" } }, "destination-not-allowed": { "summary": "Destination not allowed", "value": { "$ref": "../examples/400-versions-destination-not-allowed.json" } }, "duplicate-acl-text": { "summary": "ACL text duplicate", "value": { "$ref": "../examples/400-versions-duplicate-acl-text.json" } }, "field-invalid": { "summary": "Field invalid", "value": { "$ref": "../examples/400-versions-invalid-field.json" } }, "field-missing": { "summary": "Field missing", "value": { "$ref": "../examples/400-field-missing.json" } }, "invalid-acl-text": { "summary": "ACL text invalid", "value": { "$ref": "../examples/400-versions-invalid-acl-text.json" } }, "invalid-asn": { "summary": "ASN invalid", "value": { "$ref": "../examples/400-asn-invalid.json" } }, "version-config-exists": { "summary": "Version config already exists", "value": { "$ref": "../examples/400-versions-config-exists.json" } }, "version-invalid-index": { "summary": "Invalid version index", "value": { "$ref": "../examples/400-versions-invalid-index.json" } }, "version-limit-exceeded": { "summary": "Version exceeds limit", "value": { "$ref": "../examples/400-versions-exceeds-limit.json" } }, "versions-not-allowed": { "summary": "Versions not allowed", "value": { "$ref": "../examples/400-versions-not-allowed.json" } } }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/network-cloud-firewall/reference/400).", "x-akamai": { "file-path": "errors/400-versions.yaml" } }, "404": { "content": { "application/problem+json": { "examples": { "config-not-found": { "summary": "Version config not found", "value": { "$ref": "../examples/404-versions-config-not-found.json" } }, "index-not-found": { "summary": "Version index not found", "value": { "$ref": "../examples/400-versions-index-not-found.json" } }, "version-not-found": { "summary": "Version not found", "value": { "$ref": "../examples/404-versions-not-found.json" } } }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[ACL version doesn't exist](https://techdocs.akamai.com/network-cloud-firewall/reference/404).", "x-akamai": { "file-path": "errors/404-version-not-found.yaml" } }, "409": { "content": { "application/problem+json": { "example": { "args": [ "version", "same set of acl rules in CONFIGURATION state" ], "errorCode": "ALREADY_EXISTS", "message": "version with same set of acl rules in CONFIGURATION state already exists." }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Conflict](https://techdocs.akamai.com/network-cloud-firewall/reference/409).", "x-akamai": { "file-path": "errors/409-version-already-exists.yaml" } } }, "summary": "Update a rule in an ACL version's rule set", "tags": [ "ACL rules" ] }, "delete": { "description": "Deletes a rule in `CONFIGURATION` state at the specified index in the ACL version's rule set.", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Cloud Firewall API", "url": "https://techdocs.akamai.com/network-cloud-firewall/reference/delete-acl-version-rule" }, "operationId": "delete-acl-version-rule", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "204": { "content": {}, "description": "Rule successfully deleted." }, "404": { "content": { "application/problem+json": { "examples": { "config-not-found": { "summary": "Version config not found", "value": { "$ref": "../examples/404-versions-config-not-found.json" } }, "index-not-found": { "summary": "Version index not found", "value": { "$ref": "../examples/400-versions-index-not-found.json" } }, "version-not-found": { "summary": "Version not found", "value": { "$ref": "../examples/404-versions-not-found.json" } } }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[ACL version doesn't exist](https://techdocs.akamai.com/network-cloud-firewall/reference/404).", "x-akamai": { "file-path": "errors/404-version-not-found.yaml" } } }, "summary": "Delete a rule in an ACL version's rule set", "tags": [ "ACL rules" ] }, "parameters": [ { "description": "__Enum__ The IP version, either `V4` or `V6`.", "in": "path", "name": "ipVersion", "required": true, "schema": { "enum": [ "V4", "V6" ], "example": "V4", "type": "string" }, "x-akamai": { "file-path": "parameters/ip-version-path.yaml" } }, { "description": "The rule's index.", "in": "path", "name": "index", "required": true, "schema": { "example": 5, "type": "integer" }, "x-akamai": { "file-path": "parameters/index-path.yaml" } } ], "x-akamai": { "file-path": "paths/acl-rules.yaml", "path-info": "/acls/ip-versions/{ipVersion}/rules/{index}" } }, "/acls/versions": { "post": { "description": "Creates a new ACL version in `CONFIGURATION` or `DEPLOYED` state.", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Cloud Firewall API", "url": "https://techdocs.akamai.com/network-cloud-firewall/reference/post-version" }, "operationId": "post-version", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "deploy": true, "description": "test comment", "ruleSet": [ { "aclText": "deny tcp any 2001:0db8:0:0:0:0:0:0/128", "comment": " ", "index": 1, "ipVersion": "V6" }, { "aclText": "deny tcp any 198.51.100.0/24", "comment": " ", "index": 1, "ipVersion": "V4" } ] }, "schema": { "additionalProperties": false, "description": "ACL version creation properties.", "properties": { "deploy": { "description": "This deploys the new ACL version. When `false`, it creates a new version in `CONFIGURATION` state. When `true`, it creates a new version in `DEPLOYED` state.", "type": "boolean" }, "description": { "description": "ACL version's description.", "minLength": 1, "type": "string" }, "ruleSet": { "description": "Rules within the rule set.", "items": { "additionalProperties": false, "properties": { "aclText": { "description": "A description of the ACL.", "minLength": 1, "type": "string" }, "comment": { "description": "A user-provided comment.", "minLength": 1, "type": "string" }, "index": { "description": "Indicates ordering of ACL rules.", "minimum": 1, "type": "integer" }, "ipVersion": { "description": "The IP version, either `V4` or `V6`.", "enum": [ "V4", "V6" ], "type": "string" }, "ruleUuid": { "description": "The ACL rule ID.", "minLength": 1, "type": "string" } }, "required": [ "index", "aclText" ], "type": "object" }, "minItems": 0, "type": "array" } }, "required": [ "deploy", "description", "ruleSet" ], "type": "object", "x-akamai": { "file-path": "schemas/create-acl-version-request.yaml" } } } } }, "responses": { "201": { "content": { "application/json": { "example": { "accountId": "A-CCT3456", "createdBy": "asingh", "createdTimestamp": "2022-07-15T21:56:57.000+00:00", "description": "Cloning version 9 with all rules enabled", "ruleSet": [ { "aclText": "remark test", "comment": "test comment", "index": 1, "ipVersion": "V4", "ruleUuid": "b7378dab-4f19-4699-a34c-d623fdf5a769" }, { "aclText": "deny icmp any 198.51.100.0/24 net-redirect", "comment": "test comment", "index": 2, "ipVersion": "V4", "ruleUuid": "63cbc7c4-b5e8-482e-881b-43bf8b512450" }, { "aclText": "deny tcp any 198.51.100.1/32", "comment": "test comment", "index": 3, "ipVersion": "V4", "ruleUuid": "e12105a6-da45-494e-b931-b8f51158e373" }, { "aclText": "permit udp any 198.51.100.1/32", "comment": "test comment", "index": 4, "ipVersion": "V4", "ruleUuid": "a4f177a9-37e6-451b-85a7-604066d2765a" }, { "aclText": "deny udp GEO::CA 198.51.100.0/32", "comment": "Blocking all udp traffic from Canada", "index": 5, "ipVersion": "V4", "ruleUuid": "a5f177a9-37e6-451b-85a7-604066d2765a" }, { "aclText": "deny tcp any 2606:6c00:127:0:0:0:0:d8/127", "comment": "test comment", "index": 1, "ipVersion": "V6", "ruleUuid": "a56177a9-37e6-451b-85a7-604066d2765a" } ], "state": "CONFIGURATION", "updatedBy": "alfulani", "updatedTimestamp": "2022-08-15T21:56:57.000+00:00", "version": 10 }, "schema": { "additionalProperties": false, "description": "ACL version and rule set traffic data.", "properties": { "accountId": { "description": "Account ID.", "minLength": 1, "type": "string" }, "createdBy": { "description": "The user who created the version.", "minLength": 1, "type": "string" }, "createdTimestamp": { "description": "ISO 8601 timestamp marking the version's creation.", "minLength": 1, "type": "string" }, "description": { "description": "A description of the version.", "minLength": 1, "type": "string" }, "ruleSet": { "description": "The rules within the rule set.", "items": { "additionalProperties": false, "properties": { "aclText": { "description": "ACL user text.", "minLength": 1, "type": "string" }, "comment": { "description": "User-provided comments.", "minLength": 1, "type": "string" }, "index": { "description": "The ACL rule order.", "minimum": 1, "type": "integer" }, "ipVersion": { "description": "The IP version, either `V4` or `V6`.", "enum": [ "V4", "V6" ], "type": "string" }, "ruleUuid": { "description": "A unique rule ID.", "minLength": 1, "type": "string" } }, "required": [ "index", "aclText", "ruleUuid", "ipVersion", "comment" ], "type": "object" }, "minItems": 0, "type": "array" }, "state": { "description": "ACL version state. Either `CONFIGURATION`, `DEPLOYED`, or `DEPRECATED`.", "enum": [ "CONFIGURATION", "DEPLOYED", "DEPRECATED" ], "type": "string" }, "updatedBy": { "description": "The user who updated the version.", "minLength": 1, "nullable": true, "type": "string" }, "updatedTimestamp": { "description": "ISO 8601 timestamp marking the version's last update.", "minLength": 1, "nullable": true, "type": "string" }, "version": { "description": "Version number.", "minimum": 1, "type": "integer" } }, "required": [ "description", "version", "accountId", "state", "ruleSet", "createdBy", "createdTimestamp", "updatedBy", "updatedTimestamp" ], "type": "object", "x-akamai": { "file-path": "schemas/single-acl-version-response.yaml" } } } }, "description": "The response shows the newly created ACL version.", "headers": { "Location": { "description": "The unique identifier for the newly created resource. Append this ID to a subsequent GET call to view the resource details.", "schema": { "example": 1100, "type": "integer" }, "x-akamai": { "file-path": "headers/location-header.yaml" } } } }, "400": { "content": { "application/problem+json": { "examples": { "any-not-allowed": { "summary": "Any Destination not allowed", "value": { "$ref": "../examples/400-versions-any-not-allowed.json" } }, "destination-not-allowed": { "summary": "Destination not allowed", "value": { "$ref": "../examples/400-versions-destination-not-allowed.json" } }, "duplicate-acl-text": { "summary": "ACL text duplicate", "value": { "$ref": "../examples/400-versions-duplicate-acl-text.json" } }, "field-invalid": { "summary": "Field invalid", "value": { "$ref": "../examples/400-versions-invalid-field.json" } }, "field-missing": { "summary": "Field missing", "value": { "$ref": "../examples/400-field-missing.json" } }, "invalid-acl-text": { "summary": "ACL text invalid", "value": { "$ref": "../examples/400-versions-invalid-acl-text.json" } }, "invalid-asn": { "summary": "ASN invalid", "value": { "$ref": "../examples/400-asn-invalid.json" } }, "version-config-exists": { "summary": "Version config already exists", "value": { "$ref": "../examples/400-versions-config-exists.json" } }, "version-invalid-index": { "summary": "Invalid version index", "value": { "$ref": "../examples/400-versions-invalid-index.json" } }, "version-limit-exceeded": { "summary": "Version exceeds limit", "value": { "$ref": "../examples/400-versions-exceeds-limit.json" } }, "versions-not-allowed": { "summary": "Versions not allowed", "value": { "$ref": "../examples/400-versions-not-allowed.json" } } }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/network-cloud-firewall/reference/400).", "x-akamai": { "file-path": "errors/400-versions.yaml" } } }, "summary": "Create an ACL version", "tags": [ "ACL versions" ] }, "get": { "description": "Lists all the ACL rules versions for the account in any deployment state. Run [Get an ACL version](https://techdocs.akamai.com/network-cloud-firewall/reference/get-version) to get ACL rules for a specific version. Only one ACL version can be in `CONFIGURATION` or `DEPLOYED` state.", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Cloud Firewall API", "url": "https://techdocs.akamai.com/network-cloud-firewall/reference/get-versions" }, "operationId": "get-versions", "parameters": [ { "description": "Returns the latest ACL versions for the account. If `true`, displays only ACL versions in `CONFIGURATION` and `DEPLOYED` states. If `false`, lists ACL versions in all states.", "in": "query", "name": "latest", "required": false, "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/latest-query.yaml" } }, { "description": "Page number for pagination.", "in": "query", "name": "page", "required": false, "schema": { "example": 3, "type": "integer" }, "x-akamai": { "file-path": "parameters/page-query.yaml" } }, { "description": "Number of items per page.", "in": "query", "name": "size", "required": false, "schema": { "example": 25, "type": "integer" }, "x-akamai": { "file-path": "parameters/size-query.yaml" } }, { "description": "__Enum__ ACL version content property to sort by. Either `accountId`, `version`, `description`, `state`, `rulesCount`, `createdBy`, `updatedBy`, `createdTimestamp`, or `updatedTimestamp`.", "in": "query", "name": "sortBy", "required": false, "schema": { "enum": [ "accountId", "version", "description", "state", "rulesCount", "createdBy", "updatedBy", "createdTimestamp", "updatedTimestamp" ], "example": "version", "type": "string" }, "x-akamai": { "file-path": "parameters/sort-by-query.yaml" } }, { "description": "__Enum__ The results sort order. Either `asc` (ascending) or `desc` (descending).", "in": "query", "name": "sortOrder", "required": false, "schema": { "enum": [ "asc", "desc" ], "example": "asc", "type": "string" }, "x-akamai": { "file-path": "parameters/sort-order-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "content": [ { "accountId": "A-CCT1234", "createdBy": "jperez", "createdTimestamp": "2022-08-15T21:08:02.000+00:00", "description": "Cloning version 9 with all rules enabled", "links": [ { "href": "versions/14", "rel": "self" } ], "rulesCount": 1, "state": "DEPRECATED", "updatedBy": "mrossi", "updatedTimestamp": "2023-07-20T00:05:30.000+00:00", "version": 14 }, { "accountId": "A-CCT9012", "createdBy": "jsmith", "createdTimestamp": "2023-07-20T00:06:09.000+00:00", "description": "[clone of v14] Cloning version 9 with all rules enabled", "links": [ { "href": "versions/15", "rel": "self" } ], "rulesCount": 1, "state": "DEPRECATED", "updatedBy": "jkowalski", "updatedTimestamp": "2023-07-20T00:21:42.000+00:00", "version": 15 } ], "empty": false, "first": false, "last": false, "number": 1, "numberOfElements": 2, "pageable": { "offset": 2, "pageNumber": 1, "pageSize": 2, "paged": true, "sort": { "empty": false, "sorted": true, "unsorted": false }, "unpaged": false }, "size": 2, "sort": { "empty": false, "sorted": true, "unsorted": false }, "totalElements": 18, "totalPages": 9 }, "schema": { "additionalProperties": false, "description": "Paginated ACL versions.", "properties": { "content": { "description": "ACL versions.", "items": { "additionalProperties": false, "properties": { "accountId": { "description": "The unique account ID.", "minLength": 1, "type": "string" }, "createdBy": { "description": "The user who created the version.", "minLength": 1, "type": "string" }, "createdTimestamp": { "description": "ISO 8601 timestamp marking the version's creation.", "minLength": 1, "type": "string" }, "description": { "description": "A description of the version.", "minLength": 1, "type": "string" }, "links": { "description": "Links to related resources.", "items": { "additionalProperties": false, "properties": { "href": { "description": "The version URI.", "minLength": 1, "type": "string" }, "rel": { "description": "The relationship of the link to the version.", "minLength": 1, "type": "string" } }, "required": [ "rel", "href" ], "type": "object" }, "minItems": 0, "type": "array" }, "rulesCount": { "description": "The number of rules in the version.", "minimum": 0, "type": "integer" }, "state": { "description": "ACL version state. Either `CONFIGURATION`, `DEPLOYED`, or `DEPRECATED`.", "enum": [ "CONFIGURATION", "DEPLOYED", "DEPRECATED" ], "type": "string" }, "updatedBy": { "description": "The user who updated the version.", "minLength": 1, "type": "string" }, "updatedTimestamp": { "description": "ISO 8601 timestamp marking the version's last update.", "minLength": 1, "type": "string" }, "version": { "description": "The version number.", "minimum": 0, "type": "integer" } }, "required": [ "description", "version", "accountId", "state", "rulesCount", "createdBy", "createdTimestamp", "updatedBy", "updatedTimestamp", "links" ], "type": "object" }, "minItems": 0, "type": "array" }, "empty": { "description": "Indicates empty results.", "type": "boolean" }, "first": { "description": "Indicates if the first page of results.", "type": "boolean" }, "last": { "description": "Indicates if the last page of results.", "type": "boolean" }, "number": { "description": "The page number.", "minimum": 0, "type": "integer" }, "numberOfElements": { "description": "Number of elements on the page.", "minimum": 0, "type": "integer" }, "pageable": { "additionalProperties": false, "description": "Pagination details.", "properties": { "offset": { "description": "Indicates where to start fetching data or how many records to skip.", "minimum": 0, "type": "integer" }, "pageNumber": { "description": "The page number.", "minimum": 0, "type": "integer" }, "pageSize": { "description": "The page size.", "minimum": 0, "type": "integer" }, "paged": { "description": "Displays the results with pagination.", "type": "boolean" }, "sort": { "additionalProperties": false, "description": "Sorting details.", "properties": { "empty": { "description": "Whether the sorting option is empty.", "type": "boolean" }, "sorted": { "description": "Whether results are sorted.", "type": "boolean" }, "unsorted": { "description": "Whether results are unsorted.", "type": "boolean" } }, "required": [ "unsorted", "sorted", "empty" ], "type": "object" }, "unpaged": { "description": "Indicates if the results are unpaginated.", "type": "boolean" } }, "required": [ "sort", "pageNumber", "pageSize", "offset", "paged", "unpaged" ], "type": "object" }, "size": { "description": "The page size.", "minimum": 0, "type": "integer" }, "sort": { "additionalProperties": false, "description": "Sorting details.", "properties": { "empty": { "description": "Indicates that the sort order is empty.", "type": "boolean" }, "sorted": { "description": "Indicates that the results are unsorted.", "type": "boolean" }, "unsorted": { "description": "Indicates that the results are unsorted.", "type": "boolean" } }, "required": [ "unsorted", "sorted", "empty" ], "type": "object" }, "totalElements": { "description": "Total number of elements in the paginated results.", "minimum": 0, "type": "integer" }, "totalPages": { "description": "Total number of pages in the paginated results.", "minimum": 0, "type": "integer" } }, "required": [ "content", "pageable", "totalPages", "totalElements", "last", "numberOfElements", "number", "first", "sort", "size", "empty" ], "type": "object", "x-akamai": { "file-path": "schemas/all-versions-acl-response-with-pagination.yaml" } } } }, "description": "Successfully retrieved ACL version." }, "400": { "content": { "application/problem+json": { "example": { "args": [ "GET" ], "errorCode": "BAD_REQUEST", "message": "Page size must not be less than one" }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/network-cloud-firewall/reference/400).", "x-akamai": { "file-path": "errors/400-versions-invalid-page.yaml" } }, "404": { "content": { "application/problem+json": { "examples": { "config-not-found": { "summary": "Version config not found", "value": { "$ref": "../examples/404-versions-config-not-found.json" } }, "index-not-found": { "summary": "Version index not found", "value": { "$ref": "../examples/400-versions-index-not-found.json" } }, "version-not-found": { "summary": "Version not found", "value": { "$ref": "../examples/404-versions-not-found.json" } } }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[ACL version doesn't exist](https://techdocs.akamai.com/network-cloud-firewall/reference/404).", "x-akamai": { "file-path": "errors/404-version-not-found.yaml" } } }, "summary": "List versions", "tags": [ "ACL versions" ] }, "x-akamai": { "file-path": "paths/acl-versions.yaml", "path-info": "/acls/versions" } }, "/acls/versions/deployment-status": { "get": { "description": "Retrieves all ACL versions for an account in `PROCESSING` or `PRODUCTION` status. If the deployed version is in production, the response includes the version in production status. If a version deployment has failed, the deployment status is `FAILED`.", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Cloud Firewall API", "url": "https://techdocs.akamai.com/network-cloud-firewall/reference/get-version-deployment-status" }, "operationId": "get-version-deployment-status", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "accountId": "A-CCT9012", "ruleSets": [ { "deploymentStatus": "PRODUCTION", "hash": "133-8ED0D2D1FAF187DBE5E5C3E1B5F2D520", "ruleSet": [ { "aclText": "permit icmp biglist_50 192.0.2.11/31", "installStatus": "INSTALLED", "ruleUuid": "0f2f4799-43d1-4f3b-ad58-1481956f1868" }, { "aclText": "permit tcp src_v6_b-3-1igw5l3 2606:6c00:127:0:0:0:0:d8/127", "installStatus": "INSTALLED", "ruleUuid": "204be40d-c9f2-46ca-b935-f07991080bc3" }, { "aclText": "permit tcp big_v6_1 2606:6c00:127:0:0:0:0:d8/127", "installStatus": "INSTALLED", "ruleUuid": "a5ea92e5-d728-49e8-9c45-4d0894586eb0" } ], "rulesDeployStats": { "failed": 0, "installed": 3, "notInstalled": 0, "total": 3 }, "statusRetrievalTimestamp": "2025-06-09T20:24:49.011+00:00", "version": 133 }, { "deploymentStatus": "PROCESSING", "hash": "134-6273B6F15FA00256726DFC5FCE2A0F66", "ruleSet": [ { "aclText": "permit tcp src_v6_b-3-1igw5l3 2606:6c00:127:0:0:0:0:d8/127", "installStatus": "NOT_INSTALLED", "ruleUuid": "204be40d-c9f2-46ca-b935-f07991080bc3" }, { "aclText": "permit tcp big_v6_1 2606:6c00:127:0:0:0:0:d8/127", "installStatus": "NOT_INSTALLED", "ruleUuid": "a5ea92e5-d728-49e8-9c45-4d0894586eb0" } ], "rulesDeployStats": { "failed": 0, "installed": 0, "notInstalled": 2, "total": 2 }, "statusRetrievalTimestamp": "2025-06-09T20:25:07.863+00:00", "version": 134 } ] }, "schema": { "additionalProperties": false, "description": "ACL deployment status.", "properties": { "accountId": { "description": "Account ID.", "type": "string" }, "ruleSets": { "description": "Production, processing, and failed ACL versions.", "items": { "additionalProperties": false, "description": "ACL versions with deployment status. ", "properties": { "deploymentStatus": { "description": "The ACL version's deployment status. Either `PRODUCTION` for a rule set deployed to the network, `PROCESSING` for a version currently being prepared or staged, or `FAILED` when every rule in the rule set failed to deploy. Check `ruleSet` for the status of each rule set within the version.", "enum": [ "PRODUCTION", "PROCESSING", "FAILED" ], "type": "string" }, "hash": { "description": "The ACL version's hash value used to track updates.", "type": "string" }, "ruleSet": { "description": "Rule set contents and status of the rules within the set. ", "items": { "additionalProperties": false, "description": "Status of rules within the ACL rule set.", "properties": { "aclText": { "description": "ACL rule description. ", "type": "string" }, "installStatus": { "description": "The rule's install status. Either `INSTALLED`, `NOT_INSTALLED`, or `FAILED`.", "enum": [ "INSTALLED", "NOT_INSTALLED", "FAILED" ], "type": "string" }, "ruleUuid": { "description": "The rule's unique ID.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/acl-deployment-status-rule-set.yaml" } }, "type": "array" }, "rulesDeployStats": { "additionalProperties": false, "description": "ACL version rule statistics per deployment status.", "properties": { "failed": { "description": "Number of failed rules within the ACL version.", "minimum": 0, "type": "integer" }, "installed": { "description": "Number of successfully installed rules within the ACL version.", "minimum": 0, "type": "integer" }, "notInstalled": { "description": "Number of rules not yet installed within the ACL version.", "minimum": 0, "type": "integer" }, "total": { "description": "Total number of rules within the ACL version.", "minimum": 0, "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/acl-deployment-status-rules-deploy-stats.yaml" } }, "statusRetrievalTimestamp": { "description": "ISO 8601 timestamp of the status retrieval.", "format": "date-time", "type": "string" }, "version": { "description": "ACL version number.", "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/acl-deployment-status-by-state.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/acl-deployment-status.yaml" } } } }, "description": "The response shows the latest deployed and production ACL version." } }, "summary": "List ACL versions' deployment status", "tags": [ "ACL versions" ] }, "x-akamai": { "file-path": "paths/acl-deployment-status.yaml", "path-info": "/acls/versions/deployment-status" } }, "/acls/versions/{version}": { "get": { "description": "Provides all ACL rules for the version.", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Cloud Firewall API", "url": "https://techdocs.akamai.com/network-cloud-firewall/reference/get-version" }, "operationId": "get-version", "parameters": [ { "description": "When set to `true`, returns parsed rule details for every rule in the rule set for a version.", "in": "query", "name": "details", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/details-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "accountId": "A-CCT9012", "createdBy": "mrossi", "createdTimestamp": "2022-07-15T21:56:57.000+00:00", "description": "Cloning version 9 with all rules enabled", "links": [ { "href": "versions/10", "rel": "self" } ], "ruleSet": [ { "aclText": "remark test", "comment": "test comment", "index": 1, "ipVersion": "V4", "ruleUuid": "b7378dab-4f19-4699-a34c-d623fdf5a769" }, { "aclText": "deny icmp any 198.51.100.0/24 net-redirect", "comment": "test comment", "index": 2, "ipVersion": "V4", "parsed": { "action": "deny", "description": "deny icmp any 198.51.100.0/24 net-redirect", "destinationAddress": "192.0.2.63/24", "established": false, "fragments": false, "icmp": { "icmpCode": 0, "icmpType": 5 }, "ipVersion": "v4", "locations": [], "log": null, "name": "1-Test_rule_v4_2", "oid": "63cbc7c4-b5e8-482e-881b-43bf8b512450", "packetLength": null, "protocol": { "max": 1, "min": 1 }, "sourceAddress": "*", "tcp": null, "ttl": null, "udp": null }, "ruleUuid": "63cbc7c4-b5e8-482e-881b-43bf8b512450" }, { "aclText": "deny tcp any 198.51.100.1/32", "comment": "test comment", "index": 3, "ipVersion": "V4", "parsed": { "action": "deny", "description": "deny tcp any 198.51.100.1/32", "destinationAddress": "192.0.2.81/24", "established": false, "fragments": false, "icmp": null, "ipVersion": "v4", "locations": [], "log": null, "name": "1-Test_rule_v4_3", "oid": "e12105a6-da45-494e-b931-b8f51158e373", "packetLength": null, "protocol": { "max": 6, "min": 6 }, "sourceAddress": "*", "tcp": null, "ttl": null, "udp": null }, "ruleUuid": "e12105a6-da45-494e-b931-b8f51158e373" }, { "aclText": "permit udp any 198.51.100.1/32", "comment": "test comment", "index": 4, "ipVersion": "V4", "parsed": { "action": "permit", "description": "permit udp any 198.51.100.1/32", "destinationAddress": "192.0.2.137/24", "established": false, "fragments": false, "icmp": null, "ipVersion": "v4", "locations": [], "log": null, "name": "1-Test_rule_v4_4", "oid": "a4f177a9-37e6-451b-85a7-604066d2765a", "packetLength": null, "protocol": { "max": 17, "min": 17 }, "sourceAddress": "*", "tcp": null, "ttl": null, "udp": null }, "ruleUuid": "a4f177a9-37e6-451b-85a7-604066d2765a" } ], "state": "DEPLOYED", "updatedBy": null, "updatedTimestamp": null, "version": 10 }, "schema": { "additionalProperties": false, "description": "Extended ACL version and rule set traffic data.", "properties": { "accountId": { "description": "Account ID.", "minLength": 1, "type": "string" }, "createdBy": { "description": "The user who created the version.", "minLength": 1, "type": "string" }, "createdTimestamp": { "description": "ISO 8601 timestamp marking the version's creation.", "minLength": 1, "type": "string" }, "description": { "description": "User description of the version.", "minLength": 1, "type": "string" }, "links": { "description": "Links to related version resources.", "items": { "additionalProperties": false, "properties": { "href": { "description": "The version URI.", "minLength": 1, "type": "string" }, "rel": { "description": "The relationship of the link to the version.", "type": "string" } }, "required": [ "rel", "href" ], "type": "object" }, "minItems": 0, "type": "array" }, "ruleSet": { "description": "Rules within the rule set.", "items": { "additionalProperties": false, "properties": { "aclText": { "description": "ACL user text.", "minLength": 1, "type": "string" }, "comment": { "description": "User provided comments.", "minLength": 1, "type": "string" }, "index": { "description": "ACL rule set order.", "minimum": 0, "type": "integer" }, "ipVersion": { "description": "The IP version, either `V4` or `V6`.", "enum": [ "V4", "V6" ], "type": "string" }, "parsed": { "additionalProperties": false, "description": "Parsed rule details for every rule.", "properties": { "action": { "description": "Rule action.", "minLength": 1, "type": "string" }, "description": { "description": "Rule description.", "minLength": 1, "type": "string" }, "destinationAddress": { "description": "Rule destination address.", "minLength": 1, "type": "string" }, "established": { "description": "Whether the rule is established.", "type": "boolean" }, "fragments": { "description": "Whether fragments exist.", "type": "boolean" }, "icmp": { "additionalProperties": false, "description": "ICMP details.", "nullable": true, "properties": { "icmpCode": { "description": "ICMP code.", "minimum": 0, "type": "integer" }, "icmpType": { "description": "ICMP type.", "minimum": 0, "type": "integer" } }, "required": [ "icmpType", "icmpCode" ], "type": "object" }, "ipVersion": { "description": "The IP version, either `v4` or `v6`.", "enum": [ "v4", "v6" ], "type": "string" }, "locations": { "description": "Version locations.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "log": { "additionalProperties": false, "description": "Logging details.", "nullable": true, "properties": { "interval": { "description": "Logging interval.", "minimum": 0, "type": "integer" }, "level": { "description": "Logging level number.", "minimum": 0, "type": "integer" } }, "required": [ "level", "interval" ], "type": "object" }, "name": { "description": "Rule name.", "minLength": 1, "type": "string" }, "oid": { "description": "Rule ID.", "minLength": 1, "type": "string" }, "packetLength": { "additionalProperties": false, "description": "Packet length.", "nullable": true, "properties": { "max": { "description": "The maximum packet length.", "minimum": 0, "type": "integer" }, "min": { "description": "The minimum packet length.", "minimum": 0, "type": "integer" } }, "required": [ "min", "max" ], "type": "object" }, "protocol": { "additionalProperties": false, "description": "Rule protocol.", "properties": { "max": { "description": "Maximum acceptable number.", "minimum": 0, "type": "integer" }, "min": { "description": "Minimum acceptable number.", "minimum": 0, "type": "integer" } }, "required": [ "min", "max" ], "type": "object" }, "sourceAddress": { "description": "Rule source address.", "minLength": 1, "type": "string" }, "tcp": { "additionalProperties": false, "description": "TCP details.", "nullable": true, "properties": { "destinationPort": { "additionalProperties": false, "description": "Destination port.", "properties": { "max": { "description": "The maximum destination port number.", "minimum": 0, "type": "integer" }, "min": { "description": "The minimum destination port number.", "minimum": 0, "type": "integer" } }, "required": [ "min", "max" ], "type": "object" }, "sourcePort": { "additionalProperties": false, "description": "The source port.", "properties": { "max": { "description": "The maximum source port number.", "minimum": 0, "type": "integer" }, "min": { "description": "The minimum source port number.", "minimum": 0, "type": "integer" } }, "required": [ "min", "max" ], "type": "object" } }, "required": [ "sourcePort", "destinationPort" ], "type": "object" }, "ttl": { "additionalProperties": false, "description": "A rule's time to live data.", "nullable": true, "properties": { "max": { "description": "The maximum acceptable TTL number.", "minimum": 0, "type": "integer" }, "min": { "description": "The minimum acceptable TTL number.", "minimum": 0, "type": "integer" } }, "required": [ "min", "max" ], "type": "object" }, "udp": { "additionalProperties": false, "description": "UDP details.", "nullable": true, "properties": { "destinationPort": { "additionalProperties": false, "description": "Destination port.", "properties": { "max": { "description": "The maximum destination port number.", "minimum": 0, "type": "integer" }, "min": { "description": "The minimum destination port number.", "minimum": 0, "type": "integer" } }, "required": [ "min", "max" ], "type": "object" }, "sourcePort": { "additionalProperties": false, "description": "Source port.", "properties": { "max": { "description": "The maximum source port number.", "minimum": 0, "type": "integer" }, "min": { "description": "The minimum source port number.", "minimum": 0, "type": "integer" } }, "required": [ "min", "max" ], "type": "object" } }, "required": [ "sourcePort", "destinationPort" ], "type": "object" } }, "required": [ "name", "description", "oid", "action", "protocol", "sourceAddress", "destinationAddress", "ipVersion", "ttl", "packetLength", "fragments", "established", "tcp", "udp", "icmp", "log", "locations" ], "type": "object" }, "ruleUuid": { "description": "The ACL rule ID.", "minLength": 1, "type": "string" } }, "required": [ "index", "aclText", "ruleUuid", "ipVersion", "comment" ], "type": "object" }, "minItems": 0, "type": "array" }, "state": { "description": "ACL version state. Either `CONFIGURATION`, `DEPLOYED`, or `DEPRECATED`.", "enum": [ "CONFIGURATION", "DEPLOYED", "DEPRECATED" ], "type": "string" }, "updatedBy": { "description": "The user who updated the version.", "minLength": 1, "nullable": true, "type": "string" }, "updatedTimestamp": { "description": "ISO 8601 timestamp marking the version's last update.", "minLength": 1, "nullable": true, "type": "string" }, "version": { "description": "Version number.", "minimum": 0, "type": "integer" } }, "required": [ "description", "version", "accountId", "state", "ruleSet", "createdBy", "createdTimestamp", "updatedBy", "updatedTimestamp", "links" ], "type": "object", "x-akamai": { "file-path": "schemas/single-acl-version-ext-response.yaml" } } } }, "description": "Successfully retrieved ACL version." }, "404": { "content": { "application/problem+json": { "examples": { "config-not-found": { "summary": "Version config not found", "value": { "$ref": "../examples/404-versions-config-not-found.json" } }, "index-not-found": { "summary": "Version index not found", "value": { "$ref": "../examples/400-versions-index-not-found.json" } }, "version-not-found": { "summary": "Version not found", "value": { "$ref": "../examples/404-versions-not-found.json" } } }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[ACL version doesn't exist](https://techdocs.akamai.com/network-cloud-firewall/reference/404).", "x-akamai": { "file-path": "errors/404-version-not-found.yaml" } } }, "summary": "Get an ACL version", "tags": [ "ACL versions" ] }, "put": { "description": "Updates ACL versions in `CONFIGURATION` state only. You can add or delete the version's rules or move the version to `DEPLOYED` state.", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Cloud Firewall API", "url": "https://techdocs.akamai.com/network-cloud-firewall/reference/put-update-version" }, "operationId": "put-update-version", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "deploy": true, "description": "test comment", "ruleSet": [ { "aclText": "deny tcp any 2001:0db8:0:0:0:0:0:0/128", "comment": " ", "index": 1, "ipVersion": "V6" }, { "aclText": "deny tcp any 198.51.100.0/24", "comment": " ", "index": 1, "ipVersion": "V4" } ] }, "schema": { "additionalProperties": false, "description": "ACL version update properties.", "properties": { "deploy": { "description": "Whether the ACL config version needs to be deployed. When `false`, creates a new version in `CONFIGURATION` state. When `true`, creates a version in `DEPLOYED` state.", "type": "boolean" }, "description": { "description": "Version description.", "minLength": 1, "type": "string" }, "ruleSet": { "description": "The rules within the rule set.", "items": { "additionalProperties": false, "properties": { "aclText": { "description": "ACL user text.", "minLength": 1, "type": "string" }, "comment": { "description": "Comments.", "minLength": 1, "type": "string" }, "index": { "description": "ACL rules ordering.", "minimum": 1, "type": "integer" }, "ipVersion": { "description": "The IP version, either `V4` or `V6`.", "enum": [ "V4", "V6" ], "type": "string" }, "ruleUuid": { "description": "A unique rule ID.", "minLength": 1, "type": "string" } }, "required": [ "index", "aclText" ], "type": "object" }, "minItems": 0, "type": "array" } }, "required": [ "deploy", "description", "ruleSet" ], "type": "object", "x-akamai": { "file-path": "schemas/update-acl-version-request.yaml" } } } } }, "responses": { "200": { "content": { "application/json": { "example": { "accountId": "A-CCT3456", "createdBy": "asingh", "createdTimestamp": "2022-07-15T21:56:57.000+00:00", "description": "Cloning version 9 with all rules enabled", "ruleSet": [ { "aclText": "remark test", "comment": "test comment", "index": 1, "ipVersion": "V4", "ruleUuid": "b7378dab-4f19-4699-a34c-d623fdf5a769" }, { "aclText": "deny icmp any 198.51.100.0/24 net-redirect", "comment": "test comment", "index": 2, "ipVersion": "V4", "ruleUuid": "63cbc7c4-b5e8-482e-881b-43bf8b512450" }, { "aclText": "deny tcp any 198.51.100.1/32", "comment": "test comment", "index": 3, "ipVersion": "V4", "ruleUuid": "e12105a6-da45-494e-b931-b8f51158e373" }, { "aclText": "permit udp any 198.51.100.1/32", "comment": "test comment", "index": 4, "ipVersion": "V4", "ruleUuid": "a4f177a9-37e6-451b-85a7-604066d2765a" }, { "aclText": "deny udp GEO::CA 198.51.100.0/32", "comment": "Blocking all udp traffic from Canada", "index": 5, "ipVersion": "V4", "ruleUuid": "a5f177a9-37e6-451b-85a7-604066d2765a" }, { "aclText": "deny tcp any 2606:6c00:127:0:0:0:0:d8/127", "comment": "test comment", "index": 1, "ipVersion": "V6", "ruleUuid": "a56177a9-37e6-451b-85a7-604066d2765a" } ], "state": "DEPLOYED", "updatedBy": "alfulani", "updatedTimestamp": "2022-08-15T21:56:57.000+00:00", "version": 10 }, "schema": { "additionalProperties": false, "description": "ACL version and rule set traffic data.", "properties": { "accountId": { "description": "Account ID.", "minLength": 1, "type": "string" }, "createdBy": { "description": "The user who created the version.", "minLength": 1, "type": "string" }, "createdTimestamp": { "description": "ISO 8601 timestamp marking the version's creation.", "minLength": 1, "type": "string" }, "description": { "description": "A description of the version.", "minLength": 1, "type": "string" }, "ruleSet": { "description": "The rules within the rule set.", "items": { "additionalProperties": false, "properties": { "aclText": { "description": "ACL user text.", "minLength": 1, "type": "string" }, "comment": { "description": "User-provided comments.", "minLength": 1, "type": "string" }, "index": { "description": "The ACL rule order.", "minimum": 1, "type": "integer" }, "ipVersion": { "description": "The IP version, either `V4` or `V6`.", "enum": [ "V4", "V6" ], "type": "string" }, "ruleUuid": { "description": "A unique rule ID.", "minLength": 1, "type": "string" } }, "required": [ "index", "aclText", "ruleUuid", "ipVersion", "comment" ], "type": "object" }, "minItems": 0, "type": "array" }, "state": { "description": "ACL version state. Either `CONFIGURATION`, `DEPLOYED`, or `DEPRECATED`.", "enum": [ "CONFIGURATION", "DEPLOYED", "DEPRECATED" ], "type": "string" }, "updatedBy": { "description": "The user who updated the version.", "minLength": 1, "nullable": true, "type": "string" }, "updatedTimestamp": { "description": "ISO 8601 timestamp marking the version's last update.", "minLength": 1, "nullable": true, "type": "string" }, "version": { "description": "Version number.", "minimum": 1, "type": "integer" } }, "required": [ "description", "version", "accountId", "state", "ruleSet", "createdBy", "createdTimestamp", "updatedBy", "updatedTimestamp" ], "type": "object", "x-akamai": { "file-path": "schemas/single-acl-version-response.yaml" } } } }, "description": "Successfully updated the ACL rule's version." }, "400": { "content": { "application/problem+json": { "examples": { "any-not-allowed": { "summary": "Any Destination not allowed", "value": { "$ref": "../examples/400-versions-any-not-allowed.json" } }, "destination-not-allowed": { "summary": "Destination not allowed", "value": { "$ref": "../examples/400-versions-destination-not-allowed.json" } }, "duplicate-acl-text": { "summary": "ACL text duplicate", "value": { "$ref": "../examples/400-versions-duplicate-acl-text.json" } }, "field-invalid": { "summary": "Field invalid", "value": { "$ref": "../examples/400-versions-invalid-field.json" } }, "field-missing": { "summary": "Field missing", "value": { "$ref": "../examples/400-field-missing.json" } }, "invalid-acl-text": { "summary": "ACL text invalid", "value": { "$ref": "../examples/400-versions-invalid-acl-text.json" } }, "invalid-asn": { "summary": "ASN invalid", "value": { "$ref": "../examples/400-asn-invalid.json" } }, "version-config-exists": { "summary": "Version config already exists", "value": { "$ref": "../examples/400-versions-config-exists.json" } }, "version-invalid-index": { "summary": "Invalid version index", "value": { "$ref": "../examples/400-versions-invalid-index.json" } }, "version-limit-exceeded": { "summary": "Version exceeds limit", "value": { "$ref": "../examples/400-versions-exceeds-limit.json" } }, "versions-not-allowed": { "summary": "Versions not allowed", "value": { "$ref": "../examples/400-versions-not-allowed.json" } } }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/network-cloud-firewall/reference/400).", "x-akamai": { "file-path": "errors/400-versions.yaml" } }, "404": { "content": { "application/problem+json": { "examples": { "config-not-found": { "summary": "Version config not found", "value": { "$ref": "../examples/404-versions-config-not-found.json" } }, "index-not-found": { "summary": "Version index not found", "value": { "$ref": "../examples/400-versions-index-not-found.json" } }, "version-not-found": { "summary": "Version not found", "value": { "$ref": "../examples/404-versions-not-found.json" } } }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[ACL version doesn't exist](https://techdocs.akamai.com/network-cloud-firewall/reference/404).", "x-akamai": { "file-path": "errors/404-version-not-found.yaml" } }, "409": { "content": { "application/problem+json": { "example": { "args": [ "version", "same set of acl rules in CONFIGURATION state" ], "errorCode": "ALREADY_EXISTS", "message": "version with same set of acl rules in CONFIGURATION state already exists." }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Conflict](https://techdocs.akamai.com/network-cloud-firewall/reference/409).", "x-akamai": { "file-path": "errors/409-version-already-exists.yaml" } } }, "summary": "Update an ACL version", "tags": [ "ACL versions" ] }, "patch": { "description": "Updates the deployment state of an existing version. Version state change is unidirectional. A version currently in `CONFIGURATION` state can be moved to `DEPLOYED` or `DEPRECATED` state. A version currently in `DEPLOYED` state can be moved only to `DEPRECATED` state.", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Cloud Firewall API", "url": "https://techdocs.akamai.com/network-cloud-firewall/reference/patch-version" }, "operationId": "patch-version", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "state": "DEPLOYED" }, "schema": { "additionalProperties": false, "description": "ACL version state update properties.", "properties": { "state": { "description": "ACL version state. Either `DEPLOYED` or `DEPRECATED`. Only ACL versions in `CONFIGURATION` state can be updated.", "enum": [ "DEPLOYED", "DEPRECATED" ], "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/acl-version-state-update-request.yaml" } } } } }, "responses": { "200": { "content": { "application/json": { "example": { "accountId": "A-CCT3456", "createdBy": "asingh", "createdTimestamp": "2022-07-15T21:56:57.000+00:00", "description": "Cloning version 9 with all rules enabled", "ruleSet": [ { "aclText": "remark test", "comment": "test comment", "index": 1, "ipVersion": "V4", "ruleUuid": "b7378dab-4f19-4699-a34c-d623fdf5a769" }, { "aclText": "deny icmp any 198.51.100.0/24 net-redirect", "comment": "test comment", "index": 2, "ipVersion": "V4", "ruleUuid": "63cbc7c4-b5e8-482e-881b-43bf8b512450" }, { "aclText": "deny tcp any 198.51.100.1/32", "comment": "test comment", "index": 3, "ipVersion": "V4", "ruleUuid": "e12105a6-da45-494e-b931-b8f51158e373" }, { "aclText": "permit udp any 198.51.100.1/32", "comment": "test comment", "index": 4, "ipVersion": "V4", "ruleUuid": "a4f177a9-37e6-451b-85a7-604066d2765a" }, { "aclText": "deny udp GEO::CA 198.51.100.0/32", "comment": "Blocking all udp traffic from Canada", "index": 5, "ipVersion": "V4", "ruleUuid": "a5f177a9-37e6-451b-85a7-604066d2765a" }, { "aclText": "deny tcp any 2606:6c00:127:0:0:0:0:d8/127", "comment": "test comment", "index": 1, "ipVersion": "V6", "ruleUuid": "a56177a9-37e6-451b-85a7-604066d2765a" } ], "state": "DEPLOYED", "updatedBy": "alfulani", "updatedTimestamp": "2022-08-15T21:56:57.000+00:00", "version": 10 }, "schema": { "additionalProperties": false, "description": "ACL version and rule set traffic data.", "properties": { "accountId": { "description": "Account ID.", "minLength": 1, "type": "string" }, "createdBy": { "description": "The user who created the version.", "minLength": 1, "type": "string" }, "createdTimestamp": { "description": "ISO 8601 timestamp marking the version's creation.", "minLength": 1, "type": "string" }, "description": { "description": "A description of the version.", "minLength": 1, "type": "string" }, "ruleSet": { "description": "The rules within the rule set.", "items": { "additionalProperties": false, "properties": { "aclText": { "description": "ACL user text.", "minLength": 1, "type": "string" }, "comment": { "description": "User-provided comments.", "minLength": 1, "type": "string" }, "index": { "description": "The ACL rule order.", "minimum": 1, "type": "integer" }, "ipVersion": { "description": "The IP version, either `V4` or `V6`.", "enum": [ "V4", "V6" ], "type": "string" }, "ruleUuid": { "description": "A unique rule ID.", "minLength": 1, "type": "string" } }, "required": [ "index", "aclText", "ruleUuid", "ipVersion", "comment" ], "type": "object" }, "minItems": 0, "type": "array" }, "state": { "description": "ACL version state. Either `CONFIGURATION`, `DEPLOYED`, or `DEPRECATED`.", "enum": [ "CONFIGURATION", "DEPLOYED", "DEPRECATED" ], "type": "string" }, "updatedBy": { "description": "The user who updated the version.", "minLength": 1, "nullable": true, "type": "string" }, "updatedTimestamp": { "description": "ISO 8601 timestamp marking the version's last update.", "minLength": 1, "nullable": true, "type": "string" }, "version": { "description": "Version number.", "minimum": 1, "type": "integer" } }, "required": [ "description", "version", "accountId", "state", "ruleSet", "createdBy", "createdTimestamp", "updatedBy", "updatedTimestamp" ], "type": "object", "x-akamai": { "file-path": "schemas/single-acl-version-response.yaml" } } } }, "description": "Successfully updated state of ACL rules version." }, "400": { "content": { "application/problem+json": { "examples": { "any-not-allowed": { "summary": "Any Destination not allowed", "value": { "$ref": "../examples/400-versions-any-not-allowed.json" } }, "destination-not-allowed": { "summary": "Destination not allowed", "value": { "$ref": "../examples/400-versions-destination-not-allowed.json" } }, "duplicate-acl-text": { "summary": "ACL text duplicate", "value": { "$ref": "../examples/400-versions-duplicate-acl-text.json" } }, "field-invalid": { "summary": "Field invalid", "value": { "$ref": "../examples/400-versions-invalid-field.json" } }, "field-missing": { "summary": "Field missing", "value": { "$ref": "../examples/400-field-missing.json" } }, "invalid-acl-text": { "summary": "ACL text invalid", "value": { "$ref": "../examples/400-versions-invalid-acl-text.json" } }, "invalid-asn": { "summary": "ASN invalid", "value": { "$ref": "../examples/400-asn-invalid.json" } }, "version-config-exists": { "summary": "Version config already exists", "value": { "$ref": "../examples/400-versions-config-exists.json" } }, "version-invalid-index": { "summary": "Invalid version index", "value": { "$ref": "../examples/400-versions-invalid-index.json" } }, "version-limit-exceeded": { "summary": "Version exceeds limit", "value": { "$ref": "../examples/400-versions-exceeds-limit.json" } }, "versions-not-allowed": { "summary": "Versions not allowed", "value": { "$ref": "../examples/400-versions-not-allowed.json" } } }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/network-cloud-firewall/reference/400).", "x-akamai": { "file-path": "errors/400-versions.yaml" } }, "404": { "content": { "application/problem+json": { "examples": { "config-not-found": { "summary": "Version config not found", "value": { "$ref": "../examples/404-versions-config-not-found.json" } }, "index-not-found": { "summary": "Version index not found", "value": { "$ref": "../examples/400-versions-index-not-found.json" } }, "version-not-found": { "summary": "Version not found", "value": { "$ref": "../examples/404-versions-not-found.json" } } }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[ACL version doesn't exist](https://techdocs.akamai.com/network-cloud-firewall/reference/404).", "x-akamai": { "file-path": "errors/404-version-not-found.yaml" } } }, "summary": "Update an ACL version's deployment state", "tags": [ "ACL versions" ] }, "parameters": [ { "description": "The ACL version number.", "in": "path", "name": "version", "required": true, "schema": { "example": 15, "type": "integer" }, "x-akamai": { "file-path": "parameters/version-path.yaml" } } ], "x-akamai": { "file-path": "paths/acl-versions-by-id.yaml", "path-info": "/acls/versions/{version}" } }, "/acls/versions/{version}/clone": { "post": { "description": "Clones an existing ACL version when there's no `CONFIGURATION` version. Creates a new version in `CONFIGURATION` state.", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Cloud Firewall API", "url": "https://techdocs.akamai.com/network-cloud-firewall/reference/post-version-clone" }, "operationId": "post-version-clone", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "example": { "accountId": "A-CCT3456", "createdBy": "asingh", "createdTimestamp": "2022-07-15T21:56:57.000+00:00", "description": "Cloning version 9 with all rules enabled", "ruleSet": [ { "aclText": "remark test", "comment": "test comment", "index": 1, "ipVersion": "V4", "ruleUuid": "b7378dab-4f19-4699-a34c-d623fdf5a769" }, { "aclText": "deny icmp any 198.51.100.0/24 net-redirect", "comment": "test comment", "index": 2, "ipVersion": "V4", "ruleUuid": "63cbc7c4-b5e8-482e-881b-43bf8b512450" }, { "aclText": "deny tcp any 198.51.100.1/32", "comment": "test comment", "index": 3, "ipVersion": "V4", "ruleUuid": "e12105a6-da45-494e-b931-b8f51158e373" }, { "aclText": "permit udp any 198.51.100.1/32", "comment": "test comment", "index": 4, "ipVersion": "V4", "ruleUuid": "a4f177a9-37e6-451b-85a7-604066d2765a" }, { "aclText": "deny udp GEO::CA 198.51.100.0/32", "comment": "Blocking all udp traffic from Canada", "index": 5, "ipVersion": "V4", "ruleUuid": "a5f177a9-37e6-451b-85a7-604066d2765a" }, { "aclText": "deny tcp any 2606:6c00:127:0:0:0:0:d8/127", "comment": "test comment", "index": 1, "ipVersion": "V6", "ruleUuid": "a56177a9-37e6-451b-85a7-604066d2765a" } ], "state": "CONFIGURATION", "updatedBy": "alfulani", "updatedTimestamp": "2022-08-15T21:56:57.000+00:00", "version": 10 }, "schema": { "additionalProperties": false, "description": "ACL version and rule set traffic data.", "properties": { "accountId": { "description": "Account ID.", "minLength": 1, "type": "string" }, "createdBy": { "description": "The user who created the version.", "minLength": 1, "type": "string" }, "createdTimestamp": { "description": "ISO 8601 timestamp marking the version's creation.", "minLength": 1, "type": "string" }, "description": { "description": "A description of the version.", "minLength": 1, "type": "string" }, "ruleSet": { "description": "The rules within the rule set.", "items": { "additionalProperties": false, "properties": { "aclText": { "description": "ACL user text.", "minLength": 1, "type": "string" }, "comment": { "description": "User-provided comments.", "minLength": 1, "type": "string" }, "index": { "description": "The ACL rule order.", "minimum": 1, "type": "integer" }, "ipVersion": { "description": "The IP version, either `V4` or `V6`.", "enum": [ "V4", "V6" ], "type": "string" }, "ruleUuid": { "description": "A unique rule ID.", "minLength": 1, "type": "string" } }, "required": [ "index", "aclText", "ruleUuid", "ipVersion", "comment" ], "type": "object" }, "minItems": 0, "type": "array" }, "state": { "description": "ACL version state. Either `CONFIGURATION`, `DEPLOYED`, or `DEPRECATED`.", "enum": [ "CONFIGURATION", "DEPLOYED", "DEPRECATED" ], "type": "string" }, "updatedBy": { "description": "The user who updated the version.", "minLength": 1, "nullable": true, "type": "string" }, "updatedTimestamp": { "description": "ISO 8601 timestamp marking the version's last update.", "minLength": 1, "nullable": true, "type": "string" }, "version": { "description": "Version number.", "minimum": 1, "type": "integer" } }, "required": [ "description", "version", "accountId", "state", "ruleSet", "createdBy", "createdTimestamp", "updatedBy", "updatedTimestamp" ], "type": "object", "x-akamai": { "file-path": "schemas/single-acl-version-response.yaml" } } } }, "description": "Successfully cloned existing version and created a new version.", "headers": { "Location": { "description": "The unique identifier for the newly created resource. Append this ID to a subsequent GET call to view the resource details.", "schema": { "example": 1100, "type": "integer" }, "x-akamai": { "file-path": "headers/location-header.yaml" } } } }, "400": { "content": { "application/problem+json": { "examples": { "any-not-allowed": { "summary": "Any Destination not allowed", "value": { "$ref": "../examples/400-versions-any-not-allowed.json" } }, "destination-not-allowed": { "summary": "Destination not allowed", "value": { "$ref": "../examples/400-versions-destination-not-allowed.json" } }, "duplicate-acl-text": { "summary": "ACL text duplicate", "value": { "$ref": "../examples/400-versions-duplicate-acl-text.json" } }, "field-invalid": { "summary": "Field invalid", "value": { "$ref": "../examples/400-versions-invalid-field.json" } }, "field-missing": { "summary": "Field missing", "value": { "$ref": "../examples/400-field-missing.json" } }, "invalid-acl-text": { "summary": "ACL text invalid", "value": { "$ref": "../examples/400-versions-invalid-acl-text.json" } }, "invalid-asn": { "summary": "ASN invalid", "value": { "$ref": "../examples/400-asn-invalid.json" } }, "version-config-exists": { "summary": "Version config already exists", "value": { "$ref": "../examples/400-versions-config-exists.json" } }, "version-invalid-index": { "summary": "Invalid version index", "value": { "$ref": "../examples/400-versions-invalid-index.json" } }, "version-limit-exceeded": { "summary": "Version exceeds limit", "value": { "$ref": "../examples/400-versions-exceeds-limit.json" } }, "versions-not-allowed": { "summary": "Versions not allowed", "value": { "$ref": "../examples/400-versions-not-allowed.json" } } }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/network-cloud-firewall/reference/400).", "x-akamai": { "file-path": "errors/400-versions.yaml" } }, "404": { "content": { "application/problem+json": { "examples": { "config-not-found": { "summary": "Version config not found", "value": { "$ref": "../examples/404-versions-config-not-found.json" } }, "index-not-found": { "summary": "Version index not found", "value": { "$ref": "../examples/400-versions-index-not-found.json" } }, "version-not-found": { "summary": "Version not found", "value": { "$ref": "../examples/404-versions-not-found.json" } } }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[ACL version doesn't exist](https://techdocs.akamai.com/network-cloud-firewall/reference/404).", "x-akamai": { "file-path": "errors/404-version-not-found.yaml" } } }, "summary": "Clone an ACL version", "tags": [ "ACL versions" ] }, "parameters": [ { "description": "The ACL version number.", "in": "path", "name": "version", "required": true, "schema": { "example": 15, "type": "integer" }, "x-akamai": { "file-path": "parameters/version-path.yaml" } } ], "x-akamai": { "file-path": "paths/acl-versions-clone.yaml", "path-info": "/acls/versions/{version}/clone" } }, "/policy-domains/{policyDomain}/managed-services-acls/rule-hits": { "get": { "description": "Lists Managed Services ACL rule match statistics.", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Cloud Firewall API", "url": "https://techdocs.akamai.com/network-cloud-firewall/reference/get-managed-acl-rule-hits-for-policy-domain" }, "operationId": "get-managed-acl-rule-hits-for-policy-domain", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "policyDomain": "US_prod", "rules": [ { "bytes": 15320724013248, "firstMatch": "2025-01-26T13:41:59.000+00:00", "lastMatch": "2025-11-04T03:41:59.000+00:00", "lastReset": "2025-11-04T03:41:59.000+00:00", "lastUpdated": "2025-11-04T03:42:04.443+00:00", "matches": 96437912065, "ruleUuid": "6a754868-4d48-4890-a5ee-58841549d196" }, { "bytes": 156473805, "firstMatch": "2025-10-07T21:43:59.000+00:00", "lastMatch": "2025-11-04T03:47:59.000+00:00", "lastReset": "2025-11-04T03:41:59.000+00:00", "lastUpdated": "2025-11-04T03:48:04.441+00:00", "matches": 2162843, "ruleUuid": "e3b2c1f7-9a23-4c8b-b2d1-7f8e6a5c4b21" } ] }, "schema": { "additionalProperties": false, "properties": { "policyDomain": { "description": "Policy domain name.", "minLength": 1, "type": "string" }, "rules": { "description": "Managed Services ACL rule set matches.", "items": { "additionalProperties": false, "properties": { "bytes": { "description": "The rule size in bytes.", "minimum": 0, "type": "integer" }, "firstMatch": { "description": "The first rule match.", "minLength": 1, "type": "string" }, "lastMatch": { "description": "The last rule match.", "minLength": 1, "type": "string" }, "lastReset": { "description": "The last time the rule statistics were reset.", "minLength": 1, "type": "string" }, "lastUpdated": { "description": "The time rule match statistics last changed, including match receipt, aggregation, and manual statistics resets.", "minLength": 1, "type": "string" }, "matches": { "description": "The number of rule matches.", "minimum": 0, "type": "integer" }, "ruleUuid": { "description": "Unique rule ID.", "minLength": 1, "type": "string" } }, "required": [ "ruleUuid", "matches", "bytes", "lastUpdated", "firstMatch", "lastMatch", "lastReset" ], "type": "object" }, "type": "array" } }, "required": [ "policyDomain", "rules" ], "type": "object", "x-akamai": { "file-path": "schemas/managed-services-rule-hits-response.yaml" } } } }, "description": "Successfully retrieved match statistics for managed services ACL rules." }, "403": { "content": { "application/problem+json": { "example": { "data": "Insufficient privileges", "errorCode": "INSUFFICIENT_PRIVILEGES", "errorPaths": [ { "message": "Insufficient privileges", "path": "USER_INSUFFICIENT_PRIVILEGES" } ], "status": 403 }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/network-cloud-firewall/reference/403).", "x-akamai": { "file-path": "errors/403-managed-services-rule-hits.yaml" } } }, "summary": "List Managed Services ACL rule match statistics", "tags": [ "Managed Services ACL rule hits" ] }, "parameters": [ { "description": "Policy domain name.", "in": "path", "name": "policyDomain", "required": true, "schema": { "example": "US_prod", "type": "string" }, "x-akamai": { "file-path": "parameters/policy-domain-path.yaml" } } ], "x-akamai": { "file-path": "paths/managed-services-rule-hits.yaml", "path-info": "/managed-services-acls/rule-hits" } }, "/policy-domains/{policyDomain}/managed-services-acls/version": { "get": { "description": "List the latest managed ACL version and its rules for the policy domains of the account. Only one ACL version can be in `CONFIGURATION` or `DEPLOYED` state.", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Cloud Firewall API", "url": "https://techdocs.akamai.com/network-cloud-firewall/reference/get-managed-acl-version" }, "operationId": "get-managed-acl-version", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "createdBy": "jperez", "createdTimestamp": "2022-10-24T21:54:07.000Z", "policyDomain": "US_prod", "ruleSet": [ { "aclText": "permit ipv4 198.51.100.10/30 192.0.2.1/32", "anyDestination": false, "destination": "192.0.2.1/32", "index": 2, "ipVersion": "V4", "locations": [ "lga2" ], "ruleUuid": "487dd1aa-6d08-4a7e-a1c4-3e3f55c8edac" }, { "aclText": "permit ipv4 198.51.100.10/30 203.0.113.5/32", "anyDestination": false, "destination": "203.0.113.5/32", "index": 3, "ipVersion": "V4", "locations": [ "lga2" ], "ruleUuid": "13ad691a-e8c9-419b-87a9-9c3eec54f585" } ], "state": "DEPLOYED", "updatedBy": "mrossi", "updatedTimestamp": "2022-10-24T21:54:07.000Z", "version": 40 }, "schema": { "additionalProperties": false, "description": "Managed Services ACL version and rule set data.", "properties": { "createdBy": { "description": "User who created the version.", "minLength": 1, "type": "string" }, "createdTimestamp": { "description": "ISO 8601 timestamp of the ACL's creation.", "minLength": 1, "type": "string" }, "policyDomain": { "description": "Policy domain name.", "minLength": 1, "type": "string" }, "ruleSet": { "description": "The rules within the Managed Services ACL rule set.", "items": { "additionalProperties": false, "properties": { "aclText": { "description": "ACL rule text.", "minLength": 1, "type": "string" }, "anyDestination": { "description": "Whether the rule applies to an `any` destination.", "type": "boolean" }, "destination": { "description": "Destination IP/CIDR when `anyDestination` is false.", "minLength": 1, "type": "string" }, "index": { "description": "Rule order.", "minimum": 1, "type": "integer" }, "ipVersion": { "description": "IP version, either `V4` or `V6`.", "enum": [ "V4", "V6" ], "type": "string" }, "locations": { "description": "Scrubbing center locations. If empty, applies to all locations. ", "items": { "minLength": 0, "type": "string" }, "type": "array" }, "ruleUuid": { "description": "Unique rule ID.", "minLength": 1, "type": "string" } }, "required": [ "ruleUuid", "index", "ipVersion", "anyDestination", "destination", "aclText", "locations" ], "type": "object" }, "minItems": 0, "type": "array" }, "state": { "description": "ACL version state. Either `CONFIGURATION`, `DEPLOYED`, or `DEPRECATED`.", "enum": [ "CONFIGURATION", "DEPLOYED", "DEPRECATED" ], "type": "string" }, "updatedBy": { "description": "User who last updated the version.", "minLength": 1, "nullable": true, "type": "string" }, "updatedTimestamp": { "description": "ISO 8601 timestamp of the ACL's last update.", "minLength": 1, "nullable": true, "type": "string" }, "version": { "description": "Version number.", "minimum": 1, "type": "integer" } }, "required": [ "policyDomain", "version", "state", "createdBy", "createdTimestamp", "updatedBy", "updatedTimestamp", "ruleSet" ], "type": "object", "x-akamai": { "file-path": "schemas/managed-services-acl-response.yaml" } } } }, "description": "Successfully retrieved latest ACL version." }, "403": { "content": { "application/problem+json": { "example": { "args": [ "policyDomain", "US_prod" ], "data": "Insufficient privileges to access policyDomain=US_prod.", "errorCode": "INSUFFICIENT_PRIVILEGES", "status": 403 }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/network-cloud-firewall/reference/403).", "x-akamai": { "file-path": "errors/403-managed-services-acl.yaml" } } }, "summary": "Get latest Managed Services ACL version", "tags": [ "Managed Services ACL" ] }, "parameters": [ { "description": "Policy domain name.", "in": "path", "name": "policyDomain", "required": true, "schema": { "example": "US_prod", "type": "string" }, "x-akamai": { "file-path": "parameters/policy-domain-path.yaml" } } ], "x-akamai": { "file-path": "paths/managed-services-acl.yaml", "path-info": "/managed-services-acls/version" } }, "/rule-hits/rules": { "get": { "description": "Lists rule match statistics for all rules.", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Cloud Firewall API", "url": "https://techdocs.akamai.com/network-cloud-firewall/reference/get-rule-hits-for-account" }, "operationId": "get-rule-hits-for-account", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "rules": [ { "bytes": 10039062, "firstMatch": "2021-07-21T10:23:07.000Z", "lastMatch": "2021-09-09T16:41:41.090Z", "lastReset": "2021-09-09T16:41:41.090Z", "lastUpdated": "2021-09-09T16:41:41.090Z", "matches": 456321, "ruleId": "d3455bab-592b-4583-baf4-e5bca1cc9ff0" } ], "rulesetName": "Cloud_West", "rulesetType": "CLOUD_FW" }, "schema": { "additionalProperties": false, "description": "Rule statistics per rule set.", "properties": { "rules": { "description": "The rules in the rule set.", "items": { "additionalProperties": false, "properties": { "bytes": { "description": "The rule size in bytes.", "minimum": 0, "type": "integer" }, "firstMatch": { "description": "The first rule match.", "minLength": 1, "type": "string" }, "lastMatch": { "description": "The last rule match.", "minLength": 1, "type": "string" }, "lastReset": { "description": "The last time the rule statistics were reset.", "minLength": 1, "type": "string" }, "lastUpdated": { "description": "The time rule match statistics last changed, including match receipt, aggregation, and manual statistics resets.", "minLength": 1, "type": "string" }, "matches": { "description": "The number of rule matches.", "minimum": 0, "type": "integer" }, "ruleId": { "description": "The rule ID.", "minLength": 1, "type": "string" } }, "required": [ "ruleId", "matches", "bytes", "lastUpdated", "firstMatch", "lastMatch" ], "type": "object" }, "minItems": 0, "type": "array" }, "rulesetName": { "description": "The rule set name.", "minLength": 1, "type": "string" }, "rulesetType": { "description": "The rule set type. ", "minLength": 1, "type": "string" } }, "required": [ "rulesetName", "rulesetType", "rules" ], "type": "object", "x-akamai": { "file-path": "schemas/rule-stats-response.yaml" } } } }, "description": "Successfully retrieved match statistics for rules." } }, "summary": "List rule match statistics for all rules", "tags": [ "ACL rule hits" ] }, "delete": { "description": "Deletes rule match statistics for all rules.", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Cloud Firewall API", "url": "https://techdocs.akamai.com/network-cloud-firewall/reference/delete-rule-hits" }, "operationId": "delete-rule-hits", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "204": { "content": {}, "description": "Success." } }, "summary": "Delete rule match statistics", "tags": [ "ACL rule hits" ] }, "x-akamai": { "file-path": "paths/rule-hits.yaml", "path-info": "/rule-hits/rules" } }, "/rule-hits/rules/{ruleId}": { "get": { "description": "Gets rule match statistics for a rule.", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Cloud Firewall API", "url": "https://techdocs.akamai.com/network-cloud-firewall/reference/get-rule-hits" }, "operationId": "get-rule-hits", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "bytes": 10039062, "firstMatch": "2021-07-21T10:23:07.000Z", "lastMatch": "2021-09-09T16:41:41.090Z", "lastReset": "2021-09-09T16:41:41.090Z", "lastUpdated": "2021-09-09T16:41:41.090Z", "matches": 456321, "ruleId": "d3455bab-592b-4583-baf4-e5bca1cc9ff0" }, "schema": { "additionalProperties": false, "description": "Rule statistics by rule ID.", "properties": { "bytes": { "description": "The rule size in bytes.", "minimum": 0, "type": "integer" }, "firstMatch": { "description": "The first rule match.", "type": "string" }, "lastMatch": { "description": "The last rule match.", "type": "string" }, "lastReset": { "description": "The last time the rule statistics were reset.", "minLength": 1, "type": "string" }, "lastUpdated": { "description": "The time rule match statistics last changed, including match receipt, aggregation, and manual statistics resets.", "type": "string" }, "matches": { "description": "The number of rule matches.", "minimum": 0, "type": "integer" }, "ruleId": { "description": "The rule ID.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/rule-stats-by-rule-id-response.yaml" } } } }, "description": "Successfully retrieved match statistics for the rule." }, "404": { "content": { "application/problem+json": { "example": { "data": "(C-0N7RAC7, CLOUD_FW, 1) not found.", "errorCode": "ENTITY_NOT_FOUND", "status": 404 }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/network-cloud-firewall/reference/404).", "x-akamai": { "file-path": "errors/404-rule-id-not-found.yaml" } } }, "summary": "List rule match statistics for a rule", "tags": [ "ACL rule hits" ] }, "delete": { "description": "Deletes match statistics for a rule and resets counts.", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Cloud Firewall API", "url": "https://techdocs.akamai.com/network-cloud-firewall/reference/delete-rule-hits-by-id" }, "operationId": "delete-rule-hits-by-id", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "204": { "content": {}, "description": "Success." }, "404": { "content": { "application/problem+json": { "example": { "data": "(C-0N7RAC7, CLOUD_FW, 1) not found.", "errorCode": "ENTITY_NOT_FOUND", "status": 404 }, "schema": { "additionalProperties": true, "description": "Represents error data.", "properties": { "args": { "description": "The request properties related to the error.", "items": { "anyOf": [ { "title": "Strings", "type": "string" }, { "title": "Integer", "type": "integer" }, { "items": { "anyOf": [ { "title": "String", "type": "string" }, { "title": "Numeric", "type": "integer" } ] }, "title": "Array", "type": "array" } ] }, "minItems": 0, "nullable": true, "type": "array" }, "data": { "description": "The customer request data related to the error.", "type": "string" }, "errorCode": { "description": "A short description of the error.", "minLength": 1, "type": "string" }, "message": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "status": { "description": "The error's HTTP response code.", "maximum": 600, "minimum": 100, "type": "integer" } }, "required": [ "errorCode" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/network-cloud-firewall/reference/404).", "x-akamai": { "file-path": "errors/404-rule-id-not-found.yaml" } } }, "summary": "Delete rule match statistics for a rule", "tags": [ "ACL rule hits" ] }, "parameters": [ { "description": "The unique rule ID.", "in": "path", "name": "ruleId", "required": true, "schema": { "example": "d3455bab-592b-4583-baf4-e5bca1cc9ff0", "type": "string" }, "x-akamai": { "file-path": "parameters/rule-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/rule-hits-by-id.yaml", "path-info": "/rule-hits/rules/{ruleId}" } }, "/rule-hits/rules/{ruleId}/time-series": { "get": { "description": "Gets time series match statistics.", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Cloud Firewall API", "url": "https://techdocs.akamai.com/network-cloud-firewall/reference/get-rule-hits-time-series-by-rule-id" }, "operationId": "get-rule-hits-time-series-by-rule-id", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "accountId": "A-CCT9012", "averageMatches": 7.29, "endTime": "2025-11-12T23:59:59Z", "peakMatches": 25, "resolution": "5m", "ruleUuid": "555c9391-cbd4-4415-a7d9-ac92e4813a9a", "startTime": "2025-11-12T00:00:00Z", "timeSeries": [ { "bytes": 103, "matches": 5, "timestamp": "2025-11-12T00:00:00Z" }, { "bytes": 78, "matches": 3, "timestamp": "2025-11-12T00:05:00Z" } ], "totalMatches": 350 }, "schema": { "additionalProperties": false, "description": "Rule hit statistics timeseries data. Maximum granularity per time range:\n- 0-7 days: `5m`\n- 8-31 days: `1h`\n- 32-365 days: `1d`", "properties": { "accountId": { "description": "Account ID of the customer.", "type": "string" }, "averageMatches": { "description": "Average matches for queried time range. Defaults to 0 if no data is available.", "minimum": 1, "type": "number" }, "endTime": { "description": "End time of the data range in ISO 8601 format, inclusive.", "format": "date-time", "type": "string" }, "peakMatches": { "description": "Highest match count in queried time range. Defaults to 0 if no data is available.", "minimum": 1, "type": "integer" }, "resolution": { "description": "Time interval granularity based on the number of days in the range. Either `5m`, `1h`, or `1d`.", "enum": [ "5m", "1h", "1d" ], "type": "string" }, "ruleUuid": { "description": "Unique rule identifier.", "type": "string" }, "startTime": { "description": "Start time of the data range in ISO 8601 format, inclusive.", "format": "date-time", "type": "string" }, "timeSeries": { "description": "Time series data points for the selected time range.", "items": { "additionalProperties": false, "properties": { "bytes": { "description": "Bytes since last timestamp, or `startTime` for first entry.", "minimum": 0, "type": "integer" }, "matches": { "description": "Matches since last timestamp,or`startTime` for first entry.", "minimum": 0, "type": "integer" }, "timestamp": { "description": "ISO 8601 timestamp of the rule hit data point.", "format": "date-time", "type": "string" } }, "required": [ "timestamp", "bytes", "matches" ], "type": "object" }, "type": "array" }, "totalMatches": { "description": "Total matches for queried time range. Defaults to 0 if no data is available.", "minimum": 0, "type": "integer" } }, "required": [ "accountId", "ruleUuid", "startTime", "endTime", "resolution", "totalMatches", "peakMatches", "averageMatches", "timeSeries" ], "type": "object", "x-akamai": { "file-path": "schemas/rule-stats-by-rule-id-timeseries-response.yaml" } } } }, "description": "Successfully retrieved time series match statistics for the rule." } }, "summary": "Gets time series match statistics", "tags": [ "ACL rule hits" ] }, "parameters": [ { "description": "The unique rule ID.", "in": "path", "name": "ruleId", "required": true, "schema": { "example": "d3455bab-592b-4583-baf4-e5bca1cc9ff0", "type": "string" }, "x-akamai": { "file-path": "parameters/rule-id-path.yaml" } }, { "description": "Start time of the data range in ISO 8601 format.", "in": "query", "name": "startTime", "required": true, "schema": { "example": "2025-11-12T00:00:00Z", "type": "string" }, "x-akamai": { "file-path": "parameters/start-time-query.yaml" } }, { "description": "End time of the data range in ISO 8601 format.", "in": "query", "name": "endTime", "required": true, "schema": { "example": "2025-11-15T00:00:00Z", "type": "string" }, "x-akamai": { "file-path": "parameters/end-time-query.yaml" } } ], "x-akamai": { "file-path": "paths/rule-hits-by-id-timeseries.yaml", "path-info": "/rule-hits/rules/{ruleId}/time-series" } }, "/stats": { "get": { "description": "Lists account limits for entitlements, aliases, and trust or block lists.", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Cloud Firewall API", "url": "https://techdocs.akamai.com/network-cloud-firewall/reference/get-account-limits" }, "operationId": "get-account-limits", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "aclRules": { "disabledCount": 15, "enabledCount": 25, "limit": 100 }, "aliases": [ { "disabledCount": 15, "enabledCount": 5, "limit": 50, "type": "SOURCE" }, { "disabledCount": 30, "enabledCount": 10, "limit": 100, "type": "DIPA" }, { "disabledCount": 50, "enabledCount": 20, "limit": 200, "type": "BIG" } ], "trustBlockLists": { "disabledCount": 50, "enabledCount": 20, "limit": 200 } }, "schema": { "additionalProperties": false, "description": "Account statistics for ACL rules, aliases, and trust or block lists.", "properties": { "aclRules": { "additionalProperties": false, "description": "ACL rule statistics.", "properties": { "disabledCount": { "description": "Count of disabled ACL rules excluding remarks for an account.", "minimum": 0, "type": "integer" }, "enabledCount": { "description": "Count of enabled ACL rules excluding remarks for an account.", "minimum": 0, "type": "integer" }, "limit": { "description": "Maximum number of ACL rules allowed for an account.", "minimum": 0, "type": "integer" } }, "required": [ "limit", "enabledCount", "disabledCount" ], "type": "object" }, "aliases": { "description": "Aliases statistics.", "items": { "additionalProperties": false, "properties": { "disabledCount": { "description": "Count of disabled aliases for a specific alias type for an account.", "minimum": 0, "type": "integer" }, "enabledCount": { "description": "Count of enabled aliases for a specific alias type for an account.", "minimum": 0, "type": "integer" }, "limit": { "description": "Maximum limit allowed for specific alias type for an account.", "minimum": 0, "type": "integer" }, "type": { "description": "Alias list type. Either `SOURCE`, less than 50 source IP entries, `BIG`, 50 or more source IP entries, or `DIPA`, fewer than 50 destination IP entries.", "enum": [ "SOURCE", "BIG", "DIPA" ], "type": "string" } }, "required": [ "type", "limit", "enabledCount", "disabledCount" ], "type": "object" }, "minItems": 0, "type": "array" }, "trustBlockLists": { "additionalProperties": false, "description": "Trust and block lists stats.", "properties": { "disabledCount": { "description": "Count of disabled trust or block lists for an account.", "minimum": 0, "type": "integer" }, "enabledCount": { "description": "Count of enabled trust or block lists for an account.", "minimum": 0, "type": "integer" }, "limit": { "description": "Maximum number of trust or block lists allowed for an account.", "minimum": 0, "type": "integer" } }, "required": [ "limit", "enabledCount", "disabledCount" ], "type": "object" } }, "required": [ "aclRules", "aliases", "trustBlockLists" ], "type": "object", "x-akamai": { "file-path": "schemas/account-limits-and-usage-stats.yaml" } } } }, "description": "Successfully retrieved entitlements, aliases, and trust or block lists." } }, "summary": "List account limits", "tags": [ "Account limits" ] }, "x-akamai": { "file-path": "paths/account-usage.yaml", "path-info": "/stats" } } }, "servers": [ { "url": "https://{hostname}/network-cloud-firewall/v1" } ], "tags": [ { "description": "Manage ACL aliases used within ACL rules.", "name": "ACL aliases" }, { "description": "Manage ACL rules, which define the traffic allowed through the Network Cloud Firewall.", "name": "ACL rules" }, { "description": "Provides the list of all the ACL rules for the version number.", "name": "ACL versions" }, { "description": "ACL source IP aliases with 50 entries or more.", "name": "Big aliases" }, { "description": "Returns the latest Managed Services ACL version.", "name": "Managed Services ACLs" }, { "description": "View ACL rule match statistics.", "name": "ACL rule hits" }, { "description": "View rule match statistics.", "name": "Managed Services ACL rule hits" }, { "description": "View account limits for entitlements, aliases, and trust or block lists.", "name": "Account usage stats" } ], "x-readme": { "explorer-enabled": false, "samples-languages": [ "curl", "python", "node" ] } }