- Overview
- Resources
- API summary
- Get a log configuration
- Update a log configuration
- Remove a log configuration
- Copy a log configuration
- Suspend a log configuration
- Resume a log configuration
- List delivery frequencies
- Get a delivery frequency
- List log delivery thresholds
- Get a log delivery threshold
- Get a log format
- List log encodings
- Get a log encoding
- List message sizes
- Get a message size
- List contacts
- Get a contact
- List log redeliveries
- Create a new log redelivery
- Get a log redelivery
- List log sources
- List log sources by type
- List log configurations by type
- List log formats by type
- List log encodings by type
- Get a log source
- List log configurations per ID
- Create a new log configuration
- List log formats per ID
- Data
- Errors
Log Delivery Service API v3
View, update, and delete scheduled log deliveries, and adjust details of your log delivery setup.
Learn more:
Download this API’s RAML and JSON schema descriptors.
Overview
Akamai’s infrastructure is constantly gathering the log entries from the thousands of edge servers around the world. Log Delivery Service creates a copy of these logs, separates your logs from other customer logs, and then delivers your logs based on a schedule you define.
The Log Delivery Service API allows you to view, update, and delete scheduled log deliveries. Additionally, the API allows you to adjust details of your log delivery setup, or configuration, including schedule, log format, delivery mechanism, aggregation method, data completion thresholds, residual data delivery, and requests for redelivery. This API provides you with a programmatic interface to the same functionality available in Akamai Control Center.
NOTE: This new version of the API increments directly to v3, bypassing an internal-only v2. See version 1 for information on the previous legacy API.
Who should use this API
This API is intended for those who receive logs from Akamai and are responsible for processing them.
Getting started
Before using the API for the first time:
Review Get Started for API tools that Akamai provides.
Review Authorize Your Client to create your Akamai API access credentials and authorizations. As detailed in The API Identity Model, you then access the API using custom hostnames that looks like this:
https://akzz-XXXXXXXXXXXXXXXX-XXXXXXXXXXXXXXXX.luna.akamaiapis.net.To use the Log Delivery Service API, you need to be a customer of Log Delivery Service to configure the service and begin receiving logs from that point forward. Logs are not available retroactively, and logs for those who do not subscribe to Log Delivery Service are not retrievable.
The API limits the scope of the returned data by the user’s account, its permissions, and access the business objects (for example, a CP code or a DNS zone) that are associated with the user and account.
LDS data is generally retained for the last eight days.
If you need help, provide feedback in the Akamai developer community or contact your Akamai representative for support.
Hypermedia
Throughout this API, Hypermedia links members allow automated client
applications to navigate to relevant data and execute related
operations.
This example from within a description of a log configuration object
provides a direct link to a API call necessary to access the object,
in this case log-configurations-for-log-source. The href elements
included indicate the availability of log configuration data. For
example, this references the API operation that lists the existing log
delivery configurations of log source type cpcode-products with the
specified id. Note that where the necessary operation is not called
out specifically after the href element, it is identified in the
title and link relation rel.
{
"links":[
{
"title":"Get log delivery configurations for the same log source",
"rel":"get-log-configurations-for-log-source",
"href":"/lds-api/v3/cpcode-products/{id}/log-configurations"
}
]
}
Resources
The Log Delivery Service API enables you to retrieve logs for your content on the Akamai edge platform. You can view, update, and delete scheduled log deliveries. Additionally, you can adjust details of your log delivery (your log delivery configuration) including the schedule, log format, delivery mechanism, aggregation method, data completion thresholds, residual data delivery, and requests for redelivery.
You should be familiar with the following LDS concepts:
Log Sources. Log sources are all the business objects for which log delivery can be set up, called a
logSourceType. Currently available log sources are CP code, DNS zones, domains for Traffic Management, and AnswerX objects. Akamai collect logs for the log sources and sends them as defined in the log delivery configurations you configure in this API. Each log source has a type and a unique ID.Configurations. You can create one LDS configuration for each log source. Once you initially configure an Akamai service for log delivery, you can view, edit, and suspend and reactivate that log delivery configuration.
Aggregation. Log deliveries can be aggregated by arrival time or by calendar day. Aggregating by arrival time sends log data in the order in which it arrives from Akamai’s edge platform. This is the fastest way to get log data, but it is more difficult to process. For example, a delivery that covers a 24-hour period usually contains some data from the previous several days. Aggregating by calendar day sends most of the hits for each GMT calendar day in a single delivery. You can set a completion threshold at which you want logs set, and whether you want residual data sent later.
Completion Threshold. The completion threshold determines the percentage of expected logs to process before you receive the log data. Setting a high threshold value ensures that the delivered data is as complete as possible, but might cause deliveries to be delayed to meet the threshold. Setting a lower threshold value ensures more timely deliveries, but more of the data (residual data) might be deferred to a leftover delivery.
Residual data. You can choose to receive deliveries containing leftover log lines that were not included in either the bulk delivery or a previous leftover delivery.
Delivery Method. You can receive log data via email or FTP.
Message Size. Logs are broken into parts before compression, so the estimation of message size is based on the uncompressed file size. Compressed message size options range from 1–50 MB compressed (approximately 6–300 MB uncompressed.)
Encoding. LDS offers three encoding options: gzipped and uuencoded, MIME with base–64 encoding, and GPG Encrypted (which requires you to upload a key). Otherwise, the main difference is support by mail clients. Your encoding options depend on whether you are receiving log delivery via email or FTP. Note that AnswerX Managed, AnswerX Cloud, and Enterprise Threat Protector services support only GPG encoding.
Contacts. LDS requires that you provide email and phone number contact information for announcements about changes to LDS as well as automated delivery failure notices. It is important that you check this email frequently to diagnose and correct delivery failures, as well as arrange log redeliveries if necessary.
Redeliveries. You can request redelivery of a log for a specific configuration and a designated time period for which you want logs sent again. Note that Akamai sends log redeliveries at a lower priority than normal log deliveries, and you may not request a redelivery until the original log delivery is complete. The intervals at which redeliveries are sent depends on whether you choose aggregating by arrival time or calendar day when setting up log deliveries. If you aggregate by arrival time, you can choose the date, start, and end times for the redeliveries, which will be sent at the same frequency as the original delivery configuration. If you aggregate by calendar day, you can choose a date for the redelivery; you can request calendar day redeliveries only for an entire day, so there will be no start and end times option.
You typically follow this workflow to create a new configuration for log delivery.
Run the List Log Sources operation to retrieve all available log sources and associated ID numbers to which you have access.
Retrieve the parameter values necessary to create a log delivery configuration. You need to retain the associated IDs to build a valid request object for the configuration.
Run the List Log Formats Per ID operation to retrieve all available log formats and associated log source IDs for this
logSourceTypeandlogSourceId.Run the List Log Encodings operation to retrieve the
idfor the desired encoding type.Run the List Delivery Frequencies operation to retrieve the
idfor desired delivery frequency.Run the List Message Sizes operation to retrieve the
idfor the desired log delivery message size.Run the List Contacts operation to retrieve
idvalues for the desired contacts.
Run the Create a New Log Configuration operation, with the request object built as defined by the Log Configuration Definitions Schema.
API summary
Download the RAML descriptors for this API.
| Operation | Method | Endpoint |
|---|---|---|
| Log Configurations | ||
| Get a Log Configuration | GET | /lds-api/ |
| Update a Log Configuration | PUT | /lds-api/ |
| Remove a Log Configuration | DELETE | /lds-api/ |
| Copy a Log Configuration | POST | /lds-api/ |
| Suspend a Log Configuration | POST | /lds-api/ |
| Resume a Log Configuration | POST | /lds-api/ |
| Log Configuration Parameters | ||
| List Delivery Frequencies | GET | /lds-api/ |
| Get a Delivery Frequency | GET | /lds-api/ |
| List Log Delivery Thresholds | GET | /lds-api/ |
| Get a Log Delivery Threshold | GET | /lds-api/ |
| Get a Log Format | GET | /lds-api/ |
| List Log Encodings | GET | /lds-api/ |
| Get a Log Encoding | GET | /lds-api/ |
| List Message Sizes | GET | /lds-api/ |
| Get a Message Size | GET | /lds-api/ |
| List Contacts | GET | /lds-api/ |
| Get a Contact | GET | /lds-api/ |
| Log Redeliveries | ||
| List Log Redeliveries | GET | /lds-api/ |
| Create a New Log Redelivery | POST | /lds-api/ |
| Get a Log Redelivery | GET | /lds-api/ |
| Log Sources | ||
| List Log Sources | GET | /lds-api/ |
| List Log Sources by Type | GET | /lds-api/ |
| List Log Configurations by Type | GET | /lds-api/ |
| List Log Formats by Type | GET | /lds-api/ |
| List Log Encodings by Type | GET | /lds-api/ |
| Get a Log Source | GET | /lds-api/ |
| List Log Configurations Per ID | GET | /lds-api/ |
| Create a New Log Configuration | POST | /lds-api/ |
| List Log Formats Per ID | GET | /lds-api/ |
Get a log configuration
Retrieves a specific log delivery configuration.
GET /lds-api/
Sample: /lds-api/
| Parameter | Type | Sample | Description |
|---|---|---|---|
| URL parameters | |||
logConfigurationId |
Number | 163842 |
Unique identifier for each log delivery configuration. |
Status 200
application/json
Response Body:
{
"id": "163842",
"status": "active",
"startDate": "2013-01-02",
"logSource": {
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-sources/cpcode-products/200957-1"
},
{
"rel": "cpcode-products",
"href": "/lds-api/v3/log-sources/cpcode-products"
},
{
"rel": "log-sources",
"href": "/lds-api/v3/log-sources"
}
],
"type": "cpcode-products",
"id": "200957-1",
"cpCode": "200957 - MOCK CP CODE DESCR ",
"products": [
"HTTP Content Delivery"
]
},
"aggregationDetails": {
"type": "byLogArrival",
"deliveryFrequency": {
"id": "1",
"value": "Every 24 hours",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies/1"
},
{
"rel": "deliveryFrequencies",
"href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies"
}
]
}
},
"contactDetails": {
"mailAddresses": [
"jjudge@akamai.com"
],
"contact": {
"id": "1-C30O",
"value": ". Help-Desk - phone: 617.250.3900",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/contacts/1-C30O"
},
{
"rel": "contacts",
"href": "/lds-api/v3/log-configuration-parameters/contacts"
}
]
}
},
"deliveryDetails": {
"type": "ftp",
"machine": "akainsight.upload.akamai.com",
"login": "insightlds",
"directory": "/23567/logs/200957",
"password": ""
},
"encodingDetails": {
"encoding": {
"id": "3",
"value": "GZIP",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/encodings/3"
},
{
"rel": "encodings",
"href": "/lds-api/v3/log-configuration-parameters/encodings"
}
]
}
},
"logFormatDetails": {
"logIdentifier": "200957",
"logFormat": {
"id": "2",
"value": "combined",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/log-formats/2"
},
{
"rel": "logFormats",
"href": "/lds-api/v3/log-configuration-parameters/log-formats"
}
]
}
},
"messageSize": {
"id": "1",
"value": "50 MB (approx. 300 MB uncompressed logs)",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/message-sizes/1"
},
{
"rel": "messageSizes",
"href": "/lds-api/v3/log-configuration-parameters/message-sizes"
}
]
},
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration/163842"
},
{
"rel": "get-log-configurations-for-log-source",
"href": "/lds-api/v3/log-sources/cpcode-products/200957-1/log-configurations",
"title": "Get Log Configurations for the same log source"
},
{
"rel": "get-log-configurations-for-log-source-type",
"href": "/lds-api/v3/log-sources/cpcode-products/log-configurations",
"title": "Get Log Configurations for the same log source type"
},
{
"rel": "update-log-configuration",
"href": "/lds-api/v3/log-configuration/163842",
"method": "PUT",
"title": "Update Log Configuration"
},
{
"rel": "delete-log-configuration",
"href": "/lds-api/v3/log-configuration/163842",
"method": "DELETE",
"title": "Delete Log Configuration"
},
{
"rel": "suspend-log-configuration",
"href": "/lds-api/v3/log-configuration/163842/suspend",
"method": "POST",
"title": "Suspend Log Configuration"
}
]
}
Run the List Log Sources operation.
Store the
logSourceTypeandlogSourceIdfrom the appropriate object in that listing.Run the List Log Configurations by Type operation to retrieve a list of log configurations for that log source type.
Store the appropriate
logConfigurationIdfrom that listing.Make a GET request to
/lds-api/.v3/ log-configurations/ {logConfigurationId} The response object includes the full representation of the configuration with the specified
logConfigurationId.
Update a log configuration
Modifies a specific log delivery. You need to specify
all the data members in the request, or missing members are
removed from the configuration. The response’s Location header
reflects where you can access the new configuration.
PUT /lds-api/
Sample: /lds-api/
Content-Type: application/json
Request Body:
{
"startDate": "2012-10-31",
"contactDetails": {
"contact": {
"id": "1-2LPWVP"
},
"mailAddresses": [
"asfasf@fa.pl"
]
},
"logFormatDetails": {
"logFormat": {
"id": "12"
},
"logIdentifier": "dfgd"
},
"messageSize": {
"id": "2"
},
"aggregationDetails": {
"type": "byLogArrival",
"deliveryFrequency": {
"id": "1"
}
},
"encodingDetails": {
"encoding": {
"id": "1"
}
},
"deliveryDetails": {
"type": "email",
"emailAddress": "asf@fa.pl"
}
}
| Parameter | Type | Sample | Description |
|---|---|---|---|
| URL parameters | |||
logConfigurationId |
Number | 163842 |
Unique identifier for each log delivery configuration. |
Status 201
Headers:
Location: /lds-api/v3/log-configurations/163842
Run the Get Log Configurations by Type operation.
Store the
logConfigurationIdfrom the appropriate object in that listing.When creating the request object, include all required members for the LogConfiguration object.
Make a PUT request to
/lds-api/.v3/ log-configurations/ {logConfigurationId}
Remove a log configuration
Deletes a specific log delivery configuration.
DELETE /lds-api/
Sample: /lds-api/
| Parameter | Type | Sample | Description |
|---|---|---|---|
| URL parameters | |||
logConfigurationId |
Number | 163842 |
Unique identifier for each log delivery configuration. |
Status 204
Run the List Log Sources operation.
Store the
logSourceTypefor the appropriate object from that listing.Make a GET request to
/lds-api/v3/log-sources/{logSourceType}/log-configurationsto get a list of configurations for thatlogSourceTypeand their associated configuration IDs. You need thelogConfigurationIdto make the DELETE request.Store the
logConfigurationIdfor the appropriate object in that listing.Make a DELETE request to
/lds-api/.v3/ log-configurations/ {logConfigurationId}
Copy a log configuration
Copies a specific log delivery configuration to a target log source to produce a new log delivery configuration.
POST /lds-api/
Sample: /lds-api/
Content-Type: application/json
Request Body:
{
"copyTarget": {
"logSource": {
"type": "gtm",
"id": "1243"
}
}
}
| Parameter | Type | Sample | Description |
|---|---|---|---|
| URL parameters | |||
logConfigurationId |
Number | 163842 |
Unique identifier for each log delivery configuration. |
Status 201
Headers:
Location: /lds-api/v3/log-configurations/268230
Run the List Log Sources operation.
Store the
logSourceTypeandlogSourceIdfrom the appropriate object in that listing. You need to identify the target source in the request object.Run the Get Log Configurations by Type operation.
Store the
logConfigurationIdfrom the appropriate object in that listing.Make a POST request to
/lds-api/.v3/ log-configurations/ {logConfigurationId}/ copy
Suspend a log configuration
Suspends log delivery for a specific configuration. You will not receive logs for this configuration while it is suspended.
POST /lds-api/
Sample: /lds-api/
| Parameter | Type | Sample | Description |
|---|---|---|---|
| URL parameters | |||
logConfigurationId |
Number | 163842 |
Unique identifier for each log delivery configuration. |
Status 204
Run the Get Log Configurations by Type operation.
Store the
logConfigurationIdfrom the appropriate object in that listing.Make a POST request to
/lds-api/.v3/ log-configurations/ {logConfigurationId}/ suspend
Resume a log configuration
Resumes log delivery for a specific configuration.
POST /lds-api/
Sample: /lds-api/
| Parameter | Type | Sample | Description |
|---|---|---|---|
| URL parameters | |||
logConfigurationId |
Number | 163842 |
Unique identifier for each log delivery configuration. |
Status 204
Run the Get Log Configurations by Type operation.
Store the
logConfigurationIdfrom the appropriate object in that listing.Make a POST request to
/lds-api/.v3/ log-configurations/ {logConfigurationId}/ resume
List delivery frequencies
Returns all available delivery frequencies, each with an id and descriptive value.
You need the id to create or modify a log delivery configuration.
GET /lds-api/
Status 200
application/json
Response Body:
[
{
"id": "1",
"value": "Every 24 hours",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies/1"
},
{
"rel": "deliveryFrequencies",
"href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies"
}
]
},
{
"id": "2",
"value": "Every 12 hours",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies/2"
},
{
"rel": "deliveryFrequencies",
"href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies"
}
]
}
]
Make a GET request to
/lds-api/to retrieve a list of delivery frequency optionsv3/ log-configuration-parameters/ delivery-frequencies valueandid.Store the
idto use when creating or updating a log delivery configuration.
Get a delivery frequency
Returns a specific delivery frequency.
GET /lds-api/
Sample: /lds-api/
| Parameter | Type | Sample | Description |
|---|---|---|---|
| URL parameters | |||
deliveryFrequencyId |
Integer | 1 |
Unique identifier for a delivery frequency. |
Status 200
application/json
Response Body:
{
"id": "1",
"value": "Every 24 hours",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies/1"
},
{
"rel": "deliveryFrequencies",
"href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies"
}
]
}
Run the List Delivery Frequencies operation.
Store the
idfrom the appropriate delivery frequency in that listing.Make a GET request to
/lds-api/.v3/ log-configuration-parameters/ delivery-frequencies/ {deliveryFrequencyId}
List log delivery thresholds
Returns all available log delivery thresholds, each with an id and descriptive value.
GET /lds-api/
Status 200
application/json
Response Body:
[
{
"id": "1",
"value": "99",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/delivery-thresholds/1"
},
{
"rel": "deliveryThresholds",
"href": "/lds-api/v3/log-configuration-parameters/delivery-thresholds"
}
]
},
{
"id": "2",
"value": "99.5",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/delivery-thresholds/2"
},
{
"rel": "deliveryThresholds",
"href": "/lds-api/v3/log-configuration-parameters/delivery-thresholds"
}
]
}
]
Make a GET request to
/lds-api/retrieve a list of delivery threshold optionsv3/ log-configuration-parameters/ delivery-thresholds valueandid.Store the delivery threshold
idto use when creating or updating a log delivery configuration.
Get a log delivery threshold
Returns a specific log delivery threshold.
GET /lds-api/
Sample: /lds-api/
| Parameter | Type | Sample | Description |
|---|---|---|---|
| URL parameters | |||
deliveryThresholdId |
Integer | 1 |
Unique identifier for a delivery threshold. |
Status 200
application/json
Response Body:
{
"id": "1",
"value": "99",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/delivery-thresholds/1"
},
{
"rel": "deliveryThresholds",
"href": "/lds-api/v3/log-configuration-parameters/delivery-thresholds"
}
]
}
Run the List Log Delivery Thresholds operation.
Store the
idfrom the appropriate delivery threshold in that listing.Make a GET request to
/lds-api/.v3/ log-configuration-parameters/ delivery-thresholds/ {deliveryThresholdId}
Get a log format
Returns a specific log format. You need this id to specify the log
format for a log delivery configuration.
GET /lds-api/
Sample: /lds-api/
| Parameter | Type | Sample | Description |
|---|---|---|---|
| URL parameters | |||
logFormatId |
Integer | 1 |
Unique identifier for a log format. |
Status 200
application/json
Response Body:
{
"id": "2",
"value": "combined",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/log-formats/2"
},
{
"rel": "logFormats",
"href": "/lds-api/v3/log-configuration-parameters/log-formats"
},
{
"rel": "logSources",
"href": "/lds-api/v3/log-sources/cpcode-products/1-17310"
}
]
}
Run the List Log Sources operation.
Store the
logSourceTypefrom the appropriate object in that listing.Make a GET request to
/lds-api/.v3/ log-sources/ {logSourceType}/ log-formats Store the
logFormatIdfrom the appropriate object in that listing.Make a GET request to
/lds-api/.v3/ log-configuration-parameters/ log-formats/ {logFormatId}
List log encodings
Returns all available log encoding options. You can restrict the response by
specifying optional values for the deliveryType and logSourceType, since
available encoding types are based on these characteristics of a log delivery
configuration.
GET /lds-api/
Sample: /lds-api/
| Parameter | Type | Sample | Description |
|---|---|---|---|
| Optional query parameters | |||
deliveryType |
Enumeration | email |
Possible encodings for log configuration are based on chosen type of delivery, either email or ftp. |
logSourceType |
Enumeration | cpcode-products |
Possible encodings for logs configuration are based on type of target log source for which configuration is created, either cpcode-products, gtm, edns, or answerx. |
Status 200
application/json
Response Body:
[
{
"id": "3",
"value": "GZIP",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/encodings/3"
},
{
"rel": "encodings",
"href": "/lds-api/v3/log-configuration-parameters/encodings"
}
]
},
{
"id": "4",
"value": "GPG Encrypted",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/encodings/4"
},
{
"rel": "encodings",
"href": "/lds-api/v3/log-configuration-parameters/encodings"
}
]
}
]
You can optionally limit the allowable encodings returned by
deliveryType, eitheremailorftp.You can optionally limit the allowable encodings returned by
logSourceType. Run the List Log Sources by Type operation and store the appropriatelogSourceTypefrom that listing.Make a GET request to
/lds-api/.v3/ log-configuration-parameters/ encodings{?deliveryType, logSourceType} The response lists the allowable encoding options for the specified
deliveryTypeandlogSourceType. Store the encodingidto use when creating and modifying log delivery configurations.
Get a log encoding
Returns a specific log encoding.
GET /lds-api/
Sample: /lds-api/
| Parameter | Type | Sample | Description |
|---|---|---|---|
| URL parameters | |||
encodingId |
Integer | 1 |
Unique identifier for an encoding type. |
Status 200
application/json
Response Body:
{
"id": "3",
"value": "GZIP",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/encodings/3"
},
{
"rel": "encodings",
"href": "/lds-api/v3/log-configuration-parameters/encodings"
}
]
}
Run the List Log Encodings operation.
Store the
idfrom the appropriate encoding in that listing.Make a GET request to
/lds-api/.v3/ log-configuration-parameters/ encodings/ {encodingId}
List message sizes
Returns all available message sizes, each with an id and descriptive value.
You need the id to create or modify a log delivery configuration.
GET /lds-api/
Status 200
application/json
Response Body:
[
{
"id": "1",
"value": "50 MB (approx. 300 MB uncompressed logs)",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/message-sizes/1"
},
{
"rel": "messageSizes",
"href": "/lds-api/v3/log-configuration-parameters/message-sizes"
}
]
},
{
"id": "2",
"value": "25 MB (approx. 150 MB uncompressed logs)",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/message-sizes/2"
},
{
"rel": "messageSizes",
"href": "/lds-api/v3/log-configuration-parameters/message-sizes"
}
]
}
]
Make a GET request to
/lds-api/.v3/ log-configuration-parameters/ message-sizes The response lists the available message sizes with a
valueandid. Store the message sizeidto use when creating and modifying log delivery configurations.
Get a message size
Retrieves a specific message size.
GET /lds-api/
Sample: /lds-api/
| Parameter | Type | Sample | Description |
|---|---|---|---|
| URL parameters | |||
messageSizeId |
Integer | 1 |
Unique identifier for a message size. You need this message size id to create or modify a log delivery configuration. |
Status 200
application/json
Response Body:
{
"id": "1",
"value": "50 MB (approx. 300 MB uncompressed logs)",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/message-sizes/1"
},
{
"rel": "messageSizes",
"href": "/lds-api/v3/log-configuration-parameters/message-sizes"
}
]
}
Run the List Message Sizes operation.
Store the appropriate message size
idfrom that listing.Make a GET request to
/lds-api/.v3/ log-configuration-parameters/ message-sizes/ {messageSizeId}
List contacts
Returns all contacts to which you have access.
GET /lds-api/
Status 200
application/json
Response Body:
{
"id": "B-C-1JM7ZL1",
"value": "Bartosz Gula - phone: +48123847337",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/contacts/B-C-1JM7ZL1"
},
{
"rel": "contacts",
"href": "/lds-api/v3/log-configuration-parameters/contacts"
}
]
}
Make a GET request to
/lds-api/.v3/ log-configuration-parameters/ contacts Store the
contactIdfrom the appropriate object in that listing for use in creating or modifying a log delivery configuration.
Get a contact
Returns a specific contact, assuming the identity associated with the API client has access to it.
GET /lds-api/
Sample: /lds-api/
| Parameter | Type | Sample | Description |
|---|---|---|---|
| URL parameters | |||
contactId |
String | 1-2LPWVP |
Unique identifier for a specific contact. You need this contact id when you create or modify a log delivery configuration. |
Status 200
application/json
Response Body:
[
{
"id": "B-C-1JM7ZL1",
"value": "Bartosz Gula - phone: +48123847337",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/contacts/B-C-1JM7ZL1"
},
{
"rel": "contacts",
"href": "/lds-api/v3/log-configuration-parameters/contacts"
}
]
},
{
"id": "1-7SF29",
"value": "Customer Care - phone: 6172504699",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/contacts/1-7SF29"
},
{
"rel": "contacts",
"href": "/lds-api/v3/log-configuration-parameters/contacts"
}
]
}
]
Run the List Contacts operation.
Store the
contactIdfrom the appropriate object in that listing.Make a GET request to
/lds-api/v3/log-configuration-parameters/contacts/{contactId}.
List log redeliveries
Retrieves a list of requests to redeliver logs.
GET /lds-api/
Status 200
application/json
Response Body:
[
{
"logConfiguration": {
"id": "154519",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configurations/154519"
}
]
},
"id": "272480",
"beginTime": 3,
"endTime": 6,
"redeliveryDate": "2016-10-06",
"status": "new",
"createdDate": "2016-10-07",
"modifiedDate": "2016-10-07",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-redeliveries/272480"
},
{
"rel": "get-log-redeliveries",
"href": "/lds-api/v3/log-redeliveries",
"title": "Get Log Redeliveries"
},
{
"rel": "create-log-redelivery",
"href": "/lds-api/v3/log-redeliveries",
"method": "POST",
"title": "Create Log Redelivery"
}
]
},
{
"logConfiguration": {
"id": "154519",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configurations/154519"
}
]
},
"id": "272479",
"beginTime": 2,
"endTime": 5,
"redeliveryDate": "2016-10-07",
"status": "new",
"createdDate": "2016-10-07",
"modifiedDate": "2016-10-07",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-redeliveries/272479"
},
{
"rel": "get-log-redeliveries",
"href": "/lds-api/v3/log-redeliveries",
"title": "Get Log Redeliveries"
},
{
"rel": "create-log-redelivery",
"href": "/lds-api/v3/log-redeliveries",
"method": "POST",
"title": "Create Log Redelivery"
}
]
},
{
"logConfiguration": {
"id": "154519",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configurations/154519"
}
]
},
"id": "272477",
"beginTime": 2,
"endTime": 5,
"redeliveryDate": "2016-10-05",
"status": "new",
"createdDate": "2016-10-07",
"modifiedDate": "2016-10-07",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-redeliveries/272477"
},
{
"rel": "get-log-redeliveries",
"href": "/lds-api/v3/log-redeliveries",
"title": "Get Log Redeliveries"
},
{
"rel": "create-log-redelivery",
"href": "/lds-api/v3/log-redeliveries",
"method": "POST",
"title": "Create Log Redelivery"
}
]
},
{
"logConfiguration": {
"id": "154519",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configurations/154519"
}
]
},
"id": "272478",
"beginTime": 2,
"endTime": 5,
"redeliveryDate": "2016-10-06",
"status": "new",
"createdDate": "2016-10-07",
"modifiedDate": "2016-10-07",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-redeliveries/272478"
},
{
"rel": "get-log-redeliveries",
"href": "/lds-api/v3/log-redeliveries",
"title": "Get Log Redeliveries"
},
{
"rel": "create-log-redelivery",
"href": "/lds-api/v3/log-redeliveries",
"method": "POST",
"title": "Create Log Redelivery"
}
]
}
]
Make a GET request to
/lds-api/.v3/ log-redeliveries/ The response object returns a list of all log redelivery requests with their associated IDs.
Create a new log redelivery
Creates a new request to resend a log.
POST /lds-api/
Content-Type: application/json
Request Body:
{
"logConfiguration": {
"id": "154519"
},
"id": "272480",
"beginTime": 3,
"endTime": 6,
"redeliveryDate": "2016-10-06"
}
Status 201
Headers:
Location: /lds-api/v3/log-redelivery-request/268231
Run the Get Log Configurations by Type operation.
Store the
logConfigurationIdfrom the appropriate object in that listing. This is the log delivery configuration for which you want to request that the logs be redelivered.When creating the request object, you need to specify the
logConfiguration,beginTime,endTime, andredeliveryDatemembers. See the Redelivery object type for details.Make a POST request to
/lds-api/.v3/ log-redeliveries/
Get a log redelivery
Retrieves a specific log redelivery request.
GET /lds-api/
Sample: /lds-api/
| Parameter | Type | Sample | Description |
|---|---|---|---|
| URL parameters | |||
redeliveryId |
Integer | 13526 |
Unique identifier for the request to resend a log. |
Status 200
application/json
Response Body:
{
"logConfiguration": {
"id": "154519",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configurations/154519"
}
]
},
"id": "272480",
"beginTime": 3,
"endTime": 6,
"redeliveryDate": "2016-10-08",
"status": "new",
"createdDate": "2016-10-05",
"modifiedDate": "2016-10-07",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-redeliveries/272480"
},
{
"rel": "get-log-redeliveries",
"href": "/lds-api/v3/log-redeliveries",
"title": "Get Log Redeliveries"
},
{
"rel": "create-log-redelivery",
"href": "/lds-api/v3/log-redeliveries",
"method": "POST",
"title": "Create Log Redelivery"
}
]
}
Run the List Log Redeliveries operation.
Store the
redeliveryIdfrom the appropriate object in that listing.Make a GET request to
/lds-api/.v3/ log-redeliveries/ {redeliveryId}
List log sources
Returns all log sources (logSourceType) and log source ID (logSourceId) to which
the user has access. You need the logSourceType and logSourceId to create a log delivery configuration.
GET /lds-api/
Status 200
application/json
Response Body:
[
{
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-sources/cpcode-products/23456-4"
},
{
"rel": "cpcode-products",
"href": "/lds-api/v3/log-sources/cpcode-products"
},
{
"rel": "log-sources",
"href": "/lds-api/v3/log-sources"
},
{
"rel": "log-configurations",
"href": "/lds-api/v3/log-sources/cpcode-products/23456-4/log-configurations",
"method": "POST",
"title": "Create log configuration for this log source."
}
],
"type": "cpcode-products",
"id": "23456-4",
"cpCode": "23456 - MOCK CP CODE DESCR ",
"products": [
"Quicktime Streaming"
]
},
{
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-sources/gtm/142981"
},
{
"rel": "gtm",
"href": "/lds-api/v3/log-sources/gtm"
},
{
"rel": "log-sources",
"href": "/lds-api/v3/log-sources"
},
{
"rel": "log-configurations",
"href": "/lds-api/v3/log-sources/gtm/142981/log-configurations",
"method": "POST",
"title": "Create log configuration for this log source."
}
],
"type": "gtm",
"id": "142981",
"propertyName": "origin-newcolumbus-qa.abgvoice.com.akadns.net"
}
]
Make a GET request to
/lds-api/to retrieve all available log sources to which you have access.v3/ log-sources/ Store the
logSourceTypeandlogSourceIdto use when creating or modifying a log delivery configuration.
List log sources by type
Returns all log sources of the specified logSourceType.
GET /lds-api/
Sample: /lds-api/
| Parameter | Type | Sample | Description |
|---|---|---|---|
| URL parameters | |||
logSourceType |
Enumeration | cpcode-products |
Type of log source for which you can create a log delivery configuration, either cpcode-products, gtm-properties, edns-zones, or answerx-objects. For example, if you have Akamai Traffic Management and want to configure log delivery for it, retrieve the ID of your Traffic Management property by calling /lds-api/v3/log-sources/gtm-properties. Use the logSourceId to create a log delivery configuration. |
Status 200
application/json
Response Body:
[
{
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-sources/cpcode-products/23456-4"
},
{
"rel": "cpcode-products",
"href": "/lds-api/v3/log-sources/cpcode-products"
},
{
"rel": "log-sources",
"href": "/lds-api/v3/log-sources"
},
{
"rel": "log-configurations",
"href": "/lds-api/v3/log-sources/cpcode-products/23456-4/log-configurations",
"method": "POST",
"title": "Create log configuration for this log source."
}
],
"type": "cpcode-products",
"id": "23456-4",
"cpCode": "23456 - MOCK CP CODE DESCR ",
"products": [
"Quicktime Streaming"
]
},
{
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-sources/gtm/142981"
},
{
"rel": "gtm",
"href": "/lds-api/v3/log-sources/gtm"
},
{
"rel": "log-sources",
"href": "/lds-api/v3/log-sources"
},
{
"rel": "log-configurations",
"href": "/lds-api/v3/log-sources/gtm/142981/log-configurations",
"method": "POST",
"title": "Create log configuration for this log source."
}
],
"type": "gtm",
"id": "142981",
"propertyName": "origin-newcolumbus-qa.abgvoice.com.akadns.net"
}
]
Make a GET request to
/lds-api/to retrieve all available log sources to which you have access.v3/ log-sources/ Determine the
logSourceTypefrom the response.Make a GET request to
/lds-api/.v3/ log-sources/ {logSourceType} Use the
logSourceIdfor a givenlogSourceTypeto create a log delivery configuration.
List log configurations by type
Returns all log delivery configurations of a given logSourceType. You would need the logConfigurationId
to modify a log delivery configuration.
GET /lds-api/
Sample: /lds-api/
| Parameter | Type | Sample | Description |
|---|---|---|---|
| URL parameters | |||
logSourceType |
Enumeration | cpcode-products |
Type of log source for which you can create a log delivery configuration, either cpcode-products, gtm-properties, edns-zones, or answerx-objects. For example, if you have Akamai Traffic Management and want to configure log delivery for it, retrieve the ID of your Traffic Management property by calling /lds-api/v3/log-sources/gtm-properties. Use the logSourceId to create a log delivery configuration. |
Status 200
application/json
Response Body:
[
{
"id": "163842",
"status": "active",
"startDate": "2013-01-02",
"logSource": {
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-sources/cpcode-products/200957-1"
},
{
"rel": "cpcode-products",
"href": "/lds-api/v3/log-sources/cpcode-products"
},
{
"rel": "log-sources",
"href": "/lds-api/v3/log-sources"
}
],
"type": "cpcode-products",
"id": "200957-1",
"cpCode": "200957 - MOCK CP CODE DESCR ",
"products": [
"HTTP Content Delivery"
]
},
"aggregationDetails": {
"type": "byLogArrival",
"deliveryFrequency": {
"id": "1",
"value": "Every 24 hours",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies/1"
},
{
"rel": "deliveryFrequencies",
"href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies"
}
]
}
},
"contactDetails": {
"mailAddresses": [
"jjudge@akamai.com"
],
"contact": {
"id": "1-C30O",
"value": ". Help-Desk - phone: 617.250.3900",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/contacts/1-C30O"
},
{
"rel": "contacts",
"href": "/lds-api/v3/log-configuration-parameters/contacts"
}
]
}
},
"deliveryDetails": {
"type": "ftp",
"machine": "akainsight.upload.akamai.com",
"login": "insightlds",
"directory": "/23567/logs/200957",
"password": ""
},
"encodingDetails": {
"encoding": {
"id": "3",
"value": "GZIP",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/encodings/3"
},
{
"rel": "encodings",
"href": "/lds-api/v3/log-configuration-parameters/encodings"
}
]
}
},
"logFormatDetails": {
"logIdentifier": "200957",
"logFormat": {
"id": "2",
"value": "combined",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/log-formats/2"
},
{
"rel": "logFormats",
"href": "/lds-api/v3/log-configuration-parameters/log-formats"
}
]
}
},
"messageSize": {
"id": "1",
"value": "50 MB (approx. 300 MB uncompressed logs)",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/message-sizes/1"
},
{
"rel": "messageSizes",
"href": "/lds-api/v3/log-configuration-parameters/message-sizes"
}
]
},
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration/163842"
},
{
"rel": "get-log-configurations-for-log-source",
"href": "/lds-api/v3/log-sources/cpcode-products/200957-1/log-configurations",
"title": "Get Log Configurations for the same log source"
},
{
"rel": "get-log-configurations-for-log-source-type",
"href": "/lds-api/v3/log-sources/cpcode-products/log-configurations",
"title": "Get Log Configurations for the same log source type"
},
{
"rel": "update-log-configuration",
"href": "/lds-api/v3/log-configuration/163842",
"method": "PUT",
"title": "Update Log Configuration"
},
{
"rel": "delete-log-configuration",
"href": "/lds-api/v3/log-configuration/163842",
"method": "DELETE",
"title": "Delete Log Configuration"
},
{
"rel": "suspend-log-configuration",
"href": "/lds-api/v3/log-configuration/163842/suspend",
"method": "POST",
"title": "Suspend Log Configuration"
}
]
},
{
"id": "143296",
"status": "suspended",
"startDate": "2011-04-05",
"endDate": "2011-04-08",
"logSource": {
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-sources/cpcode-products/104523-1"
},
{
"rel": "cpcode-products",
"href": "/lds-api/v3/log-sources/cpcode-products"
},
{
"rel": "log-sources",
"href": "/lds-api/v3/log-sources"
}
],
"type": "cpcode-products",
"id": "104523-1",
"cpCode": "104523 - MOCK CP CODE DESCR ",
"products": [
"Web Application Accelerator"
]
},
"aggregationDetails": {
"type": "byLogArrival",
"deliveryFrequency": {
"id": "7",
"value": "Every 1 hour",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies/7"
},
{
"rel": "deliveryFrequencies",
"href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies"
}
]
}
},
"contactDetails": {
"mailAddresses": [
"jad@akamai.com"
],
"contact": {
"id": "VC-GAKY",
"value": "Dmitriy Danilevsky - phone: 650.627.5222",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/contacts/VC-GAKY"
},
{
"rel": "contacts",
"href": "/lds-api/v3/log-configuration-parameters/contacts"
}
]
}
},
"deliveryDetails": {
"type": "email",
"emailAddress": "jad@akamai.com"
},
"encodingDetails": {
"encoding": {
"id": "1",
"value": "GZIP & UUENCODED",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/encodings/1"
},
{
"rel": "encodings",
"href": "/lds-api/v3/log-configuration-parameters/encodings"
}
]
}
},
"logFormatDetails": {
"logIdentifier": "edgetoken",
"logFormat": {
"id": "13",
"value": "W3C + Edge Tokenization",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/log-formats/13"
},
{
"rel": "logFormats",
"href": "/lds-api/v3/log-configuration-parameters/log-formats"
}
]
}
},
"messageSize": {
"id": "1",
"value": "50 MB (approx. 300 MB uncompressed logs)",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/message-sizes/1"
},
{
"rel": "messageSizes",
"href": "/lds-api/v3/log-configuration-parameters/message-sizes"
}
]
},
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration/143296"
},
{
"rel": "get-log-configurations-for-log-source",
"href": "/lds-api/v3/log-sources/cpcode-products/104523-1/log-configurations",
"title": "Get Log Configurations for the same log source"
},
{
"rel": "get-log-configurations-for-log-source-type",
"href": "/lds-api/v3/log-sources/cpcode-products/log-configurations",
"title": "Get Log Configurations for the same log source type"
},
{
"rel": "update-log-configuration",
"href": "/lds-api/v3/log-configuration/143296",
"method": "PUT",
"title": "Update Log Configuration"
},
{
"rel": "delete-log-configuration",
"href": "/lds-api/v3/log-configuration/143296",
"method": "DELETE",
"title": "Delete Log Configuration"
},
{
"rel": "resume-log-configuration",
"href": "/lds-api/v3/log-configuration/143296/resume",
"method": "POST",
"title": "Resume Log Configuration"
}
]
}
]
Run the List Log Sources operation.
Store the
logSourceTypefrom the appropriate object in that listing.Make a GET request to
/lds-api/.v3/ log-sources/ {logSourceType}/ {logSourceId}/ log-configurations The response object includes a list of all log delivery configurations with the specified
logSourceTypeandlogSourceId.
List log formats by type
Returns all available log formats for the specified logSourceType type. You need the Id of
log format to create new log delivery configurations.
GET /lds-api/
Sample: /lds-api/
| Parameter | Type | Sample | Description |
|---|---|---|---|
| URL parameters | |||
logSourceType |
Enumeration | cpcode-products |
Type of log source for which you can create a log delivery configuration, either cpcode-products, gtm-properties, edns-zones, or answerx-objects. For example, if you have Akamai Traffic Management and want to configure log delivery for it, retrieve the ID of your Traffic Management property by calling /lds-api/v3/log-sources/gtm-properties. Use the logSourceId to create a log delivery configuration. |
Status 200
application/json
Response Body:
[
{
"id": "2",
"value": "combined",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/log-formats/2"
},
{
"rel": "logFormats",
"href": "/lds-api/v3/log-configuration-parameters/log-formats"
},
{
"rel": "logSources",
"href": "/lds-api/v3/log-sources/cpcode-products/1-17310"
}
]
},
{
"id": "3",
"value": "W3C",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/log-formats/3"
},
{
"rel": "logFormats",
"href": "/lds-api/v3/log-configuration-parameters/log-formats"
},
{
"rel": "logSources",
"href": "/lds-api/v3/log-sources/cpcode-products/1-17310"
}
]
}
]
Run the List Log Sources operation.
Store the
logSourceTypefrom the appropriate object in that listing.Make a GET request to
/lds-api/.v3/ log-sources/ {logSourceType}/ log-formats The response object lists the available log format options for the specified
logSourceType. Store theidof the desired log format to use when creating or modifying log delivery configurations.
List log encodings by type
Retrieves all allowable log encodings.
GET /lds-api/
Sample: /lds-api/
| Parameter | Type | Sample | Description |
|---|---|---|---|
| URL parameters | |||
logSourceType |
Enumeration | cpcode-products |
Type of log source for which you can create a log delivery configuration, either cpcode-products, gtm-properties, edns-zones, or answerx-objects. For example, if you have Akamai Traffic Management and want to configure log delivery for it, retrieve the ID of your Traffic Management property by calling /lds-api/v3/log-sources/gtm-properties. Use the logSourceId to create a log delivery configuration. |
| Optional query parameters | |||
deliveryType |
Enumeration | email |
Allowable encodings for log configuration are based on chosen type of delivery, either email or ftp. |
Status 200
application/json
Response Body:
[
{
"id": "3",
"value": "GZIP",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/encodings/3"
},
{
"rel": "encodings",
"href": "/lds-api/v3/log-configuration-parameters/encodings"
}
]
},
{
"id": "4",
"value": "GPG Encrypted",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/encodings/4"
},
{
"rel": "encodings",
"href": "/lds-api/v3/log-configuration-parameters/encodings"
}
]
}
]
You can optionally limit the allowable encodings returned by
deliveryType, eitheremailorftp.Make a GET request to
/lds-api/v{version}/log-sources/encodings/{?deliveryType}.The response lists the allowable encoding options for the specified
deliveryType. Store the encodingidto use when creating and modifying log delivery configurations.
Get a log source
Get a log source of a given logSourceType type and logSourceId.
GET /lds-api/
Sample: /lds-api/
| Parameter | Type | Sample | Description |
|---|---|---|---|
| URL parameters | |||
logSourceType |
Enumeration | cpcode-products |
Type of log source for which you can create a log delivery configuration, either cpcode-products, gtm-properties, edns-zones, or answerx-objects. For example, if you have Akamai Traffic Management and want to configure log delivery for it, retrieve the ID of your Traffic Management property by calling /lds-api/v3/log-sources/gtm-properties. Use the logSourceId to create a log delivery configuration. |
logSourceId |
Integer | 124 |
The ID of the log source - source identity for log delivery. The accompanying example shows how to check log deliveries and possible log configuration actions for an AnswerX object identified with 124. |
Status 200
application/json
Response Body:
[
{
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-sources/cpcode-products/23456-4"
},
{
"rel": "cpcode-products",
"href": "/lds-api/v3/log-sources/cpcode-products"
},
{
"rel": "log-sources",
"href": "/lds-api/v3/log-sources"
},
{
"rel": "log-configurations",
"href": "/lds-api/v3/log-sources/cpcode-products/23456-4/log-configurations",
"method": "POST",
"title": "Create log configuration for this log source."
}
],
"type": "cpcode-products",
"id": "23456-4",
"cpCode": "23456 - MOCK CP CODE DESCR ",
"products": [
"Quicktime Streaming"
]
},
{
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-sources/gtm/142981"
},
{
"rel": "gtm",
"href": "/lds-api/v3/log-sources/gtm"
},
{
"rel": "log-sources",
"href": "/lds-api/v3/log-sources"
},
{
"rel": "log-configurations",
"href": "/lds-api/v3/log-sources/gtm/142981/log-configurations",
"method": "POST",
"title": "Create log configuration for this log source."
}
],
"type": "gtm",
"id": "142981",
"propertyName": "origin-newcolumbus-qa.abgvoice.com.akadns.net"
}
]
Run the List Log Sources operation.
Store the
logSourceTypeandlogSourceIdfrom the appropriate object in that listing.Make a GET request to
/lds-api/.v3/ log-sources/ {logSourceType}/ {logSourceId}
List log configurations per ID
Get all log configurations of given logSourceType and logSourceId.
GET /lds-api/
Sample: /lds-api/
| Parameter | Type | Sample | Description |
|---|---|---|---|
| URL parameters | |||
logSourceType |
Enumeration | cpcode-products |
Type of log source for which you can create a log delivery configuration, either cpcode-products, gtm-properties, edns-zones, or answerx-objects. For example, if you have Akamai Traffic Management and want to configure log delivery for it, retrieve the ID of your Traffic Management property by calling /lds-api/v3/log-sources/gtm-properties. Use the logSourceId to create a log delivery configuration. |
logSourceId |
Integer | 124 |
The ID of the log source - source identity for log delivery. The accompanying example shows how to check log deliveries and possible log configuration actions for an AnswerX object identified with 124. |
Status 200
application/json
Response Body:
[
{
"id": "163842",
"status": "active",
"startDate": "2013-01-02",
"logSource": {
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-sources/cpcode-products/200957-1"
},
{
"rel": "cpcode-products",
"href": "/lds-api/v3/log-sources/cpcode-products"
},
{
"rel": "log-sources",
"href": "/lds-api/v3/log-sources"
}
],
"type": "cpcode-products",
"id": "200957-1",
"cpCode": "200957 - MOCK CP CODE DESCR ",
"products": [
"HTTP Content Delivery"
]
},
"aggregationDetails": {
"type": "byLogArrival",
"deliveryFrequency": {
"id": "1",
"value": "Every 24 hours",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies/1"
},
{
"rel": "deliveryFrequencies",
"href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies"
}
]
}
},
"contactDetails": {
"mailAddresses": [
"jjudge@akamai.com"
],
"contact": {
"id": "1-C30O",
"value": ". Help-Desk - phone: 617.250.3900",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/contacts/1-C30O"
},
{
"rel": "contacts",
"href": "/lds-api/v3/log-configuration-parameters/contacts"
}
]
}
},
"deliveryDetails": {
"type": "ftp",
"machine": "akainsight.upload.akamai.com",
"login": "insightlds",
"directory": "/23567/logs/200957",
"password": ""
},
"encodingDetails": {
"encoding": {
"id": "3",
"value": "GZIP",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/encodings/3"
},
{
"rel": "encodings",
"href": "/lds-api/v3/log-configuration-parameters/encodings"
}
]
}
},
"logFormatDetails": {
"logIdentifier": "200957",
"logFormat": {
"id": "2",
"value": "combined",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/log-formats/2"
},
{
"rel": "logFormats",
"href": "/lds-api/v3/log-configuration-parameters/log-formats"
}
]
}
},
"messageSize": {
"id": "1",
"value": "50 MB (approx. 300 MB uncompressed logs)",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/message-sizes/1"
},
{
"rel": "messageSizes",
"href": "/lds-api/v3/log-configuration-parameters/message-sizes"
}
]
},
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration/163842"
},
{
"rel": "get-log-configurations-for-log-source",
"href": "/lds-api/v3/log-sources/cpcode-products/200957-1/log-configurations",
"title": "Get Log Configurations for the same log source"
},
{
"rel": "get-log-configurations-for-log-source-type",
"href": "/lds-api/v3/log-sources/cpcode-products/log-configurations",
"title": "Get Log Configurations for the same log source type"
},
{
"rel": "update-log-configuration",
"href": "/lds-api/v3/log-configuration/163842",
"method": "PUT",
"title": "Update Log Configuration"
},
{
"rel": "delete-log-configuration",
"href": "/lds-api/v3/log-configuration/163842",
"method": "DELETE",
"title": "Delete Log Configuration"
},
{
"rel": "suspend-log-configuration",
"href": "/lds-api/v3/log-configuration/163842/suspend",
"method": "POST",
"title": "Suspend Log Configuration"
}
]
},
{
"id": "143296",
"status": "suspended",
"startDate": "2011-04-05",
"endDate": "2011-04-08",
"logSource": {
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-sources/cpcode-products/104523-1"
},
{
"rel": "cpcode-products",
"href": "/lds-api/v3/log-sources/cpcode-products"
},
{
"rel": "log-sources",
"href": "/lds-api/v3/log-sources"
}
],
"type": "cpcode-products",
"id": "104523-1",
"cpCode": "104523 - MOCK CP CODE DESCR ",
"products": [
"Web Application Accelerator"
]
},
"aggregationDetails": {
"type": "byLogArrival",
"deliveryFrequency": {
"id": "7",
"value": "Every 1 hour",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies/7"
},
{
"rel": "deliveryFrequencies",
"href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies"
}
]
}
},
"contactDetails": {
"mailAddresses": [
"jad@akamai.com"
],
"contact": {
"id": "VC-GAKY",
"value": "Dmitriy Danilevsky - phone: 650.627.5222",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/contacts/VC-GAKY"
},
{
"rel": "contacts",
"href": "/lds-api/v3/log-configuration-parameters/contacts"
}
]
}
},
"deliveryDetails": {
"type": "email",
"emailAddress": "jad@akamai.com"
},
"encodingDetails": {
"encoding": {
"id": "1",
"value": "GZIP & UUENCODED",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/encodings/1"
},
{
"rel": "encodings",
"href": "/lds-api/v3/log-configuration-parameters/encodings"
}
]
}
},
"logFormatDetails": {
"logIdentifier": "edgetoken",
"logFormat": {
"id": "13",
"value": "W3C + Edge Tokenization",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/log-formats/13"
},
{
"rel": "logFormats",
"href": "/lds-api/v3/log-configuration-parameters/log-formats"
}
]
}
},
"messageSize": {
"id": "1",
"value": "50 MB (approx. 300 MB uncompressed logs)",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/message-sizes/1"
},
{
"rel": "messageSizes",
"href": "/lds-api/v3/log-configuration-parameters/message-sizes"
}
]
},
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration/143296"
},
{
"rel": "get-log-configurations-for-log-source",
"href": "/lds-api/v3/log-sources/cpcode-products/104523-1/log-configurations",
"title": "Get Log Configurations for the same log source"
},
{
"rel": "get-log-configurations-for-log-source-type",
"href": "/lds-api/v3/log-sources/cpcode-products/log-configurations",
"title": "Get Log Configurations for the same log source type"
},
{
"rel": "update-log-configuration",
"href": "/lds-api/v3/log-configuration/143296",
"method": "PUT",
"title": "Update Log Configuration"
},
{
"rel": "delete-log-configuration",
"href": "/lds-api/v3/log-configuration/143296",
"method": "DELETE",
"title": "Delete Log Configuration"
},
{
"rel": "resume-log-configuration",
"href": "/lds-api/v3/log-configuration/143296/resume",
"method": "POST",
"title": "Resume Log Configuration"
}
]
}
]
Run the List Log Sources operation.
Store the
logSourceTypeandlogSourceIdfrom the appropriate object in that listing.Make a GET request to
/lds-api/.v3/ log-sources/ {logSourceType}/ {logSourceId}/ log-configurations The response object includes a list of all log delivery configurations with the specified
logSourceId.
Create a new log configuration
Creates new log configuration. The response’s Location header
reflects where you can access the new configuration.
POST /lds-api/
Sample: /lds-api/
Content-Type: application/json
Request Body:
{
"startDate": "2012-10-31",
"contactDetails": {
"contact": {
"id": "1-2LPWVP"
},
"mailAddresses": [
"asfasf@fa.pl"
]
},
"logFormatDetails": {
"logFormat": {
"id": "12"
},
"logIdentifier": "dfgd"
},
"messageSize": {
"id": "2"
},
"aggregationDetails": {
"type": "byLogArrival",
"deliveryFrequency": {
"id": "1"
}
},
"encodingDetails": {
"encoding": {
"id": "1"
}
},
"deliveryDetails": {
"type": "email",
"emailAddress": "asf@fa.pl"
}
}
| Parameter | Type | Sample | Description |
|---|---|---|---|
| URL parameters | |||
logSourceType |
Enumeration | cpcode-products |
Type of log source for which you can create a log delivery configuration, either cpcode-products, gtm-properties, edns-zones, or answerx-objects. For example, if you have Akamai Traffic Management and want to configure log delivery for it, retrieve the ID of your Traffic Management property by calling /lds-api/v3/log-sources/gtm-properties. Use the logSourceId to create a log delivery configuration. |
logSourceId |
Integer | 124 |
The ID of the log source - source identity for log delivery. The accompanying example shows how to check log deliveries and possible log configuration actions for an AnswerX object identified with 124. |
Status 201
Headers:
Location: /lds-api/v3/log-configurations/268234
Run the Get Log Configurations by Type operation.
Store the
logConfigurationIdfrom the appropriate object in that listing.Run the Get a Log Configuration operation if you need to review this configuration’s parameters before modifying them.
When creating the request object, you need to specify the full representation of the log delivery configuration. To omit any member is to remove it from the log configuration.
Make a POST request to
/lds-api/.v3/ log-sources/ {logSourceType}/ {logSourceId}/ log-configurations
List log formats per ID
Gets log formats of given logSourceType and logSourceId.
GET /lds-api/
Sample: /lds-api/
| Parameter | Type | Sample | Description |
|---|---|---|---|
| URL parameters | |||
logSourceType |
Enumeration | cpcode-products |
Type of log source for which you can create a log delivery configuration, either cpcode-products, gtm-properties, edns-zones, or answerx-objects. For example, if you have Akamai Traffic Management and want to configure log delivery for it, retrieve the ID of your Traffic Management property by calling /lds-api/v3/log-sources/gtm-properties. Use the logSourceId to create a log delivery configuration. |
logSourceId |
Integer | 124 |
The ID of the log source - source identity for log delivery. The accompanying example shows how to check log deliveries and possible log configuration actions for an AnswerX object identified with 124. |
Status 200
application/json
Response Body:
[
{
"id": "2",
"value": "combined",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/log-formats/2"
},
{
"rel": "logFormats",
"href": "/lds-api/v3/log-configuration-parameters/log-formats"
},
{
"rel": "logSources",
"href": "/lds-api/v3/log-sources/cpcode-products/1-17310"
}
]
},
{
"id": "3",
"value": "W3C",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/log-formats/3"
},
{
"rel": "logFormats",
"href": "/lds-api/v3/log-configuration-parameters/log-formats"
},
{
"rel": "logSources",
"href": "/lds-api/v3/log-sources/cpcode-products/1-17310"
}
]
}
]
Run the List Log Sources operation.
Store the
logSourceTypeandlogSourceIdfrom the appropriate object in that listing.Make a GET request to
/lds-api/.v3/ log-sources/ {logSourceType}/ {logSourceId}/ log-formats The response object lists the available log format options for the specified
logSourceId. Store the log formatidto use when creating or modifying log delivery configurations.
Data
This section provides details for each type of data object the LDS 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. |
| ○ | Member is optional, and may be omitted in some cases. |
LogConfiguration
Represents the main log delivery configuration object that creates and updates a log delivery configuration.
Download schema:
doc-log-config.json
Sample GET response:
{
"id": "163842",
"status": "active",
"startDate": "2013-01-02",
"logSource": {
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-sources/cpcode-products/200957-1"
},
{
"rel": "cpcode-products",
"href": "/lds-api/v3/log-sources/cpcode-products"
},
{
"rel": "log-sources",
"href": "/lds-api/v3/log-sources"
}
],
"type": "cpcode-products",
"id": "200957-1",
"cpCode": "200957 - MOCK CP CODE DESCR ",
"products": [
"HTTP Content Delivery"
]
},
"aggregationDetails": {
"type": "byLogArrival",
"deliveryFrequency": {
"id": "1",
"value": "Every 24 hours",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies/1"
},
{
"rel": "deliveryFrequencies",
"href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies"
}
]
}
},
"contactDetails": {
"mailAddresses": [
"jjudge@akamai.com"
],
"contact": {
"id": "1-C30O",
"value": ". Help-Desk - phone: 617.250.3900",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/contacts/1-C30O"
},
{
"rel": "contacts",
"href": "/lds-api/v3/log-configuration-parameters/contacts"
}
]
}
},
"deliveryDetails": {
"type": "ftp",
"machine": "akainsight.upload.akamai.com",
"login": "insightlds",
"directory": "/23567/logs/200957",
"password": ""
},
"encodingDetails": {
"encoding": {
"id": "3",
"value": "GZIP",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/encodings/3"
},
{
"rel": "encodings",
"href": "/lds-api/v3/log-configuration-parameters/encodings"
}
]
}
},
"logFormatDetails": {
"logIdentifier": "200957",
"logFormat": {
"id": "2",
"value": "combined",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/log-formats/2"
},
{
"rel": "logFormats",
"href": "/lds-api/v3/log-configuration-parameters/log-formats"
}
]
}
},
"messageSize": {
"id": "1",
"value": "50 MB (approx. 300 MB uncompressed logs)",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/message-sizes/1"
},
{
"rel": "messageSizes",
"href": "/lds-api/v3/log-configuration-parameters/message-sizes"
}
]
},
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration/163842"
},
{
"rel": "get-log-configurations-for-log-source",
"href": "/lds-api/v3/log-sources/cpcode-products/200957-1/log-configurations",
"title": "Get Log Configurations for the same log source"
},
{
"rel": "get-log-configurations-for-log-source-type",
"href": "/lds-api/v3/log-sources/cpcode-products/log-configurations",
"title": "Get Log Configurations for the same log source type"
},
{
"rel": "update-log-configuration",
"href": "/lds-api/v3/log-configuration/163842",
"method": "PUT",
"title": "Update Log Configuration"
},
{
"rel": "delete-log-configuration",
"href": "/lds-api/v3/log-configuration/163842",
"method": "DELETE",
"title": "Delete Log Configuration"
},
{
"rel": "suspend-log-configuration",
"href": "/lds-api/v3/log-configuration/163842/suspend",
"method": "POST",
"title": "Suspend Log Configuration"
}
]
}
LogConfiguration members
| Member | Type | Required | Description |
|---|---|---|---|
aggregationDetails |
Object | ✓ | Defines how to aggregate logs: by log arrival or by hit time. The value is either an AggregationByHitTime or AggregationByLogArrival object. |
contactDetails |
LogConfiguration. |
✓ | Contains details about contact person for this log delivery configuration. |
deliveryDetails |
Object | ✓ | Either an EmailDelivery or FtpDelivery object. |
encodingDetails |
LogConfiguration. |
✓ | Describes the log encoding. |
endDate |
String | ○ | End date to which logs will be collected. |
id |
String | ○ | Read-only. Unique identifier of this configuration. |
logFormatDetails |
LogConfiguration. |
✓ | Describes the log format. |
logSource |
Object | ○ | Read-only. This member appears in log configurations only in server responses. For creating and modifying log configuration, all required information to identify configuration is in the URL. The type is either an AnswerXLogSource, CpCodeLogSource, EdnsLogSource, or GtmLogSource. |
messageSize |
Object | ✓ | Packed log message’s approximate size, a simple KeyValuePair object. |
startDate |
String | ✓ | Start date from which logs will be collected. |
status |
Enumeration | ○ | Read-only. Log configuration status, either active, expired, or suspended. Only active configurations are used in the actual log delivery process. |
| LogConfiguration.contactDetails: Contains details about contact person for this log delivery configuration. | |||
contact |
Object | ✓ | Contact information provided as a simple KeyValuePair object. |
mailAddresses |
Array | ✓ | List of email addresses for contacts for this log format configuration. |
| LogConfiguration.encodingDetails: Describes the log encoding. | |||
encoding |
Object | ✓ | Selected encoding option used to encode logs, a simple KeyValuePair object. |
encodingKey |
String | ○ | Public key value for encrypted encoding. You need to set the public key value if GPG encrypted encoding is used. |
| LogConfiguration.logFormatDetails: Describes the log format. | |||
logFormat |
Object | ✓ | Selected format for log delivery, a simple KeyValuePair object. |
logIdentifier |
String | ✓ | Represents the first token of the log filename. |
LogConfigurationCopy
Encapsulates information needed to copy a log configuration.
Download schema:
doc-log-copy.json
Sample GET response:
{
"copyTarget": {
"logSource": {
"type": "gtm",
"id": "1243"
}
}
}
LogConfigurationCopy members
| Member | Type | Required | Description |
|---|---|---|---|
copyTarget |
LogConfigurationCopy. |
✓ | Represents target log source for configuration copy request. |
| LogConfigurationCopy.copyTarget: Represents target log source for configuration copy request. | |||
logSource |
Object | ✓ | Describes detailed log source information for configuration, one of these object types: AnswerXLogSource, CpCodeLogSource, EdnsLogSource, or GtmLogSource. |
Redelivery
Collects information needed to create a log redelivery request.
Download schema:
doc-redelivery.json
Sample GET response:
{
"logConfiguration": {
"id": "154519",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configurations/154519"
}
]
},
"id": "272480",
"beginTime": 3,
"endTime": 6,
"redeliveryDate": "2016-10-08",
"status": "new",
"createdDate": "2016-10-05",
"modifiedDate": "2016-10-07",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-redeliveries/272480"
},
{
"rel": "get-log-redeliveries",
"href": "/lds-api/v3/log-redeliveries",
"title": "Get Log Redeliveries"
},
{
"rel": "create-log-redelivery",
"href": "/lds-api/v3/log-redeliveries",
"method": "POST",
"title": "Create Log Redelivery"
}
]
}
Redelivery members
| Member | Type | Required | Description |
|---|---|---|---|
beginTime |
Integer | ✓ | First hour of time range (0–23) for which log redelivery is requested. |
createdDate |
String | ○ | Read-only. Date the request for redelivery was created. |
endTime |
Integer | ✓ | Last hour of time range (1–24) for which log redelivery is requested. |
id |
String | ○ | Read-only. Unique ID of this redelivery request. |
logConfiguration |
Redelivery. |
✓ | Log delivery configuration for which this redelivery request was created. |
modifiedDate |
String | ○ | Read-only. Date of the last time the redelivery request was modified. |
redeliveryDate |
String | ✓ | Date from which log redelivery is requested. |
status |
Enumeration | ○ | Read-only. Status of the redelivery, either new, scheduled, success, or failed. |
| Redelivery.logConfiguration: Log delivery configuration for which this redelivery request was created. | |||
id |
String | ✓ | Unique ID for the log delivery configuration. |
KeyValuePair
A simple data type used for pairs of IDs and values.
Download schema:
doc-pair.json
Sample GET response:
{
"id": "1",
"value": "Every 24 hours",
"links": [
{
"rel": "self",
"href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies/1"
},
{
"rel": "deliveryFrequencies",
"href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies"
}
]
}
KeyValuePair members
| Member | Type | Required | Description |
|---|---|---|---|
id |
String | ✓ | Unique identifier for the object. |
value |
String | ○ | Read-only. Human-readable value for the object. |
AggregationByHitTime
This aggregation option allows to receive most of the hits for each GMT calendar day in a single delivery.
Download schema:
doc-aggregation-by-hit-time.json
AggregationByHitTime members
| Member | Type | Required | Description |
|---|---|---|---|
deliverResidualData |
Boolean | ✓ | Indicates whether residual data should be sent at regular intervals after each day. |
deliveryThreshold |
Object | ✓ | Data completion threshold, or the percentage of expected logs to be processed before the log data is sent to you, provided as a simple KeyValuePair object. |
type |
Enumeration | ✓ | Identifies the type of aggregation, byHitTime in this case. |
AggregationByLogArrival
This aggregation option allows you to receive log data in the order in which it arrives from edge servers.
Download schema:
doc-aggregation-by-log-arrival.json
AggregationByLogArrival members
| Member | Type | Required | Description |
|---|---|---|---|
deliveryFrequency |
Object | ✓ | Period of time that will be covered by log delivery, provided as a simple KeyValuePair object. |
type |
Enumeration | ✓ | Identifies the type of aggregation, byLogArrival in this case. |
FtpDelivery
Encapsulates log delivery via FTP.
Download schema:
doc-ftp-delivery.json
FtpDelivery members
| Member | Type | Required | Description |
|---|---|---|---|
directory |
String | ✓ | Target directory to which logs will be sent by FTP. |
login |
String | ✓ | Login used to authenticate to FTP machine. |
machine |
String | ✓ | Machine to which log will be sent by FTP. |
password |
String | ✓ | Password used to authenticate to FTP machine. Keep in mind that this field will be empty in all responses from the server. |
type |
Enumeration | ✓ | Identifies this type of delivery, ftp in this case. |
EmailDelivery
Encapsulates log delivery sent by email.
Download schema:
doc-email-delivery.json
EmailDelivery members
| Member | Type | Required | Description |
|---|---|---|---|
emailAddress |
String | ✓ | Email address to which log will be sent. |
type |
Enumeration | ✓ | Identifies this type of delivery, email in this case. |
AnswerXLogSource
Identifies an AnswerX object for which you can create a log delivery configuration.
Download schema:
doc-log-source-answerx.json
AnswerXLogSource members
| Member | Type | Required | Description |
|---|---|---|---|
id |
Integer | ✓ | Unique identifier for each log source. |
logRetentionDays |
Integer | ○ | Read-only. Number of days that Akamai should keep logs collected for that log source. You can create log redelivery requests only for this retention period. |
name |
String | ○ | Read-only. The AnswerX object name. |
type |
Enumeration | ✓ | Identifies the type of this log source, in this case answerx. |
CpCodeLogSource
Identifies a group of CP code products, for which the log delivery configuration is being created.
Download schema:
doc-log-source-cpcode.json
CpCodeLogSource members
| Member | Type | Required | Description |
|---|---|---|---|
cpCode |
String | ○ | Read-only. CP code ID and name for which logs will be collected. |
id |
Integer | ✓ | Unique identifier for each log source. |
logRetentionDays |
Integer | ○ | Read-only. Number of days that Akamai should keep logs collected for that log source. You can create log redelivery requests only for this retention period. |
products |
Array | ○ | Read-only. Products for which logs will be collected. |
type |
Enumeration | ✓ | Identifies the type of this log source, in this case cpcode-products. |
EdnsLogSource
Identifies a DNS zone for which you can create a log delivery configuration.
Download schema:
doc-log-source-edns.json
EdnsLogSource members
| Member | Type | Required | Description |
|---|---|---|---|
id |
Integer | ✓ | Unique identifier for each log source. |
logRetentionDays |
Integer | ○ | Read-only. Number of days that Akamai should keep logs collected for that log source. You can create log redelivery requests only for this retention period. |
type |
Enumeration | ✓ | Identifies the type of this log source, in this case edns. |
zoneName |
String | ○ | Read-only. The full name of the EDNS zone. |
GtmLogSource
Identifies a Traffic Management property for which you can create a log delivery configuration.
Download schema:
doc-log-source-gtm.json
GtmLogSource members
| Member | Type | Required | Description |
|---|---|---|---|
id |
Integer | ✓ | Unique identifier for each log source. |
logRetentionDays |
Integer | ○ | Read-only. Number of days that Akamai should keep logs collected for that log source. You can create log redelivery requests only for this retention period. |
propertyName |
String | ○ | Read-only. The full name of the Traffic Management domain property. |
type |
Enumeration | ✓ | Identifies the type of this log source, in this case gtm. |
Errors
This section provides information 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.
Please note that with log delivery you may also encounter issues with the delivery mechanisms, email and FTP. You can learn more about possible email and FTP delivery errors in the LDS User Guide on Control Center.
Error responses
The following is an example of a response with an authorization error.
HTTP/1.1 401
Content-Type: application/json
Reply Body:
{
"details": [
{
"code": "requested.action.not.allowed",
"message": "You do not have permission for this action.",
"data": {
"action": "View Log Configuration"
}
}
],
"code": "error.authorization.fail",
"title": "Missing access rights to resource",
"incidentId": "0afe0260-8800-4921-bc4e-439219946d96"
}
All JSON responses for error cases follow the Problem Details specification.
HTTP status codes
The following lists the range of HTTP response codes the API may produce for both success and error cases:
| Code | Description |
|---|---|
| 200 | Request OK |
| 201 | Resource created. |
| 204 | No content. Displays when a DELETE operation is successful. |
| 400 | Bad request. Please provide all the required parameters. |
| 401 | Unauthorized request. You don’t have permission to perform this action. |
| 403 | Forbidden. User is not authenticated. |
| 404 | Resource not found. The object you were trying to reach could not be found. |
| 405 | Method not allowed. |
| 415 | Unsupported media type |
| 429 | Too many requests |
| 500 | Internal Server Error |
| 503 | Service Unavailable |
Last modified: 4/3/2017