{ "components": { "parameters": { "effective-date-gt-query": { "description": "The ISO 8601 date the CIDR block starts serving traffic to your origin. Ensure your firewall rules are updated to allow this traffic to pass through before the effective date.", "in": "query", "name": "effectiveDateGt", "schema": { "example": "2021-02-21", "type": "string" }, "x-akamai": { "file-path": "parameters/effective-date-gt-query.yaml" } }, "last-action-query": { "description": "Whether a CIDR block was added, updated, or removed from service. You can use this parameter as a sorting mechanism and return only CIDR blocks with a change status of `add`, `update`, or `delete`. Note that a status of `delete` means the CIDR block is no longer in service, and you can remove it from your firewall rules.", "in": "query", "name": "lastAction", "schema": { "default": "update", "enum": [ "all", "add", "update", "delete" ], "example": "add", "type": "string" }, "x-akamai": { "file-path": "parameters/last-action-query.yaml" } } }, "schemas": { "cidr-block": { "additionalProperties": false, "description": "Describes CIDR blocks and the services they belong to.", "properties": { "changeDate": { "description": "The ISO 8601 date when a CIDR block was last updated.", "type": "string" }, "cidr": { "description": "A list of IP addresses belonging to Akamai edge servers for a particular service.", "type": "string" }, "cidrId": { "description": "A unique identifier for a CIDR block.", "type": "integer" }, "cidrMask": { "description": "Indicates the range (start and end IP) of a CIDR block. `/32` and `/64` denote whether the IP addresses in the CIDR block are IPv4 or IPv6, respectively.", "enum": [ "/32", "/64" ], "type": "string" }, "creationDate": { "description": "The ISO 8601 date the CIDR block was created.", "type": "string" }, "effectiveDate": { "description": "The ISO 8601 date the IP addresses start passing traffic. Make sure your firewall rules are updated to accept traffic before this date. The date is typically two weeks after the CIDR block's creation date.", "type": "string" }, "lastAction": { "description": "The last Action, or change, made to a CIDR block. Either `add`, `update`, or `delete`.", "enum": [ "add", "update", "delete" ], "type": "string" }, "maxIp": { "description": "The maximum IP is the top of the range for the CIDR block.", "type": "string" }, "minIp": { "description": "The minimum IP is the base of the range for the CIDR block.", "type": "string" }, "port": { "description": "The set of comma-delimited ports through which your server receives traffic from Akamai servers.", "type": "string" }, "serviceId": { "description": "A unique identifier for a service.", "type": "integer" }, "serviceName": { "description": "The name of a service. This is often the same as the product you purchased.", "type": "string" } }, "required": [ "cidrId", "serviceId", "serviceName", "cidr", "cidrMask", "port", "creationDate", "effectiveDate", "changeDate", "minIp", "maxIp", "lastAction" ], "type": "object", "x-akamai": { "file-path": "schemas/cidr-block.yaml" } }, "cidr-blocks-200": { "description": "Test Schema to use with `./examples/cidr-blocks-200.json`.", "items": { "additionalProperties": false, "description": "Describes CIDR blocks and the services they belong to.", "properties": { "changeDate": { "description": "The ISO 8601 date when a CIDR block was last updated.", "type": "string" }, "cidr": { "description": "A list of IP addresses belonging to Akamai edge servers for a particular service.", "type": "string" }, "cidrId": { "description": "A unique identifier for a CIDR block.", "type": "integer" }, "cidrMask": { "description": "Indicates the range (start and end IP) of a CIDR block. `/32` and `/64` denote whether the IP addresses in the CIDR block are IPv4 or IPv6, respectively.", "enum": [ "/32", "/64" ], "type": "string" }, "creationDate": { "description": "The ISO 8601 date the CIDR block was created.", "type": "string" }, "effectiveDate": { "description": "The ISO 8601 date the IP addresses start passing traffic. Make sure your firewall rules are updated to accept traffic before this date. The date is typically two weeks after the CIDR block's creation date.", "type": "string" }, "lastAction": { "description": "The last Action, or change, made to a CIDR block. Either `add`, `update`, or `delete`.", "enum": [ "add", "update", "delete" ], "type": "string" }, "maxIp": { "description": "The maximum IP is the top of the range for the CIDR block.", "type": "string" }, "minIp": { "description": "The minimum IP is the base of the range for the CIDR block.", "type": "string" }, "port": { "description": "The set of comma-delimited ports through which your server receives traffic from Akamai servers.", "type": "string" }, "serviceId": { "description": "A unique identifier for a service.", "type": "integer" }, "serviceName": { "description": "The name of a service. This is often the same as the product you purchased.", "type": "string" } }, "required": [ "cidrId", "serviceId", "serviceName", "cidr", "cidrMask", "port", "creationDate", "effectiveDate", "changeDate", "minIp", "maxIp", "lastAction" ], "type": "object", "x-akamai": { "file-path": "schemas/cidr-block.yaml" } }, "title": "cidrBlocks", "type": "array", "x-akamai": { "file-path": "schemas/cidr-blocks-200.yaml" } } } }, "externalDocs": { "description": "See documentation for Akamai's Firewall Rules Notification API", "url": "https://techdocs.akamai.com/firewall-rules/reference" }, "info": { "description": "Get notifications of CIDR block changes on the edge network\nso you can update your firewall rules.\n", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "Akamai: Firewall Rules Notification API", "version": "v1" }, "openapi": "3.0.0", "paths": { "/cidr-blocks": { "get": { "description": "List all CIDR blocks for all services you are subscribed to. To see additional CIDR blocks, subscribe yourself to more services and run this operation again.", "externalDocs": { "description": "See documentation for this operation in Akamai's Firewall Rules Notification API", "url": "https://techdocs.akamai.com/firewall-rules/reference/get-cidr-blocks" }, "operationId": "get-cidr-blocks", "parameters": [ { "description": "__Enum__ Whether a CIDR block was added, updated, or removed from service. You can use this parameter as a sorting mechanism and return only CIDR blocks with a change status of `add`, `update`, or `delete`. Note that a status of `delete` means the CIDR block is no longer in service, and you can remove it from your firewall rules.", "in": "query", "name": "lastAction", "schema": { "default": "update", "enum": [ "all", "add", "update", "delete" ], "example": "add", "type": "string" }, "x-akamai": { "file-path": "parameters/last-action-query.yaml" } }, { "description": "The ISO 8601 date the CIDR block starts serving traffic to your origin. Ensure your firewall rules are updated to allow this traffic to pass through before the effective date.", "in": "query", "name": "effectiveDateGt", "schema": { "example": "2021-02-21", "type": "string" }, "x-akamai": { "file-path": "parameters/effective-date-gt-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": [ { "changeDate": "2021-02-21", "cidr": "192.0.2.234", "cidrId": 13742, "cidrMask": "/32", "creationDate": "2021-02-21", "effectiveDate": "2021-02-21", "lastAction": "add", "maxIp": "192.0.2.244", "minIp": "192.0.2.45", "port": "80,443", "serviceId": 9, "serviceName": "PERF_ANALYTICS" } ], "schema": { "description": "Test Schema to use with `./examples/cidr-blocks-200.json`.", "items": { "additionalProperties": false, "description": "Describes CIDR blocks and the services they belong to.", "properties": { "changeDate": { "description": "The ISO 8601 date when a CIDR block was last updated.", "type": "string" }, "cidr": { "description": "A list of IP addresses belonging to Akamai edge servers for a particular service.", "type": "string" }, "cidrId": { "description": "A unique identifier for a CIDR block.", "type": "integer" }, "cidrMask": { "description": "Indicates the range (start and end IP) of a CIDR block. `/32` and `/64` denote whether the IP addresses in the CIDR block are IPv4 or IPv6, respectively.", "enum": [ "/32", "/64" ], "type": "string" }, "creationDate": { "description": "The ISO 8601 date the CIDR block was created.", "type": "string" }, "effectiveDate": { "description": "The ISO 8601 date the IP addresses start passing traffic. Make sure your firewall rules are updated to accept traffic before this date. The date is typically two weeks after the CIDR block's creation date.", "type": "string" }, "lastAction": { "description": "The last Action, or change, made to a CIDR block. Either `add`, `update`, or `delete`.", "enum": [ "add", "update", "delete" ], "type": "string" }, "maxIp": { "description": "The maximum IP is the top of the range for the CIDR block.", "type": "string" }, "minIp": { "description": "The minimum IP is the base of the range for the CIDR block.", "type": "string" }, "port": { "description": "The set of comma-delimited ports through which your server receives traffic from Akamai servers.", "type": "string" }, "serviceId": { "description": "A unique identifier for a service.", "type": "integer" }, "serviceName": { "description": "The name of a service. This is often the same as the product you purchased.", "type": "string" } }, "required": [ "cidrId", "serviceId", "serviceName", "cidr", "cidrMask", "port", "creationDate", "effectiveDate", "changeDate", "minIp", "maxIp", "lastAction" ], "type": "object", "x-akamai": { "file-path": "schemas/cidr-block.yaml" } }, "title": "cidrBlocks", "type": "array", "x-akamai": { "file-path": "schemas/cidr-blocks-200.yaml" } } } }, "description": "Successful response." } }, "summary": "List CIDR blocks", "tags": [ "CIDR blocks" ] }, "x-akamai": { "file-path": "paths/cidr-blocks.yaml", "path-info": "/cidr-blocks" } }, "/services": { "get": { "description": "Get a list of services you are subscribed to. To see additional services, subscribe to them first and run the operation again.", "externalDocs": { "description": "See documentation for this operation in Akamai's Firewall Rules Notification API", "url": "https://techdocs.akamai.com/firewall-rules/reference/get-services" }, "operationId": "get-services", "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": [ { "description": "Test IPs", "serviceId": 3, "serviceName": "TestIP" }, { "description": "Test IPs", "serviceId": 4, "serviceName": "TestIP again" } ], "schema": { "description": "Test test.", "items": { "additionalProperties": false, "description": "Specifies service information.", "properties": { "description": { "description": "A description of the service.", "type": "string" }, "serviceId": { "description": "A unique identifier for a service.", "type": "integer" }, "serviceName": { "description": "The name of a service. This is often the same as the product you purchased.", "type": "string" } }, "required": [ "serviceId", "serviceName", "description" ], "type": "object", "x-akamai": { "file-path": "schemas/service-200.yaml" } }, "title": "Services", "type": "array", "x-akamai": { "file-path": "schemas/services-200.yaml" } } } }, "description": "Successful response." } }, "summary": "List services", "tags": [ "Services" ] }, "x-akamai": { "file-path": "paths/services.yaml", "path-info": "/services" } }, "/services/{serviceId}": { "get": { "description": "Get information about a specific service.", "externalDocs": { "description": "See documentation for this operation in Akamai's Firewall Rules Notification API", "url": "https://techdocs.akamai.com/firewall-rules/reference/get-service" }, "operationId": "get-service", "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": { "description": "Test IPs", "serviceId": 3, "serviceName": "TestIP" }, "schema": { "additionalProperties": false, "description": "Specifies service information.", "properties": { "description": { "description": "A description of the service.", "type": "string" }, "serviceId": { "description": "A unique identifier for a service.", "type": "integer" }, "serviceName": { "description": "The name of a service. This is often the same as the product you purchased.", "type": "string" } }, "required": [ "serviceId", "serviceName", "description" ], "type": "object", "x-akamai": { "file-path": "schemas/service-200.yaml" } } } }, "description": "Successful response." }, "404": { "content": { "application/json": { "example": { "detail": "", "errors": [], "instance": "", "status": 404, "title": "Duplicated cidr block, identical cidr, cidrMask, and port", "type": "/firewall-rules-manager/error-types/9" }, "schema": { "additionalProperties": true, "properties": { "detail": { "description": "Detail.", "type": "string" }, "errors": { "description": "Errors.", "items": { "type": "string" }, "type": "array" }, "instance": { "description": "Instance.", "type": "string" }, "status": { "description": "Status.", "type": "integer" }, "title": { "description": "Title string.", "type": "string" }, "type": { "description": "Type string.", "type": "string" } }, "required": [ "type", "status", "title", "detail", "instance", "errors" ], "type": "object", "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/firewall-rules/reference/400).", "x-akamai": { "file-path": "errors/400.yaml" } } }, "summary": "Get a service", "tags": [ "Services" ] }, "parameters": [ { "description": "A unique identifier for a service.", "in": "path", "name": "serviceId", "required": true, "schema": { "example": 3, "type": "integer" }, "x-akamai": { "file-path": "parameters/service-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/service.yaml", "path-info": "/services/{serviceId}" } }, "/subscriptions": { "get": { "description": "List subscriptions you created for yourself and other users. You can only see the subscription information for configurations you created yourself. If someone else subscribed you to a service, you won't see that subscription returned by this operation.", "externalDocs": { "description": "See documentation for this operation in Akamai's Firewall Rules Notification API", "url": "https://techdocs.akamai.com/firewall-rules/reference/get-subscriptions" }, "operationId": "get-subscriptions", "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": { "subscriptions": [ { "createdBy": "hgildong", "email": "jperez@mail.com", "serviceId": 13, "serviceName": "Test IPs", "signupDate": "2021-03-28", "subscriptionId": 1 }, { "createdBy": "adevi", "email": "afero@akamai.com", "serviceId": 15, "serviceName": "CCUAPI", "signupDate": "2021-10-11", "subscriptionId": 2 } ] }, "schema": { "additionalProperties": false, "description": "Test.", "properties": { "subscriptions": { "description": "Displays subscriptions for a service.", "items": { "additionalProperties": false, "description": "Displays subscriptions for a service.", "properties": { "createdBy": { "description": "A username who created a subscription.", "type": "string" }, "email": { "description": "The email of the user subscribed to a service and receiving notifications about the CIDR block updates.", "type": "string" }, "serviceId": { "description": "A unique identifier for a service.", "type": "integer" }, "serviceName": { "description": "The name of a service. This is often the same as the product you purchased.", "type": "string" }, "signupDate": { "description": "The date a subscriber signed up for notifications. The date is in ISO format.", "type": "string" }, "subscriptionId": { "description": "A unique identifier for a subscription.", "type": "integer" } }, "required": [ "subscriptionId", "createdBy", "serviceId", "serviceName", "email", "signupDate" ], "type": "object", "x-akamai": { "file-path": "schemas/subscription.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/subscriptions-200.yaml" } } } }, "description": "Successful response." } }, "summary": "List subscriptions", "tags": [ "Subscriptions" ] }, "put": { "description": "Subscribe or unsubscribe users to services.", "externalDocs": { "description": "See documentation for this operation in Akamai's Firewall Rules Notification API", "url": "https://techdocs.akamai.com/firewall-rules/reference/put-subscriptions" }, "operationId": "put-subscriptions", "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": { "subscriptions": [ { "email": "alfulani@mail.com", "serviceId": 13 }, { "email": "adevi@akamai.com", "serviceId": 15 } ] }, "schema": { "additionalProperties": false, "description": "Test.", "properties": { "subscriptions": { "description": "Information necessary to include when subscribing users to CIDR block notifications for a service.", "items": { "additionalProperties": false, "description": "Information necessary to include when subscribing users to CIDR block notifications for a service.", "properties": { "email": { "description": "The email belonging to the user you want to subscribe.", "type": "string" }, "serviceId": { "description": "A unique identifier for a service.", "type": "integer" } }, "required": [ "serviceId", "email" ], "type": "object", "x-akamai": { "file-path": "schemas/subscription-put-request.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/subscription-put-requests-200.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "subscriptions": [ { "createdBy": "hgildong", "email": "jperez@mail.com", "serviceId": 13, "serviceName": "Test IPs", "signupDate": "2021-03-28", "subscriptionId": 1 }, { "createdBy": "adevi", "email": "afero@akamai.com", "serviceId": 15, "serviceName": "CCUAPI", "signupDate": "2021-10-11", "subscriptionId": 2 } ] }, "schema": { "additionalProperties": false, "description": "Test.", "properties": { "subscriptions": { "description": "Displays subscriptions for a service.", "items": { "additionalProperties": false, "description": "Displays subscriptions for a service.", "properties": { "createdBy": { "description": "A username who created a subscription.", "type": "string" }, "email": { "description": "The email of the user subscribed to a service and receiving notifications about the CIDR block updates.", "type": "string" }, "serviceId": { "description": "A unique identifier for a service.", "type": "integer" }, "serviceName": { "description": "The name of a service. This is often the same as the product you purchased.", "type": "string" }, "signupDate": { "description": "The date a subscriber signed up for notifications. The date is in ISO format.", "type": "string" }, "subscriptionId": { "description": "A unique identifier for a subscription.", "type": "integer" } }, "required": [ "subscriptionId", "createdBy", "serviceId", "serviceName", "email", "signupDate" ], "type": "object", "x-akamai": { "file-path": "schemas/subscription.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/subscriptions-200.yaml" } } } }, "description": "Successful response." } }, "summary": "Update subscriptions", "tags": [ "Subscriptions" ] }, "patch": { "description": "Subscribe or unsubscribe users to services.", "externalDocs": { "description": "See documentation for this operation in Akamai's Firewall Rules Notification API", "url": "https://techdocs.akamai.com/firewall-rules/reference/patch-subscriptions" }, "operationId": "patch-subscriptions", "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": [ { "email": "hgildong@mail.com", "op": "add", "path": "/", "serviceId": 13 }, { "op": "remove", "path": "/15" } ], "schema": { "description": "Information necessary to include when subscribing users to CIDR block notifications for a service or removing them from the subscription list.", "items": { "additionalProperties": false, "description": "Information necessary to include when subscribing users to CIDR block notifications for a service or removing them from the subscription list.", "properties": { "email": { "description": "The email belonging to the user you want to subscribe.", "type": "string" }, "op": { "description": "The operation you want to perform on the subscription list, either `add` or `remove` users.", "enum": [ "add", "remove" ], "type": "string" }, "path": { "description": "A path to the `subscriptionId`. Specify either a blank `/` for a new subscription, or `/` followed by the `subscriptionId` when removing a subscription.", "type": "string" }, "serviceId": { "description": "A unique identifier for a service.", "type": "integer" } }, "required": [ "op", "path" ], "type": "object", "x-akamai": { "file-path": "schemas/subscription-patch-request.yaml" } }, "title": "subscriptionPatchRequest", "type": "array", "x-akamai": { "file-path": "schemas/subscription-patch-requests-200.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "subscriptions": [ { "createdBy": "hgildong", "email": "jperez@mail.com", "serviceId": 13, "serviceName": "Test IPs", "signupDate": "2021-03-28", "subscriptionId": 1 }, { "createdBy": "adevi", "email": "afero@akamai.com", "serviceId": 15, "serviceName": "CCUAPI", "signupDate": "2021-10-11", "subscriptionId": 2 } ] }, "schema": { "additionalProperties": false, "description": "Test.", "properties": { "subscriptions": { "description": "Displays subscriptions for a service.", "items": { "additionalProperties": false, "description": "Displays subscriptions for a service.", "properties": { "createdBy": { "description": "A username who created a subscription.", "type": "string" }, "email": { "description": "The email of the user subscribed to a service and receiving notifications about the CIDR block updates.", "type": "string" }, "serviceId": { "description": "A unique identifier for a service.", "type": "integer" }, "serviceName": { "description": "The name of a service. This is often the same as the product you purchased.", "type": "string" }, "signupDate": { "description": "The date a subscriber signed up for notifications. The date is in ISO format.", "type": "string" }, "subscriptionId": { "description": "A unique identifier for a subscription.", "type": "integer" } }, "required": [ "subscriptionId", "createdBy", "serviceId", "serviceName", "email", "signupDate" ], "type": "object", "x-akamai": { "file-path": "schemas/subscription.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/subscriptions-200.yaml" } } } }, "description": "Successful response." } }, "summary": "Add or remove subscriptions", "tags": [ "Subscriptions" ] }, "x-akamai": { "file-path": "paths/subscriptions.yaml", "path-info": "/subscriptions" } } }, "servers": [ { "url": "https://{hostname}/firewall-rules-manager/v1" } ], "tags": [], "x-readme": { "explorer-enabled": false, "samples-languages": [ "curl", "python", "node" ] } }