
- Overview
- Resources
- API summary
- Create a new access map
- List access maps
- Update an access map
- Remove an access map
- Get an access map
- Create a new BGP configuration
- List BGP configurations
- Update a BGP configuration
- Remove a BGP configuration
- Get a BGP configuration
- Create a new site map
- List site maps
- Update a site map
- Remove a site map
- Get a site map
- Create a new GeoIP configuration
- List GeoIP configurations
- Update a GeoIP configuration
- Remove a GeoIP configuration
- Get a GeoIP configuration
- Data
- Errors
Aura LCDN Mapping API v1
Manage mapping configuration objects for the LCDN product on the Aura platform.
Learn more:
- Download this API’s RAML and JSON schema descriptors.
Overview
This API allows the Licensed CDN (LCDN) Operator to manage mapping configuration objects for the LCDN product on the Aura platform.
Get started
Before you use the Aura LCDN Mapping API for the first time, you need to 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 LCDN Mapping API’s resources.
SiteMap: A site redirection map. For more information, see the Aura LCDN HyperCache Guide and the Aura LCDN Request Router Guide.
AccessMap: An access map. For more information, see the Aura LCDN HyperCache Guide and the Aura LCDN Request Router Guide.
BgpConfig: An FRR (https://frrouting.org/) style configuration object.
GeoIpConfig: A GeoIP configuration database object.
API summary
Download the RAML descriptors for this API.
Operation | Method | Endpoint |
---|---|---|
Access maps | ||
Create a new access map | POST | /api/ |
List access maps | GET | /api/ |
Update an access map | PUT | /api/ |
Remove an access map | DELETE | /api/ |
Get an access map | GET | /api/ |
BgpConfigs | ||
Create a new BGP configuration | POST | /api/ |
List BGP configurations | GET | /api/ |
Update a BGP configuration | PUT | /api/ |
Remove a BGP configuration | DELETE | /api/ |
Get a BGP configuration | GET | /api/ |
SiteMaps | ||
Create a new site map | POST | /api/ |
List site maps | GET | /api/ |
Update a site map | PUT | /api/ |
Remove a site map | DELETE | /api/ |
Get a site map | GET | /api/ |
GeoIpConfigs | ||
Create a new GeoIP configuration | POST | /api/ |
List GeoIP configurations | GET | /api/ |
Update a GeoIP configuration | PUT | /api/ |
Remove a GeoIP configuration | DELETE | /api/ |
Get a GeoIP configuration | GET | /api/ |
Create a new access map
This operation creates a new Access Map instance.
POST /api/
Content-Type: multipart/form-data
See Parameters for details on upload content.
Parameter | Type | Sample | Description |
---|---|---|---|
Form parameters | |||
metadata |
File | {"description":"Default access map.", "name":"access_map1"}
|
The metadata portion is the JSON configuration describing the mapping object. |
config |
File | map 0.0.0.0/0 : allow |
An access map in its native format, as described in Aura documentation. |
Status 200
application/json
Headers:
Location: https://akzz-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/api/lcdn-mapping/v1/access-maps/1
Object type: AccessMap
Download schema: access-map.read-detailed.schema.json
Response body:
{
"mapId": 1863,
"description": "Default access map.",
"name": "access_map1"
}
Status 201
Headers:
Location: https://akzz-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/api/infrastructure/v1/attribute-types/1
Prepare the AccessMap configuration. For more information, see the Aura LCDN HyperCache Guide and the Aura LCDN Request Router Guide.
Construct an AccessMap metadata object to describe the map.
Make a POST request to
/api/
using the HTTPlcdn-mapping/ v1/ access-maps multipart/form-data
Content-Type. Supply the metadata as the first part with HTTPapplication/json
Content-Type, and the map content as the second part with HTTPtext/plain
Content-Type.The
Location
header in the response provides a URL to the created object.The response is of type
application/json
, and the body is an AccessMap metadata object.
List access maps
This operation returns a list of all configured access maps.
GET /api/
Status 200
application/json
Object type: AccessMap
Download schema: access-map.collection.schema.json
Response body:
{
"maps": [
{
"mapId": 1863,
"name": "access_map1"
}
],
"page": {
"pageNumber": 1,
"pageSize": 100,
"totalPages": 1,
"totalResults": 1
}
}
Use the
pageSize
andpageNumber
query parameters to control the set of data that gets returned.Optionally specify the
view
query parameter with a value ofdetailed
to request the full details of each object within the collection.Make a GET request to
/api/
.lcdn-mapping/ v1/ access-maps The operation responds with a paged collection of AccessMap objects.
Update an access map
This operation updates the details of an access map instance.
PUT /api/
Sample: /api/
Content-Type: application/json
Object type: AccessMap
Download schema: access-map.update.schema.json
Request body:
{
"mapId": 1863,
"description": "Default access map.",
"name": "access_map1"
}
PUT /api/
Sample: /api/
Content-Type: multipart/form-data
See Parameters for details on upload content.
Parameter | Type | Sample | Description |
---|---|---|---|
URL path parameters | |||
mapId |
Integer | 1 |
Uniquely identifies an access map instance. |
Form parameters | |||
metadata |
File | {"mapId":1863, "description":"Default access map.", "name":"access_map1"}
|
The metadata portion is the JSON configuration describing the mapping object. |
config |
File | map 0.0.0.0/0 : allow |
An access map in its native format, as described in Aura documentation. |
Status 200
application/json
Object type: AccessMap
Download schema: access-map.read-detailed.schema.json
Response body:
{
"mapId": 1863,
"description": "Default access map.",
"name": "access_map1"
}
Run the List access maps operation to locate and store the target AccessMap object and
mapId
.Update the AccessMap object.
If updating only the metadata, PUT the AccessMap metadata object to
/api/
using the HTTPlcdn-mapping/ v1/ access-maps/ {mapId} application/json
Content-Type.If updating the metadata and content, make a PUT request to
/api/
using the HTTPlcdn-mapping/ v1/ access-maps/ {mapId} multipart/form-data
Content-Type. Supply the metadata as the first part with HTTPapplication/json
Content-Type, and the map content as the second part with HTTPtext/plain
Content-Type.The response reflects the updated AccessMap object.
Remove an access map
This operation removes an access map.
DELETE /api/
Sample: /api/
Parameter | Type | Sample | Description |
---|---|---|---|
URL path parameters | |||
mapId |
Integer | 1 |
Uniquely identifies an access map instance. |
Status 204
If you don’t have a
mapId
value, run the List access maps operation to locate the AccessMap and store themapId
value.Make a DELETE request to
/api/
.lcdn-mapping/ v1/ access-maps/ {mapId}
Get an access map
This operation gets the details of an access map instance.
GET /api/
Sample: /api/
Parameter | Type | Sample | Description |
---|---|---|---|
URL path parameters | |||
mapId |
Integer | 1 |
Uniquely identifies an access map instance. |
Status 200
application/json
Object type: AccessMap
Download schema: access-map.read-detailed.schema.json
Response body:
{
"mapId": 1863,
"description": "Default access map.",
"name": "access_map1"
}
Run the List access maps operation to locate the
mapId
of the target AccessMap object.Make a GET request to
/api/
.lcdn-mapping/ v1/ access-maps/ {mapId} The operation responds with an AccessMap object.
Create a new BGP configuration
This operation creates a new BGP configuration instance.
POST /api/
Content-Type: multipart/form-data
See Parameters for details on upload content.
Parameter | Type | Sample | Description |
---|---|---|---|
Form parameters | |||
metadata |
File | {"name":"bgp_config_1", "description":"Configuration for BGP integration."}
|
The metadata portion is the JSON configuration describing the mapping object. |
config |
File | router bgp 1112
bgp router-id 127.0.0.1
bgp dampening 15 750 2000 61 |
A BGP configuration, as described in FRR documentation. |
Status 200
application/json
Headers:
Location: https://akzz-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/api/lcdn-mapping/v1/bgp-configs/1
Object type: BgpConfig
Download schema: bgp-config.read-detailed.schema.json
Response body:
{
"bgpConfigId": 2072,
"name": "bgp_config_1",
"description": "Configuration for BGP integration.",
"dateCreated": "2020-06-18T01:55:39.000+0000",
"lastUpdated": "2020-06-18T01:55:39.000+0000"
}
Status 201
Headers:
Location: https://akzz-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/api/infrastructure/v1/attribute-types/1
Prepare the BgpConfig configuration. For more information, see the Aura LCDN HyperCache Guide and the Aura LCDN Request Router Guide.
Construct an BgpConfig metadata object to describe the map.
Make a POST request to
/api/
using the HTTPlcdn-mapping/ v1/ bgp-configs multipart/form-data
Content-Type. Supply the metadata as the first part with HTTPapplication/json
Content-Type, and the BgpConfig content as the second part with HTTPtext/plain
Content-Type.The
Location
header in the response provides a URL to the created object.The response is of type
application/json
, and the body is an BgpConfig metadata object.
List BGP configurations
This operation returns a list of all BGP configurations.
GET /api/
Status 200
application/json
Object type: BgpConfig
Download schema: bgp-config.collection.schema.json
Response body:
{
"bgpConfigs": [
{
"bgpConfigId": 2072,
"name": "bgp_config_1"
}
],
"page": {
"pageNumber": 1,
"pageSize": 100,
"totalPages": 1,
"totalResults": 1
}
}
Use the
pageSize
andpageNumber
query parameters to control the set of data that gets returned.Optionally specify the
view
query parameter with a value ofdetailed
to request the full details of each object within the collection.Make a GET request to
/api/
.lcdn-mapping/ v1/ bgp-configs The operation responds with a paged collection of BgpConfig objects.
Update a BGP configuration
This operation updates the details of a BGP configuration instance.
PUT /api/
Sample: /api/
Content-Type: application/json
Object type: BgpConfig
Download schema: bgp-config.update.schema.json
Request body:
{
"bgpConfigId": 2072,
"name": "bgp_config_1",
"description": "Configuration for BGP integration."
}
PUT /api/
Sample: /api/
Content-Type: multipart/form-data
See Parameters for details on upload content.
Parameter | Type | Sample | Description |
---|---|---|---|
URL path parameters | |||
bgpConfigId |
Integer | 1 |
Uniquely identifies a BGP configuration instance. |
Form parameters | |||
metadata |
File | {"bgpConfigId":2072, "name":"bgp_config_1", "description":"Configuration for BGP integration."}
|
The metadata portion is the JSON configuration describing the mapping object. |
config |
File | router bgp 1112
bgp router-id 127.0.0.1
bgp dampening 15 750 2000 61 |
A BGP configuration, as described in FRR documentation. |
Status 200
application/json
Object type: BgpConfig
Download schema: bgp-config.read-detailed.schema.json
Response body:
{
"bgpConfigId": 2072,
"name": "bgp_config_1",
"description": "Configuration for BGP integration.",
"dateCreated": "2020-06-18T01:55:39.000+0000",
"lastUpdated": "2020-06-18T01:55:39.000+0000"
}
Run the List BGP configurations operation to locate and store the target BgpConfig object and
bgpConfigId
.Update the BgpConfig object.
If updating only the metadata, PUT the BgpConfig metadata object to
/api/
using the HTTPlcdn-mapping/ v1/ bgp-configs/ {bgpConfigId} application/json
Content-Type.If updating the metadata and content, make a PUT request to
/api/
using the HTTPlcdn-mapping/ v1/ bgp-configs/ {bgpConfigId} multipart/form-data
Content-Type. Supply the metadata as the first part with HTTPapplication/json
Content-Type, and the map content as the second part with HTTPtext/plain
Content-Type.The response reflects the updated BgpConfig object.
Remove a BGP configuration
This operation removes a BGP configuration instance.
DELETE /api/
Sample: /api/
Parameter | Type | Sample | Description |
---|---|---|---|
URL path parameters | |||
bgpConfigId |
Integer | 1 |
Uniquely identifies a BGP configuration instance. |
Status 204
If you don’t have a
bgpConfigId
value, run the List BGP configurations operation to locate the BgpConfig and store thebgpConfigId
value.Make a DELETE request to
/api/
.lcdn-mapping/ v1/ bgp-configs/ {bgpConfigId}
Get a BGP configuration
This operation gets the details of a BGP configuration instance.
GET /api/
Sample: /api/
Parameter | Type | Sample | Description |
---|---|---|---|
URL path parameters | |||
bgpConfigId |
Integer | 1 |
Uniquely identifies a BGP configuration instance. |
Status 200
application/json
Object type: BgpConfig
Download schema: bgp-config.read-detailed.schema.json
Response body:
{
"bgpConfigId": 2072,
"name": "bgp_config_1",
"description": "Configuration for BGP integration.",
"dateCreated": "2020-06-18T01:55:39.000+0000",
"lastUpdated": "2020-06-18T01:55:39.000+0000"
}
Run the List BGP configurations operation to locate the
bgpConfigId
parameter of the target BgpConfig object.Make a GET request to
/api/
.lcdn-mapping/ v1/ bgp-configs/ {bgpConfigId} The operation responds with an BgpConfig object.
Create a new site map
This operation creates a new site map instance.
POST /api/
Content-Type: multipart/form-data
See Parameters for details on upload content.
Parameter | Type | Sample | Description |
---|---|---|---|
Form parameters | |||
metadata |
File | {"description":"Default site map.", "name":"site_map1"}
|
The metadata portion is the JSON configuration describing the mapping object. |
config |
File | map 0.0.0.0/0 : zone "Primary Site" || zone "Site Central"
|
A site map in its native format, as described in Aura documentation. |
Status 200
application/json
Headers:
Location: https://akzz-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/api/lcdn-mapping/v1/site-maps/1
Object type: SiteMap
Download schema: site-map.read-detailed.schema.json
Response body:
{
"mapId": 1864,
"description": "Default site map.",
"name": "site_map1"
}
Status 201
Headers:
Location: https://akzz-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/api/infrastructure/v1/attribute-types/1
Prepare the SiteMap configuration. For more information, see the Aura LCDN HyperCache Guide and the Aura LCDN Request Router Guide.
Construct an SiteMap metadata object to describe the map.
Make a POST request to
/api/
using the HTTPlcdn-mapping/ v1/ site-maps multipart/form-data
Content-Type. Supply the metadata as the first part with HTTPapplication/json
Content-Type, and the map content as the second part with HTTPtext/plain
Content-Type.The
Location
header in the response provides a URL to the created object.The response is of type
application/json
, and the body is an SiteMap metadata object.
List site maps
This operation returns a list of all configured site maps.
GET /api/
Status 200
application/json
Object type: SiteMap
Download schema: site-map.collection.schema.json
Response body:
{
"maps": [
{
"mapId": 1864,
"name": "site_map1"
}
],
"page": {
"pageNumber": 1,
"pageSize": 100,
"totalPages": 1,
"totalResults": 1
}
}
Use the
pageSize
andpageNumber
query parameters to control the set of data that gets returned.Optionally specify the
view
query parameter with a value ofdetailed
to request the full details of each object within the collection.Make a GET request to
/api/
.lcdn-mapping/ v1/ site-maps The operation responds with a paged collection of SiteMap objects.
Update a site map
This operation updates the details of a site map instance.
PUT /api/
Sample: /api/
Content-Type: application/json
Object type: SiteMap
Download schema: site-map.update.schema.json
Request body:
{
"mapId": 1864,
"description": "Default site map.",
"name": "site_map1"
}
PUT /api/
Sample: /api/
Content-Type: multipart/form-data
See Parameters for details on upload content.
Parameter | Type | Sample | Description |
---|---|---|---|
URL path parameters | |||
mapId |
Integer | 1 |
Uniquely identifies a site map instance. |
Form parameters | |||
metadata |
File | {"mapId":1864, "description":"Default site map.", "name":"site_map1"}
|
The metadata portion is the JSON configuration describing the mapping object. |
config |
File | map 0.0.0.0/0 : zone "Primary Site" || zone "Site Central"
|
A site map in its native format, as described in Aura documentation. |
Status 200
application/json
Object type: SiteMap
Download schema: site-map.read-detailed.schema.json
Response body:
{
"mapId": 1864,
"description": "Default site map.",
"name": "site_map1"
}
Run the List site maps operation to locate and store the target SiteMap object and
mapId
.Update the SiteMap object.
If updating only the metadata, PUT the SiteMap metadata object to
/api/
using the HTTPlcdn-mapping/ v1/ site-maps/ {mapId} application/json
Content-Type.If updating the metadata and content, make a PUT request to
/api/
using the HTTPlcdn-mapping/ v1/ site-maps/ {mapId} multipart/form-data
Content-Type. Supply the metadata as the first part with HTTPapplication/json
Content-Type, and the map content as the second part with HTTPtext/plain
Content-Type.The response reflects the updated SiteMap object.
Remove a site map
This operation removes a site map instance.
DELETE /api/
Sample: /api/
Parameter | Type | Sample | Description |
---|---|---|---|
URL path parameters | |||
mapId |
Integer | 1 |
Uniquely identifies a site map instance. |
Status 204
If you don’t have a
mapId
value, run the List site maps operation to locate the SiteMap and store themapId
value.Make a DELETE request to
/api/
.lcdn-mapping/ v1/ site-maps/ {mapId}
Get a site map
This operation gets the details of a site map instance.
GET /api/
Sample: /api/
Parameter | Type | Sample | Description |
---|---|---|---|
URL path parameters | |||
mapId |
Integer | 1 |
Uniquely identifies a site map instance. |
Status 200
application/json
Object type: SiteMap
Download schema: site-map.read-detailed.schema.json
Response body:
{
"mapId": 1864,
"description": "Default site map.",
"name": "site_map1"
}
Run the List site maps operation to locate the
mapId
parameter of the target SiteMap object.Make a GET request to
/api/
.lcdn-mapping/ v1/ site-maps/ {mapId} The operation responds with an SiteMap object.
Create a new GeoIP configuration
This operation creates a new GeoIP configuration instance.
POST /api/
Content-Type: multipart/form-data
See Parameters for details on upload content.
Parameter | Type | Sample | Description |
---|---|---|---|
Form parameters | |||
metadata |
File | {"name":"geoip_config_1", "type":"IPV4", "description":"Configuration for GeoIP integration."}
|
The metadata portion is the JSON configuration describing the mapping object. |
config |
File | "1.0.0.0","1.0.0.253","16777216","16777471","AU","Australia"
... |
A GeoIP database as obtained from the vendor. |
Status 200
application/json
Headers:
Location: https://akzz-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/api/lcdn-mapping/v1/geoip-configs/1
Object type: GeoIpConfig
Download schema: geoip-config.read-detailed.schema.json
Response body:
{
"geoIpConfigId": 2001,
"name": "geoip_config_1",
"description": "Configuration for GeoIP integration.",
"type": "IPV4",
"dateCreated": "2020-06-18T01:55:39.000+0000",
"lastUpdated": "2020-06-18T01:55:39.000+0000"
}
Status 201
Headers:
Location: https://akzz-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/api/infrastructure/v1/attribute-types/1
Prepare the GeoIpConfig configuration. For more information, see the Aura LCDN HyperCache Guide and the Aura LCDN Request Router Guide.
Construct an GeoIpConfig metadata object to describe the map.
Make a POST request to
/api/
using the HTTPlcdn-mapping/ v1/ bgp-configs multipart/form-data
Content-Type. Supply the metadata as the first part with HTTPapplication/json
Content-Type, and the GeoIpConfig content as the second part with HTTPtext/csv
Content-Type.The
Location
header in the response provides a URL to the created object.The response is of type
application/json
, and the body is a GeoIpConfig metadata object.
List GeoIP configurations
This operation returns a list of all GeoIP configurations.
GET /api/
Status 200
application/json
Object type: GeoIpConfig
Download schema: geoip-config.collection.schema.json
Response body:
{
"geoIpConfigs": [
{
"geoIpConfigId": 2001,
"name": "geoip_config_1"
}
],
"page": {
"pageNumber": 1,
"pageSize": 100,
"totalPages": 1,
"totalResults": 1
}
}
Use the
pageSize
andpageNumber
query parameters to control the set of data that gets returned.Optionally specify the
view
query parameter with a value ofdetailed
to request the full details of each object within the collection.Make a GET request to
/api/
.lcdn-mapping/ v1/ geoip-configs The operation responds with a paged collection of GeoIpConfig objects.
Update a GeoIP configuration
This operation updates the details of a GeoIP configuration instance.
PUT /api/
Sample: /api/
Content-Type: application/json
Object type: GeoIpConfig
Download schema: geoip-config.update.schema.json
Request body:
{
"geoIpConfigId": 2001,
"name": "geoip_config_1",
"description": "Configuration for GeoIP integration.",
"type": "IPV4"
}
PUT /api/
Sample: /api/
Content-Type: multipart/form-data
See Parameters for details on upload content.
Parameter | Type | Sample | Description |
---|---|---|---|
URL path parameters | |||
geoIpConfigId |
Integer | 1 |
Uniquely identifies a GeoIP configuration instance. |
Form parameters | |||
metadata |
File | {"geoIpConfigId":2001, "name":"geoip_config_1", "description":"Configuration for GeoIP integration.", "type":"IPV4"}
|
The metadata portion is the JSON configuration describing the mapping object. |
config |
File | "1.0.0.0","1.0.0.253","16777216","16777471","AU","Australia"
... |
A GeoIP database as obtained from the vendor. |
Status 200
application/json
Object type: GeoIpConfig
Download schema: geoip-config.read-detailed.schema.json
Response body:
{
"geoIpConfigId": 2001,
"name": "geoip_config_1",
"description": "Configuration for GeoIP integration.",
"type": "IPV4",
"dateCreated": "2020-06-18T01:55:39.000+0000",
"lastUpdated": "2020-06-18T01:55:39.000+0000"
}
Run the List GeoIP configurations operation to locate and store the target GeoIpConfig object and
geoIpConfigId
.Update the GeoIpConfig object.
If updating only the metadata, PUT the GeoIpConfig metadata object to
/api/
using the HTTPlcdn-mapping/ v1/ geoip-configs/ {geoIpConfigId} application/json
Content-Type.If updating the metadata and content, make a PUT request to
/api/
using the HTTPlcdn-mapping/ v1/ geoip-configs/ {geoIpConfigId} multipart/form-data
Content-Type. Supply the metadata as the first part with HTTPapplication/json
Content-Type, and the map content as the second part with HTTPtext/csv
Content-Type.The response reflects the updated GeoIpConfig object.
Remove a GeoIP configuration
This operation removes a GeoIP configuration instance.
DELETE /api/
Sample: /api/
Parameter | Type | Sample | Description |
---|---|---|---|
URL path parameters | |||
geoIpConfigId |
Integer | 1 |
Uniquely identifies a GeoIP configuration instance. |
Status 204
If you don’t have a
geoIpConfigId
value, run the List GeoIP configurations operation to locate the GeoIpConfig and store thegeoIpConfigId
value.Make a DELETE request to
/api/
.lcdn-mapping/ v1/ geoip-configs/ {geoIpConfigId}
Get a GeoIP configuration
This operation retrieves the details of a GeoIP configuration instance.
GET /api/
Sample: /api/
Parameter | Type | Sample | Description |
---|---|---|---|
URL path parameters | |||
geoIpConfigId |
Integer | 1 |
Uniquely identifies a GeoIP configuration instance. |
Status 200
application/json
Object type: GeoIpConfig
Download schema: geoip-config.read-detailed.schema.json
Response body:
{
"geoIpConfigId": 2001,
"name": "geoip_config_1",
"description": "Configuration for GeoIP integration.",
"type": "IPV4",
"dateCreated": "2020-06-18T01:55:39.000+0000",
"lastUpdated": "2020-06-18T01:55:39.000+0000"
}
Run the List GeoIP configurations operation locate the
geoIpConfigId
parameter of the target GeoIpConfig object.Make a GET request to
/api/
.lcdn-mapping/ v1/ geoip-configs/ {geoIpConfigId} The operation responds with an GeoIpConfig object.
Data
This section describes the data objects that the Aura LCDN Mapping API exposes.
Download the JSON schemas for this API.
This section’s data schema tables list membership requirements as follows:
✓ | Member is required in requests, or always present in responses, even if its value is empty or null . |
○ | Member is optional, and may be omitted in some cases. |
SiteMap
Site map object descriptions.
Download schema:
site-map.read-detailed.schema.json
Sample POST request:
{
"description": "Default site map.",
"name": "site_map1"
}
Sample PUT request:
{
"mapId": 1864,
"description": "Default site map.",
"name": "site_map1"
}
Sample GET response:
{
"mapId": 1864,
"description": "Default site map.",
"name": "site_map1"
}
SiteMap members
Member | Type | Required | Description |
---|---|---|---|
SiteMap : Site map object descriptions. |
|||
description |
String | ○ | A description for the entity. |
mapId |
Integer | ✓ | Read-only. The unique identifier for an entity. |
name |
String | ✓ | A unique name for the entity. |
AccessMap
Access Map object definitions.
Download schema:
access-map.read-detailed.schema.json
Sample POST request:
{
"description": "Default access map.",
"name": "access_map1"
}
Sample PUT request:
{
"mapId": 1863,
"description": "Default access map.",
"name": "access_map1"
}
Sample GET response:
{
"mapId": 1863,
"description": "Default access map.",
"name": "access_map1"
}
AccessMap members
Member | Type | Required | Description |
---|---|---|---|
AccessMap : Access Map object definitions. |
|||
description |
String | ○ | A description for the entity. |
mapId |
Integer | ✓ | Read-only. The unique identifier for an entity. |
name |
String | ✓ | A unique name for the entity. |
BgpConfig
BGP configuration object descriptions.
Download schema:
bgp-config.read-detailed.schema.json
Sample POST request:
{
"name": "bgp_config_1",
"description": "Configuration for BGP integration."
}
Sample PUT request:
{
"bgpConfigId": 2072,
"name": "bgp_config_1",
"description": "Configuration for BGP integration."
}
Sample GET response:
{
"bgpConfigId": 2072,
"name": "bgp_config_1",
"description": "Configuration for BGP integration.",
"dateCreated": "2020-06-18T01:55:39.000+0000",
"lastUpdated": "2020-06-18T01:55:39.000+0000"
}
BgpConfig members
Member | Type | Required | Description |
---|---|---|---|
BgpConfig : BGP configuration object descriptions. |
|||
bgpConfigId |
Integer | ✓ | Read-only. The unique identifier for a BGP configuration. |
dateCreated |
String | ○ | Timestamp of when the configuration was created. |
description |
String | ○ | A description for the entity. |
lastUpdated |
String | ○ | Timestamp of when the configuration was last updated. |
name |
String | ✓ | A unique name for the entity. |
GeoIpConfig
GeoIP configuration object.
Download schema:
geoip-config.read-detailed.schema.json
Sample POST request:
{
"name": "geoip_config_1",
"type": "IPV4",
"description": "Configuration for GeoIP integration."
}
Sample PUT request:
{
"geoIpConfigId": 2001,
"name": "geoip_config_1",
"description": "Configuration for GeoIP integration.",
"type": "IPV4"
}
Sample GET response:
{
"geoIpConfigId": 2001,
"name": "geoip_config_1",
"description": "Configuration for GeoIP integration.",
"type": "IPV4",
"dateCreated": "2020-06-18T01:55:39.000+0000",
"lastUpdated": "2020-06-18T01:55:39.000+0000"
}
GeoIpConfig members
Member | Type | Required | Description |
---|---|---|---|
GeoIpConfig : GeoIP configuration object. |
|||
dateCreated |
String | ○ | Timestamp of when the configuration was created. |
description |
String | ○ | A description for the entity. |
geoIpConfigId |
Integer | ✓ | Read-only. The unique identifier for a GeoIP configuration. |
lastUpdated |
String | ○ | Timestamp of when the configuration was last updated. |
name |
String | ✓ | A unique name for the entity. |
type |
Enumeration | ✓ | Type of GeoIP data. Specifies the address type used in the GeoIP configuration file. IPV4 indicates the GeoIP configuration file uses an IPv4 address. IPV6 indicates the GeoIP configuration file uses an IPv6 address. |
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 map that does not exist, the API responds with a JSON object such as this:
{
"type" : "https://akzz-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/api/lcdn-mapping/errors#core.entity-not-found",
"title" : "The requested entity could not be found",
"detail" : "Map 99999 does not exist",
"instance" : "https://akzz-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/api/lcdn-mapping/v1/site-maps/99999#fae1fd860940d25d",
"entityType" : "Map",
"entityId" : 99999
}
HTTP status codes
This section lists the full range of response codes the API may generate.
Code | Description |
---|---|
200 | The operation was successful. |
201 | Resource successfully created. |
400 | Bad request. |
401 | Authentication failure. |
403 | The client doesn’t have the appropriate authority to perform the requested operation. |
404 | Resource not found. |
405 | Method not supported. |
409 | Conflict with the current state of the resource. |
415 | Unsupported media type. |
503 | Service is temporarily unavailable. |