Learn more:

• Firewall Rules Notification

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

Overview

Akamai periodically refreshes edge server IP addresses for routine maintenance. With Firewall Rules Notification, you can manage who receives email notifications about the planned changes. Akamai provides two to five weeks of advance notice before activating the IP addresses.

It’s important that you update your company’s firewall to accept traffic from new IP addresses, or remove access to decommissioned ones. Keeping your firewall rules current ensures that requests served through the IPs listed in our CIDR blocks reach your origin.

The Firewall Rules Notification API lets you:

• subscribe or unsubscribe users to notifications for specific services.
• retrieve subscription and service information.
• view CIDR block information required 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. Programmatically retrieve Akamai CIDR block details to add or remove addresses in your firewall rules. You can also automate subscription settings that define who receives email notifications about upcoming changes to the CIDR blocks.

Getting started

Before using FRAPI for the first time:

• Review Get Started with APIs for details on how to set up client tokens to access any Akamai API. These tokens appear as custom hostnames that look like this: https://akzz-XXXXXXXXXXXXXXXX-XXXXXXXXXXXXXXXX.luna.akamaiapis.net.

• To enable this API, choose the API service named Firewall Rules Notification, and set the access level to READ-WRITE.

Resources

The following lists unique concepts for this API:

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

• CIDRs with a status of Deleted are still visible 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 run the operation again.

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

Get a service

Get information about 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 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.

{
    "subscriptions": [
        {
            "subscriptionId": 1,
            "serviceId": 13,
            "serviceName": "Test IPs",
            "createdBy": "username",
            "email": "mp@mail.com",
            "signupDate": "2017-03-28"
        },
        {
            "subscriptionId": 2,
            "serviceId": 15,
            "serviceName": "CCUAPI",
            "createdBy": "username2",
            "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": [
        {
            "subscriptionId": 1,
            "serviceId": 13,
            "serviceName": "Test IPs",
            "createdBy": "username",
            "email": "mp@mail.com",
            "signupDate": "2017-03-28"
        },
        {
            "subscriptionId": 2,
            "serviceId": 15,
            "serviceName": "CCUAPI",
            "createdBy": "username2",
            "email": "abcd@akamai.com",
            "signupDate": "2017-10-11"
        }
    ]
}

Add or remove subscriptions

Subscribe or unsubscribe users to services.

{
    "subscriptions": [
        {
            "op": "add",
            "path": "/",
            "serviceId": 13,
            "email": "mp@mail.com"
        },
        {
            "op": "remove",
            "path": "/15"
        }
    ]
}

{
    "subscriptions": [
        {
            "subscriptionId": 1,
            "serviceId": 13,
            "serviceName": "Test IPs",
            "createdBy": "username",
            "email": "mp@mail.com",
            "signupDate": "2017-03-28"
        },
        {
            "subscriptionId": 2,
            "serviceId": 15,
            "serviceName": "CCUAPI",
            "createdBy": "username2",
            "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.

Subscription

Displays subscriptions for a service.

Download schema: subscription.json

Sample GET response:

{
    "subscriptions": [
        {
            "subscriptionId": 1,
            "serviceId": 13,
            "serviceName": "Test IPs",
            "createdBy": "username",
            "email": "mp@mail.com",
            "signupDate": "2017-03-28"
        },
        {
            "subscriptionId": 2,
            "serviceId": 15,
            "serviceName": "CCUAPI",
            "createdBy": "username2",
            "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 blocks 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: