Learn more:

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

Overview

This API allows the Licensed CDN (LCDN) Operator to create sites, nodes, and attribute types for LCDN or LMS products on the Aura platform. This API does not support the deployment of individual product components on the sites and nodes.

Getting started

Before you use the Aura Infrastructure API for the first time, you must obtain an authorization token by creating and registering an application using the Aura Management Center (AMC) GUI. For detailed information about obtaining a token, see the “Managing OAuth2 Applications” section in the latest version of the Aura LCDN Administration Guide.

Resources

This section provides details on the Aura Infrastructure API’s various operations.

The following list provides a road map of all the conceptual objects you deal with when interacting with this API.

• Site. A site assigns a name to a group of nodes.

• Node. A node represents an aggregation of relevant parts including a list of interfaces, each containing a list of addresses and routes, and a list of attribute values.

• Attribute type. A CDN Operator has the option to create a global set of node attribute types that provide additional node information to CDN Operators, IT, or support organizations.

• Settings. A set of values the CDN Operator creates to apply to an attribute type.

• Node boot medium image. Allows a CDN Operator to retrieve a node boot medium image in usb or iso format.

Before you begin any API operations, you must obtain an authorization token that you need from the AMC GUI. Please refer to the Getting Started section for detailed information.

API summary

Download the RAML descriptors for this API.

Create a new node

This operation creates a new node.

{
    "hostname": "node1.us-ma-east-1.example.com",
    "siteId": 1,
    "bootState": "BOOT",
    "administrativeState": "ACTIVE",
    "dnsServers": [
        "8.8.8.8"
    ],
    "attributes": [
        {
            "attributeTypeId": 1,
            "value": "MA"
        },
        {
            "attributeTypeId": 2,
            "value": "Cambridge"
        }
    ],
    "interfaces": [
        {
            "name": "eth0",
            "macAddress": "00:11:22:33:44:55",
            "type": "ETHERNET",
            "ip4Addresses": [
                {
                    "ipAddress": "1.1.1.1/24",
                    "management": true
                }
            ],
            "ip4Routes": [
                {
                    "destination": "2.2.2.0/24",
                    "nextHop": "1.1.1.10",
                    "metric": 1
                }
            ],
            "ip6Addresses": [
                {
                    "ipAddress": "2001::8000:1234/64"
                }
            ],
            "ip6Routes": [
                {
                    "destination": "2001::8000:2000/64",
                    "nextHop": "2001::8000:1",
                    "metric": 100
                }
            ]
        },
        {
            "name": "eth1",
            "macAddress": "00:11:22:33:44:61",
            "type": "ETHERNET",
            "master": "lag0"
        },
        {
            "name": "eth2",
            "macAddress": "00:11:22:33:44:62",
            "type": "ETHERNET",
            "master": "lag0"
        },
        {
            "name": "lag0",
            "type": "BOND",
            "slaveInterfaces": [
                "eth1",
                "eth2"
            ]
        }
    ]
}

Location: https://akzz-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/api/infrastructure/v1/nodes/1

{
    "nodes": [
        {
            "nodeId": 1,
            "hostname": "node1.us-ma-east-1.example.com"
        },
        {
            "nodeId": 2,
            "hostname": "node2.us-ma-east-1.example.com"
        }
    ],
    "page": {
        "pageNumber": 1,
        "pageSize": 100,
        "totalPages": 1,
        "totalResults": 2
    }
}

Location: https://akzz-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/api/infrastructure/v1/attribute-types/1

List nodes

This operation returns a list of all configured nodes.

{
    "nodes": [
        {
            "nodeId": 1,
            "hostname": "node1.us-ma-east-1.example.com"
        },
        {
            "nodeId": 2,
            "hostname": "node2.us-ma-east-1.example.com"
        }
    ],
    "page": {
        "pageNumber": 1,
        "pageSize": 100,
        "totalPages": 1,
        "totalResults": 2
    }
}

Update a node

This operation updates the details of a node.

{
    "nodeId": 1,
    "hostname": "node1.us-ma-east-1.example.com",
    "siteId": 1,
    "bootState": "BOOT",
    "administrativeState": "ACTIVE",
    "dnsServers": [
        "8.8.8.8"
    ],
    "attributes": [
        {
            "attributeTypeId": 1,
            "value": "MA"
        },
        {
            "attributeTypeId": 2,
            "value": "Cambridge"
        }
    ],
    "interfaces": [
        {
            "name": "eth0",
            "macAddress": "00:11:22:33:44:55",
            "type": "ETHERNET",
            "ipAddresses": [
                {
                    "ipAddress": "1.1.1.1/24",
                    "management": true
                }
            ],
            "routes": [
                {
                    "destination": "2.2.2.0/24",
                    "nextHop": "1.1.1.10",
                    "metric": 1
                }
            ]
        }
    ]
}

{
    "nodeId": 1,
    "hostname": "node1.us-ma-east-1.example.com",
    "siteId": 1,
    "bootState": "BOOT",
    "administrativeState": "ACTIVE",
    "dnsServers": [
        "8.8.8.8"
    ],
    "attributes": [
        {
            "attributeTypeId": 1,
            "value": "MA"
        },
        {
            "attributeTypeId": 2,
            "value": "Cambridge"
        }
    ],
    "interfaces": [
        {
            "name": "eth0",
            "macAddress": "00:11:22:33:44:55",
            "type": "ETHERNET",
            "ipAddresses": [
                {
                    "ipAddress": "1.1.1.1/24",
                    "management": true
                }
            ],
            "routes": [
                {
                    "destination": "2.2.2.0/24",
                    "nextHop": "1.1.1.10",
                    "metric": 1
                }
            ]
        }
    ]
}

Remove a node

This operation removes a node.

Get a node

This operation retrieves the details of a node.

{
    "nodeId": 1,
    "hostname": "node1.us-ma-east-1.example.com",
    "siteId": 1,
    "bootState": "BOOT",
    "administrativeState": "ACTIVE",
    "dnsServers": [
        "8.8.8.8"
    ],
    "attributes": [
        {
            "attributeTypeId": 1,
            "value": "MA"
        },
        {
            "attributeTypeId": 2,
            "value": "Cambridge"
        }
    ],
    "interfaces": [
        {
            "name": "eth0",
            "macAddress": "00:11:22:33:44:55",
            "type": "ETHERNET",
            "ipAddresses": [
                {
                    "ipAddress": "1.1.1.1/24",
                    "management": true
                }
            ],
            "routes": [
                {
                    "destination": "2.2.2.0/24",
                    "nextHop": "1.1.1.10",
                    "metric": 1
                }
            ]
        }
    ]
}

Get a node boot image

Before you install a service node, you must create a Service Node Installation Image on a USB device. You can create either a USB image or an ISO image. Each new LCDN or LMS service node boots the first time from the Service Node Installation Image to install the required service node software on each service node. After the installation is complete, you must remove the USB device so that from that point forward the node boots off its hard disk.

Create a new attribute type

This operation creates a new attribute type. A CDN Operator has the option to create a global set of node attribute types that provide additional node information to CDN Operators, IT, or support organizations.

{
    "name": "Rack"
}

Location: https://akzz-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/api/infrastructure/v1/attribute-types/1

{
    "name": "Room",
    "attributeTypeId": 5
}

List attribute types

This operation returns a list of all configured attribute types.

{
    "attributeTypes": [
        {
            "attributeTypeId": 1,
            "name": "Country"
        },
        {
            "attributeTypeId": 2,
            "name": "State/Province"
        },
        {
            "attributeTypeId": 3,
            "name": "City"
        },
        {
            "attributeTypeId": 4,
            "name": "Building"
        },
        {
            "attributeTypeId": 5,
            "name": "Room"
        },
        {
            "attributeTypeId": 6,
            "name": "Rack"
        }
    ],
    "page": {
        "pageNumber": 1,
        "pageSize": 100,
        "totalPages": 1,
        "totalResults": 6
    }
}

Update an attribute type

This operation updates the details of an attribute type. A CDN Operator has the option to create a global set of node attribute types that provide additional node information to CDN Operators, IT, or support organizations.

{
    "name": "Room",
    "attributeTypeId": 5
}

{
    "name": "Room",
    "attributeTypeId": 5
}

Remove an attribute type

This operation removes an attribute type. A CDN Operator has the option to create a global set of node attribute types that provide additional node information to CDN Operators, IT, or support organizations. Removing an attribute type removes that attribute type and its values from all nodes to which it is assigned.

Get an attribute type

This operation retrieves the details of an attribute type.

{
    "name": "Room",
    "attributeTypeId": 5
}

Update settings

This operation updates attribute type settings which are a set of values the CDN Operator creates to apply to an attribute type.

{
    "attributeTypePriority": [
        1,
        2,
        3,
        4,
        5
    ]
}

{
    "attributeTypePriority": [
        1,
        2,
        3,
        4,
        5
    ]
}

Get settings

This operation gets the configured attribute type settings which are a set of values the CDN Operator creates to apply to an attribute type.

{
    "attributeTypePriority": [
        1,
        2,
        3,
        4,
        5
    ]
}

Create a new site

This operation creates a new site.

{
    "name": "us-ma-east-1",
    "abbreviatedName": "usmae1"
}

Location: https://akzz-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/api/infrastructure/v1/sites/1

