Firewall Rules Notification API 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:

Member is required to be present, regardless of whether its value is empty or null.

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

Member Type Required Description
email String One or more emails belonging to people subscribing to a service. These email addresses receive the notifications for CIDR block updates.
serviceId Integer A unique identifier for a service.
serviceName String The name of a service. This is often the same as the product you purchased.
signupDate String The date a subscriber signed up for notifications. The date is in ISO format.

Service

Specifies service information.

Download schema: service.json

Sample GET response:

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

Service Members

Member Type Required Description
description String A description of the service.
serviceId Integer A unique identifier for a service.
serviceName String The name of a service. This is often the same as the product you purchased.

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

Member Type Required Description
changeDate String The ISO 8601 date when the CIDR block was last updated.
cidr String A list of IP addresses belonging to Akamai edge servers for a particular service.
cidrId Integer A unique identifier for a CIDR block.
cidrMask Enumeration Indicates the range (start and end IP) of the CIDR block. /32 and /64 denote whether the IP addresses in the CIDR block are IPv4 or IPv6, respectively.
creationDate String The ISO 8601 date the CIDR block was created.
effectiveDate String The ISO 8601 date the IP addresses start passing traffic. Make sure your firewall rules are updated to accept traffic before this date. This date is typically two weeks after the CIDR block’s creation date.
lastAction Enumeration The last Action, or change, made to the CIDR block. Either add, update, or delete.
maxIp String The maximum IP is the top of the range for the CIDR block.
minIp String The minimum IP is the base of the range for the CIDR block.
port String The set of comma-delimited ports through which your server receives traffic from Akamai servers.
serviceId Integer A unique identifier for a service.
serviceName String The name of a service. This is often the same as the product you purchased.

Last modified: 1/25/2018