Learn more:

• Firewall Rules Notification

• Download this API’s RAML and JSON schema descriptors.

Overview

Akamai periodically updates edge server IP addresses for routine maintenance and, when that happens, it is important that you update your company’s firewall to accept traffic from new IP addresses, or remove access to your origin from IP addresses that were decommissioned.

The Firewall Rules Notification API lets you manage who receives notifications about changes Akamai makes to IP addresses. You can subscribe or unsubscribe users to notifications for specific services, retrieve subscription and service information, and get CIDR block information with which to update your firewall rules. This API provides you with a programmatic interface to the same functionality available in Akamai Control Center.

Who should use this API

Use this API if you manage your company’s firewall and want to programmatically retrieve Akamai CIDR blocks so you can add or remove them from your company’s firewall. Additionally, use this API to automate adding or removing users from being notified about changes to the CIDR blocks.

Get started

Before using FRAPI for the first time:

• Review Get Started for API tools that Akamai provides.

• See Authorize Your Client Using Identity Management to create your API access credentials and authorizations. As detailed in The API Identity Model, you then access the API using custom host names that look like this: https://akzz-XXXXXXXXXXXXXXXX-XXXXXXXXXXXXXXXX.luna.akamaiapis.net.

• To access this API you need to have certain credentials. You assign credentials in the Manage APIs application in Control Center.

  1. Log in to Control Center at control.akamai.com.

  2. Navigate to the Manage APIs application.

  3. Create new credentials for yourself including the specific scope you need either READ-ONLY or READ-WRITE.

Resources

The following lists unique concepts for this API:

• Activation date in Control Center is the same thing as the effective date in the API.

• CIDRs with a status of Deleted are still visible and returned in response objects. Deleted for this API means that CIDR block is no longer in use and no longer serves traffic to your origin. You can remove that CIDR block from your firewall rules.

API summary

Download the RAML descriptors for this API.

List services

Get a list of services you are subscribed to. To see additional services, subscribe to them first and then run the operation again.

[
    {
        "serviceId": 3,
        "serviceName": "TestIP",
        "description": "Test IPs"
    },
    {
        "serviceId": 4,
        "serviceName": "TestIP again",
        "description": "Test IPs"
    }
]

Get a service

Get a specific service.

{
    "serviceId": 3,
    "serviceName": "TestIP",
    "description": "Test IPs"
}

List CIDR blocks

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.

[
    {
        "cidrId": 13742,
        "serviceId": 9,
        "serviceName": "PERF_ANALYTICS",
        "cidr": "66.171.230.134",
        "cidrMask": "/32",
        "port": "80,443",
        "creationDate": "2017-02-21",
        "effectiveDate": "2017-02-21",
        "changeDate": "2017-02-21",
        "minIp": "66.171.230.134",
        "maxIp": "66.171.230.134",
        "lastAction": "add"
    }
]

List subscriptions

List subscriptions you created for yourself and other users. You can only see subscription information based on what you created yourself, so if someone else subscribed you to a service, you will not see that subscription returned by this operation.

{
    "subscriptions": [
        {
            "serviceId": 13,
            "serviceName": "Test IPs",
            "email": "mp@mail.com",
            "signupDate": "2017-03-28"
        },
        {
            "serviceId": 15,
            "serviceName": "CCUAPI",
            "email": "abcd@akamai.com",
            "signupDate": "2017-10-11"
        }
    ]
}

Update subscriptions

Subscribe or unsubscribe users to services.

{
    "subscriptions": [
        {
            "serviceId": 13,
            "email": "mp@mail.com"
        },
        {
            "serviceId": 15,
            "email": "abcd@akamai.com"
        }
    ]
}

{
    "subscriptions": [
        {
            "serviceId": 13,
            "serviceName": "Test IPs",
            "email": "mp@mail.com",
            "signupDate": "2017-03-28"
        },
        {
            "serviceId": 15,
            "serviceName": "CCUAPI",
            "email": "abcd@akamai.com",
            "signupDate": "2017-10-11"
        }
    ]
}

Data

This section provides details for each type of data object the API exchanges.

Download the JSON schemas for this API.

The data schema tables below list membership requirements as follows:

Subscription

Displays subscriptions for a service.

Download schema: subscription.json

Sample GET response:

{
    "subscriptions": [
        {
            "serviceId": 13,
            "serviceName": "Test IPs",
            "email": "mp@mail.com",
            "signupDate": "2017-03-28"
        },
        {
            "serviceId": 15,
            "serviceName": "CCUAPI",
            "email": "abcd@akamai.com",
            "signupDate": "2017-10-11"
        }
    ]
}

Subscription members

Service

Specifies service information.

Download schema: service.json

Sample GET response:

{
    "serviceId": 3,
    "serviceName": "TestIP",
    "description": "Test IPs"
}

Service members

CidrBlock

Describes CIDR block and the services they belong to.

Download schema: cidrBlock.json

Sample GET response:

[
    {
        "cidrId": 13742,
        "serviceId": 9,
        "serviceName": "PERF_ANALYTICS",
        "cidr": "66.171.230.134",
        "cidrMask": "/32",
        "port": "80,443",
        "creationDate": "2017-02-21",
        "effectiveDate": "2017-02-21",
        "changeDate": "2017-02-21",
        "minIp": "66.171.230.134",
        "maxIp": "66.171.230.134",
        "lastAction": "add"
    }
]

CidrBlock members

Errors

This section tells you about the Firewall Rules Notification API’s error response format, and details the range of HTTP status codes the API produces.

Error Responses

The Identity Management API responds with HTTP Problem error objects that provide details useful for debugging.

The following shows a typical error response. The outer object characterizes the overall problem, while the details array lists potentially more than one problem detected in the request.

{
  "type" : "/firewall-rules-manager/error-types/5",
  "status" : 404,
  "title" : "ServiceId doesn't exist",
  "detail" : "ServiceId: 233 not found",
  "instance" : "",
  "errors" : [ ]
}

HTTP status codes

This section lists the range of HTTP response codes the API may produce for both success and error cases:

Last modified: 6/1/2017