{
    "sites": [
        {
            "siteId": 1,
            "name": "us-ma-east-1"
        }
    ],
    "page": {
        "pageNumber": 1,
        "pageSize": 100,
        "totalPages": 1,
        "totalResults": 1
    }
}

List sites

This operation returns a list of all configured sites.

{
    "sites": [
        {
            "siteId": 1,
            "name": "us-ma-east-1"
        }
    ],
    "page": {
        "pageNumber": 1,
        "pageSize": 100,
        "totalPages": 1,
        "totalResults": 1
    }
}

Update a site

This operation updates the details of a site.

{
    "siteId": 1,
    "name": "us-ma-east-1",
    "abbreviatedName": "usmae1"
}

{
    "siteId": 1,
    "name": "us-ma-east-1",
    "abbreviatedName": "usmae1"
}

Remove a site

Remove a site.

Get a site

This operation retrieves the details of a site.

{
    "siteId": 1,
    "name": "us-ma-east-1",
    "abbreviatedName": "usmae1"
}

List nodes per site

This operation lists the nodes belonging to this site.

{
    "nodes": [
        {
            "nodeId": 1,
            "hostname": "node1.us-ma-east-1.example.com"
        },
        {
            "nodeId": 2,
            "hostname": "node2.us-ma-east-1.example.com"
        }
    ],
    "page": {
        "pageNumber": 1,
        "pageSize": 100,
        "totalPages": 1,
        "totalResults": 2
    }
}

Data

This section describes the Aura Infrastructure API’s data objects that the API exposes.

Download the JSON schemas for this API.

The data schema tables below list membership requirements as follows:

Node

A node represents an aggregation of relevant parts that include a list of interfaces, each containing a list of addresses and routes, and a list of attribute values.

Download schema: node.create.schema.json, node.update.schema.json

Sample PUT request:

{
    "nodeId": 1,
    "hostname": "node1.us-ma-east-1.example.com",
    "siteId": 1,
    "bootState": "BOOT",
    "administrativeState": "ACTIVE",
    "dnsServers": [
        "8.8.8.8"
    ],
    "attributes": [
        {
            "attributeTypeId": 1,
            "value": "MA"
        },
        {
            "attributeTypeId": 2,
            "value": "Cambridge"
        }
    ],
    "interfaces": [
        {
            "name": "eth0",
            "macAddress": "00:11:22:33:44:55",
            "type": "ETHERNET",
            "ipAddresses": [
                {
                    "ipAddress": "1.1.1.1/24",
                    "management": true
                }
            ],
            "routes": [
                {
                    "destination": "2.2.2.0/24",
                    "nextHop": "1.1.1.10",
                    "metric": 1
                }
            ]
        }
    ]
}

Node members

AttributeType

A CDN Operator has the option to create a global set of node attribute types that provide additional node information to CDN operators, IT, or support organizations.

Download schema: attribute-type.create.schema.json, attribute-type.update.schema.json

Sample PUT request:

{
    "name": "Room",
    "attributeTypeId": 5
}

AttributeType members

Settings

Settings for an attributeType. A set of values the CDN Operator creates to apply to an attributeType.

Download schema: attribute-type-settings.schema.json

Sample PUT request:

{
    "attributeTypePriority": [
        1,
        2,
        3,
        4,
        5
    ]
}

Settings members

Site

A site assigns a name to a group of nodes.

Download schema: site.create.schema.json, site.update.schema.json

Sample PUT request:

{
    "siteId": 1,
    "name": "us-ma-east-1",
    "abbreviatedName": "usmae1"
}

Site members

Ip4Address

An IPv4 address.

Download schema: node.definitions.schema.json

Ip4Address members

Ip4Route

A single IPv4 route.

Download schema: node.definitions.schema.json

Ip4Route members

Ip6Address

An IPv6 address.

Download schema: node.definitions.schema.json

Ip6Address members

Ip6Route

A single IPv6 route.

Download schema: node.definitions.schema.json

Ip6Route members

Errors

This section provides details on the data object that reflects the API’s common response to error cases, and lists the API’s range of response status codes for both error and success cases.

Error responses

In the case of errors, the API returns an HTTP Problem JSON object with the application/problem+json media type. For example, when you try to GET a node that does not exist, the API responds with a JSON object such as the following:

{
  "type" : "https://akzz-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/api/infrastructure/errors#core.entity-not-found",
  "title" : "The requested entity could not be found",
  "detail" : "Node 99999 does not exist",
  "instance" : "https://akzz-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/api/infrastructure/v1/nodes/99999#fae1fd860940d25d",
  "entityType" : "Node",
  "entityId" : 99999
}

HTTP status codes

This section lists the full range of response codes the API may generate.

Last modified: 7/19/2019