Log Delivery Service API 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.

  1. Run the List Log Sources operation to retrieve all available log sources and associated ID numbers to which you have access.

  2. 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.

    1. Run the List Log Formats Per ID operation to retrieve all available log formats and associated log source IDs for this logSourceType and logSourceId.

    2. Run the List Log Encodings operation to retrieve the id for the desired encoding type.

    3. Run the List Delivery Frequencies operation to retrieve the id for desired delivery frequency.

    4. Run the List Message Sizes operation to retrieve the id for the desired log delivery message size.

    5. Run the List Contacts operation to retrieve id values for the desired contacts.

  3. Run the Create a New Log Configuration operation, with the request object built as defined by the Log Configuration Definitions Schema.

API Summary

Operation Method Endpoint
Log Configurations   (download RAML)
Get a Log Configuration GET /lds-api/v3/log-configurations/{logConfigurationId}
Update a Log Configuration PUT /lds-api/v3/log-configurations/{logConfigurationId}
Remove a Log Configuration DELETE /lds-api/v3/log-configurations/{logConfigurationId}
Copy a Log Configuration POST /lds-api/v3/log-configurations/{logConfigurationId}/copy
Suspend a Log Configuration POST /lds-api/v3/log-configurations/{logConfigurationId}/suspend
Resume a Log Configuration POST /lds-api/v3/log-configurations/{logConfigurationId}/resume
Log Configuration Parameters   (download RAML)
List Delivery Frequencies GET /lds-api/v3/log-configuration-parameters/delivery-frequencies
Get a Delivery Frequency GET /lds-api/v3/log-configuration-parameters/delivery-frequencies/{deliveryFrequencyId}
List Log Delivery Thresholds GET /lds-api/v3/log-configuration-parameters/delivery-thresholds
Get a Log Delivery Threshold GET /lds-api/v3/log-configuration-parameters/delivery-thresholds/{deliveryThresholdId}
Get a Log Format GET /lds-api/v3/log-configuration-parameters/log-formats/{logFormatId}
List Log Encodings GET /lds-api/v3/log-configuration-parameters/encodings{?deliveryType,logSourceType}
Get a Log Encoding GET /lds-api/v3/log-configuration-parameters/encodings/{encodingId}
List Message Sizes GET /lds-api/v3/log-configuration-parameters/message-sizes
Get a Message Size GET /lds-api/v3/log-configuration-parameters/message-sizes/{messageSizeId}
List Contacts GET /lds-api/v3/log-configuration-parameters/contacts
Get a Contact GET /lds-api/v3/log-configuration-parameters/contacts/{contactId}
Log Redeliveries   (download RAML)
List Log Redeliveries GET /lds-api/v3/log-redeliveries
Create a New Log Redelivery POST /lds-api/v3/log-redeliveries
Get a Log Redelivery GET /lds-api/v3/log-redeliveries/{redeliveryId}
Log Sources   (download RAML)
List Log Sources GET /lds-api/v3/log-sources
List Log Sources by Type GET /lds-api/v3/log-sources/{logSourceType}
List Log Configurations by Type GET /lds-api/v3/log-sources/{logSourceType}/log-configurations
List Log Formats by Type GET /lds-api/v3/log-sources/{logSourceType}/log-formats
List Log Encodings by Type GET /lds-api/v3/log-sources/{logSourceType}/encodings{?deliveryType}
Get a Log Source GET /lds-api/v3/log-sources/{logSourceType}/{logSourceId}
List Log Configurations Per ID GET /lds-api/v3/log-sources/{logSourceType}/{logSourceId}/log-configurations
Create a New Log Configuration POST /lds-api/v3/log-sources/{logSourceType}/{logSourceId}/log-configurations
List Log Formats Per ID GET /lds-api/v3/log-sources/{logSourceType}/{logSourceId}/log-formats

Get a Log Configuration

Retrieves a specific log delivery configuration.

GET /lds-api/v3/log-configurations/{logConfigurationId}

Sample: /lds-api/v3/log-configurations/163842

Parameter Type Sample Description
URL Parameters
logConfigurationId Number 163842 Unique identifier for each log delivery configuration.

Status 200 application/json

Response Body:

{
    "status": "active",
    "startDate": "2013-01-02",
    "aggregationDetails": {
        "deliveryFrequency": {
            "value": "Every 24 hours",
            "id": "1",
            "links": [
                {
                    "href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies/1",
                    "rel": "self"
                },
                {
                    "href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies",
                    "rel": "deliveryFrequencies"
                }
            ]
        },
        "type": "byLogArrival"
    },
    "logFormatDetails": {
        "logFormat": {
            "value": "combined",
            "id": "2",
            "links": [
                {
                    "href": "/lds-api/v3/log-configuration-parameters/log-formats/2",
                    "rel": "self"
                },
                {
                    "href": "/lds-api/v3/log-configuration-parameters/log-formats",
                    "rel": "logFormats"
                }
            ]
        },
        "logIdentifier": "200957"
    },
    "links": [
        {
            "href": "/lds-api/v3/log-configuration/163842",
            "rel": "self"
        },
        {
            "href": "/lds-api/v3/log-sources/cpcode-products/200957-1/log-configurations",
            "rel": "get-log-configurations-for-log-source",
            "title": "Get Log Configurations for the same log source"
        },
        {
            "href": "/lds-api/v3/log-sources/cpcode-products/log-configurations",
            "rel": "get-log-configurations-for-log-source-type",
            "title": "Get Log Configurations for the same log source type"
        },
        {
            "href": "/lds-api/v3/log-configuration/163842",
            "method": "PUT",
            "rel": "update-log-configuration",
            "title": "Update Log Configuration"
        },
        {
            "href": "/lds-api/v3/log-configuration/163842",
            "method": "DELETE",
            "rel": "delete-log-configuration",
            "title": "Delete Log Configuration"
        },
        {
            "href": "/lds-api/v3/log-configuration/163842/suspend",
            "method": "POST",
            "rel": "suspend-log-configuration",
            "title": "Suspend Log Configuration"
        }
    ],
    "logSource": {
        "cpCode": "200957 - MOCK CP CODE DESCR ",
        "type": "cpcode-products",
        "products": [
            "HTTP Content Delivery"
        ],
        "id": "200957-1",
        "links": [
            {
                "href": "/lds-api/v3/log-sources/cpcode-products/200957-1",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-sources/cpcode-products",
                "rel": "cpcode-products"
            },
            {
                "href": "/lds-api/v3/log-sources",
                "rel": "log-sources"
            }
        ]
    },
    "contactDetails": {
        "contact": {
            "value": ". Help-Desk - phone: 617.250.3900",
            "id": "1-C30O",
            "links": [
                {
                    "href": "/lds-api/v3/log-configuration-parameters/contacts/1-C30O",
                    "rel": "self"
                },
                {
                    "href": "/lds-api/v3/log-configuration-parameters/contacts",
                    "rel": "contacts"
                }
            ]
        },
        "mailAddresses": [
            "jjudge@akamai.com"
        ]
    },
    "messageSize": {
        "value": "50 MB (approx. 300 MB uncompressed logs)",
        "id": "1",
        "links": [
            {
                "href": "/lds-api/v3/log-configuration-parameters/message-sizes/1",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-configuration-parameters/message-sizes",
                "rel": "messageSizes"
            }
        ]
    },
    "deliveryDetails": {
        "machine": "akainsight.upload.akamai.com",
        "directory": "/23567/logs/200957",
        "login": "insightlds",
        "password": "",
        "type": "ftp"
    },
    "encodingDetails": {
        "encoding": {
            "value": "GZIP",
            "id": "3",
            "links": [
                {
                    "href": "/lds-api/v3/log-configuration-parameters/encodings/3",
                    "rel": "self"
                },
                {
                    "href": "/lds-api/v3/log-configuration-parameters/encodings",
                    "rel": "encodings"
                }
            ]
        }
    },
    "id": "163842"
}
  1. Run the List Log Sources operation.

  2. Store the logSourceType and logSourceId from the appropriate object in that listing.

  3. Run the List Log Configurations by Type operation to retrieve a list of log configurations for that log source type.

  4. Store the appropriate logConfigurationId from that listing.

  5. Make a GET request to /lds-api/v3/log-configurations/{logConfigurationId}.

  6. 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/v3/log-configurations/{logConfigurationId}

Sample: /lds-api/v3/log-configurations/163842

Content-Type: application/json

Request Body:

{
    "encodingDetails": {
        "encoding": {
            "id": "1"
        }
    },
    "startDate": "2012-10-31",
    "aggregationDetails": {
        "deliveryFrequency": {
            "id": "1"
        },
        "type": "byLogArrival"
    },
    "logFormatDetails": {
        "logFormat": {
            "id": "12"
        },
        "logIdentifier": "dfgd"
    },
    "contactDetails": {
        "contact": {
            "id": "1-2LPWVP"
        },
        "mailAddresses": [
            "asfasf@fa.pl"
        ]
    },
    "messageSize": {
        "id": "2"
    },
    "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
  1. Run the Get Log Configurations by Type operation.

  2. Store the logConfigurationId from the appropriate object in that listing.

  3. When creating the request object, include all required members for the LogConfiguration object.

  4. Make a PUT request to /lds-api/v3/log-configurations/{logConfigurationId}.

Remove a Log Configuration

Deletes a specific log delivery configuration.

DELETE /lds-api/v3/log-configurations/{logConfigurationId}

Sample: /lds-api/v3/log-configurations/163842

Parameter Type Sample Description
URL Parameters
logConfigurationId Number 163842 Unique identifier for each log delivery configuration.

Status 204

  1. Run the List Log Sources operation.

  2. Store the logSourceType for the appropriate object from that listing.

  3. Make a GET request to /lds-api/v3/log-sources/{logSourceType}/log-configurations to get a list of configurations for that logSourceType and their associated configuration IDs. You need the logConfigurationId to make the DELETE request.

  4. Store the logConfigurationId for the appropriate object in that listing.

  5. 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/v3/log-configurations/{logConfigurationId}/copy

Sample: /lds-api/v3/log-configurations/163842/copy

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
  1. Run the List Log Sources operation.

  2. Store the logSourceType and logSourceId from the appropriate object in that listing. You need to identify the target source in the request object.

  3. Run the Get Log Configurations by Type operation.

  4. Store the logConfigurationId from the appropriate object in that listing.

  5. 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/v3/log-configurations/{logConfigurationId}/suspend

Sample: /lds-api/v3/log-configurations/163842/suspend

Parameter Type Sample Description
URL Parameters
logConfigurationId Number 163842 Unique identifier for each log delivery configuration.

Status 204

  1. Run the Get Log Configurations by Type operation.

  2. Store the logConfigurationId from the appropriate object in that listing.

  3. 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/v3/log-configurations/{logConfigurationId}/resume

Sample: /lds-api/v3/log-configurations/163842/resume

Parameter Type Sample Description
URL Parameters
logConfigurationId Number 163842 Unique identifier for each log delivery configuration.

Status 204

  1. Run the Get Log Configurations by Type operation.

  2. Store the logConfigurationId from the appropriate object in that listing.

  3. 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/v3/log-configuration-parameters/delivery-frequencies

Status 200 application/json

Response Body:

[
    {
        "value": "Every 24 hours",
        "id": "1",
        "links": [
            {
                "href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies/1",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies",
                "rel": "deliveryFrequencies"
            }
        ]
    },
    {
        "value": "Every 12 hours",
        "id": "2",
        "links": [
            {
                "href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies/2",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies",
                "rel": "deliveryFrequencies"
            }
        ]
    }
]
  1. Make a GET request to /lds-api/v3/log-configuration-parameters/delivery-frequencies to retrieve a list of delivery frequency options value and id.

  2. Store the id to use when creating or updating a log delivery configuration.

Get a Delivery Frequency

Returns a specific delivery frequency.

GET /lds-api/v3/log-configuration-parameters/delivery-frequencies/{deliveryFrequencyId}

Sample: /lds-api/v3/log-configuration-parameters/delivery-frequencies/1

Parameter Type Sample Description
URL Parameters
deliveryFrequencyId Integer 1 Unique identifier for a delivery frequency.

Status 200 application/json

Response Body:

{
    "value": "Every 24 hours",
    "id": "1",
    "links": [
        {
            "href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies/1",
            "rel": "self"
        },
        {
            "href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies",
            "rel": "deliveryFrequencies"
        }
    ]
}
  1. Run the List Delivery Frequencies operation.

  2. Store the id from the appropriate delivery frequency in that listing.

  3. 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/v3/log-configuration-parameters/delivery-thresholds

Status 200 application/json

Response Body:

[
    {
        "value": "99",
        "id": "1",
        "links": [
            {
                "href": "/lds-api/v3/log-configuration-parameters/delivery-thresholds/1",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-configuration-parameters/delivery-thresholds",
                "rel": "deliveryThresholds"
            }
        ]
    },
    {
        "value": "99.5",
        "id": "2",
        "links": [
            {
                "href": "/lds-api/v3/log-configuration-parameters/delivery-thresholds/2",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-configuration-parameters/delivery-thresholds",
                "rel": "deliveryThresholds"
            }
        ]
    }
]
  1. Make a GET request to /lds-api/v3/log-configuration-parameters/delivery-thresholds retrieve a list of delivery threshold options value and id.

  2. Store the delivery threshold id to use when creating or updating a log delivery configuration.

Get a Log Delivery Threshold

Returns a specific log delivery threshold.

GET /lds-api/v3/log-configuration-parameters/delivery-thresholds/{deliveryThresholdId}

Sample: /lds-api/v3/log-configuration-parameters/delivery-thresholds/1

Parameter Type Sample Description
URL Parameters
deliveryThresholdId Integer 1 Unique identifier for a delivery threshold.

Status 200 application/json

Response Body:

{
    "value": "99",
    "id": "1",
    "links": [
        {
            "href": "/lds-api/v3/log-configuration-parameters/delivery-thresholds/1",
            "rel": "self"
        },
        {
            "href": "/lds-api/v3/log-configuration-parameters/delivery-thresholds",
            "rel": "deliveryThresholds"
        }
    ]
}
  1. Run the List Log Delivery Thresholds operation.

  2. Store the id from the appropriate delivery threshold in that listing.

  3. 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/v3/log-configuration-parameters/log-formats/{logFormatId}

Sample: /lds-api/v3/log-configuration-parameters/log-formats/1

Parameter Type Sample Description
URL Parameters
logFormatId Integer 1 Unique identifier for a log format.

Status 200 application/json

Response Body:

{
    "value": "combined",
    "id": "2",
    "links": [
        {
            "href": "/lds-api/v3/log-configuration-parameters/log-formats/2",
            "rel": "self"
        },
        {
            "href": "/lds-api/v3/log-configuration-parameters/log-formats",
            "rel": "logFormats"
        },
        {
            "href": "/lds-api/v3/log-sources/cpcode-products/1-17310",
            "rel": "logSources"
        }
    ]
}
  1. Run the List Log Sources operation.

  2. Store the logSourceType from the appropriate object in that listing.

  3. Make a GET request to /lds-api/v3/log-sources/{logSourceType}/log-formats.

  4. Store the logFormatId from the appropriate object in that listing.

  5. 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/v3/log-configuration-parameters/encodings{?deliveryType,logSourceType}

Sample: /lds-api/v3/log-configuration-parameters/encodings?deliveryType=email&logSourceType=cpcode-products

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:

[
    {
        "value": "GZIP",
        "id": "3",
        "links": [
            {
                "href": "/lds-api/v3/log-configuration-parameters/encodings/3",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-configuration-parameters/encodings",
                "rel": "encodings"
            }
        ]
    },
    {
        "value": "GPG Encrypted",
        "id": "4",
        "links": [
            {
                "href": "/lds-api/v3/log-configuration-parameters/encodings/4",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-configuration-parameters/encodings",
                "rel": "encodings"
            }
        ]
    }
]
  1. You can optionally limit the allowable encodings returned by deliveryType, either email or ftp.

  2. You can optionally limit the allowable encodings returned by logSourceType. Run the List Log Sources by Type operation and store the appropriate logSourceType from that listing.

  3. Make a GET request to /lds-api/v3/log-configuration-parameters/encodings{?deliveryType,logSourceType}.

  4. The response lists the allowable encoding options for the specified deliveryType and logSourceType. Store the encoding id to use when creating and modifying log delivery configurations.

Get a Log Encoding

Returns a specific log encoding.

GET /lds-api/v3/log-configuration-parameters/encodings/{encodingId}

Sample: /lds-api/v3/log-configuration-parameters/encodings/1

Parameter Type Sample Description
URL Parameters
encodingId Integer 1 Unique identifier for an encoding type.

Status 200 application/json

Response Body:

{
    "value": "GZIP",
    "id": "3",
    "links": [
        {
            "href": "/lds-api/v3/log-configuration-parameters/encodings/3",
            "rel": "self"
        },
        {
            "href": "/lds-api/v3/log-configuration-parameters/encodings",
            "rel": "encodings"
        }
    ]
}
  1. Run the List Log Encodings operation.

  2. Store the id from the appropriate encoding in that listing.

  3. 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/v3/log-configuration-parameters/message-sizes

Status 200 application/json

Response Body:

[
    {
        "value": "50 MB (approx. 300 MB uncompressed logs)",
        "id": "1",
        "links": [
            {
                "href": "/lds-api/v3/log-configuration-parameters/message-sizes/1",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-configuration-parameters/message-sizes",
                "rel": "messageSizes"
            }
        ]
    },
    {
        "value": "25 MB (approx. 150 MB uncompressed logs)",
        "id": "2",
        "links": [
            {
                "href": "/lds-api/v3/log-configuration-parameters/message-sizes/2",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-configuration-parameters/message-sizes",
                "rel": "messageSizes"
            }
        ]
    }
]
  1. Make a GET request to /lds-api/v3/log-configuration-parameters/message-sizes.

  2. The response lists the available message sizes with a value and id. Store the message size id to use when creating and modifying log delivery configurations.

Get a Message Size

Retrieves a specific message size.

GET /lds-api/v3/log-configuration-parameters/message-sizes/{messageSizeId}

Sample: /lds-api/v3/log-configuration-parameters/message-sizes/1

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:

{
    "value": "50 MB (approx. 300 MB uncompressed logs)",
    "id": "1",
    "links": [
        {
            "href": "/lds-api/v3/log-configuration-parameters/message-sizes/1",
            "rel": "self"
        },
        {
            "href": "/lds-api/v3/log-configuration-parameters/message-sizes",
            "rel": "messageSizes"
        }
    ]
}
  1. Run the List Message Sizes operation.

  2. Store the appropriate message size id from that listing.

  3. 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/v3/log-configuration-parameters/contacts

Status 200 application/json

Response Body:

{
    "value": "Bartosz Gula - phone: +48123847337",
    "id": "B-C-1JM7ZL1",
    "links": [
        {
            "href": "/lds-api/v3/log-configuration-parameters/contacts/B-C-1JM7ZL1",
            "rel": "self"
        },
        {
            "href": "/lds-api/v3/log-configuration-parameters/contacts",
            "rel": "contacts"
        }
    ]
}
  1. Make a GET request to /lds-api/v3/log-configuration-parameters/contacts.

  2. Store the contactId from 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/v3/log-configuration-parameters/contacts/{contactId}

Sample: /lds-api/v3/log-configuration-parameters/contacts/1–2LPWVP

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:

[
    {
        "value": "Bartosz Gula - phone: +48123847337",
        "id": "B-C-1JM7ZL1",
        "links": [
            {
                "href": "/lds-api/v3/log-configuration-parameters/contacts/B-C-1JM7ZL1",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-configuration-parameters/contacts",
                "rel": "contacts"
            }
        ]
    },
    {
        "value": "Customer Care - phone: 6172504699",
        "id": "1-7SF29",
        "links": [
            {
                "href": "/lds-api/v3/log-configuration-parameters/contacts/1-7SF29",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-configuration-parameters/contacts",
                "rel": "contacts"
            }
        ]
    }
]
  1. Run the List Contacts operation.

  2. Store the contactId from the appropriate object in that listing.

  3. 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/v3/log-redeliveries

Status 200 application/json

Response Body:

[
    {
        "status": "new",
        "redeliveryDate": "2016-10-06",
        "links": [
            {
                "href": "/lds-api/v3/log-redeliveries/272480",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-redeliveries",
                "rel": "get-log-redeliveries",
                "title": "Get Log Redeliveries"
            },
            {
                "href": "/lds-api/v3/log-redeliveries",
                "method": "POST",
                "rel": "create-log-redelivery",
                "title": "Create Log Redelivery"
            }
        ],
        "logConfiguration": {
            "id": "154519",
            "links": [
                {
                    "href": "/lds-api/v3/log-configurations/154519",
                    "rel": "self"
                }
            ]
        },
        "beginTime": 3,
        "createdDate": "2016-10-07",
        "endTime": 6,
        "id": "272480",
        "modifiedDate": "2016-10-07"
    },
    {
        "status": "new",
        "redeliveryDate": "2016-10-07",
        "links": [
            {
                "href": "/lds-api/v3/log-redeliveries/272479",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-redeliveries",
                "rel": "get-log-redeliveries",
                "title": "Get Log Redeliveries"
            },
            {
                "href": "/lds-api/v3/log-redeliveries",
                "method": "POST",
                "rel": "create-log-redelivery",
                "title": "Create Log Redelivery"
            }
        ],
        "logConfiguration": {
            "id": "154519",
            "links": [
                {
                    "href": "/lds-api/v3/log-configurations/154519",
                    "rel": "self"
                }
            ]
        },
        "beginTime": 2,
        "createdDate": "2016-10-07",
        "endTime": 5,
        "id": "272479",
        "modifiedDate": "2016-10-07"
    },
    {
        "status": "new",
        "redeliveryDate": "2016-10-05",
        "links": [
            {
                "href": "/lds-api/v3/log-redeliveries/272477",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-redeliveries",
                "rel": "get-log-redeliveries",
                "title": "Get Log Redeliveries"
            },
            {
                "href": "/lds-api/v3/log-redeliveries",
                "method": "POST",
                "rel": "create-log-redelivery",
                "title": "Create Log Redelivery"
            }
        ],
        "logConfiguration": {
            "id": "154519",
            "links": [
                {
                    "href": "/lds-api/v3/log-configurations/154519",
                    "rel": "self"
                }
            ]
        },
        "beginTime": 2,
        "createdDate": "2016-10-07",
        "endTime": 5,
        "id": "272477",
        "modifiedDate": "2016-10-07"
    },
    {
        "status": "new",
        "redeliveryDate": "2016-10-06",
        "links": [
            {
                "href": "/lds-api/v3/log-redeliveries/272478",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-redeliveries",
                "rel": "get-log-redeliveries",
                "title": "Get Log Redeliveries"
            },
            {
                "href": "/lds-api/v3/log-redeliveries",
                "method": "POST",
                "rel": "create-log-redelivery",
                "title": "Create Log Redelivery"
            }
        ],
        "logConfiguration": {
            "id": "154519",
            "links": [
                {
                    "href": "/lds-api/v3/log-configurations/154519",
                    "rel": "self"
                }
            ]
        },
        "beginTime": 2,
        "createdDate": "2016-10-07",
        "endTime": 5,
        "id": "272478",
        "modifiedDate": "2016-10-07"
    }
]
  1. Make a GET request to /lds-api/v3/log-redeliveries/.

  2. 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/v3/log-redeliveries

Content-Type: application/json

Request Body:

{
    "logConfiguration": {
        "id": "154519"
    },
    "redeliveryDate": "2016-10-06",
    "endTime": 6,
    "id": "272480",
    "beginTime": 3
}

Status 201

Headers:

Location: /lds-api/v3/log-redelivery-request/268231
  1. Run the Get Log Configurations by Type operation.

  2. Store the logConfigurationId from the appropriate object in that listing. This is the log delivery configuration for which you want to request that the logs be redelivered.

  3. When creating the request object, you need to specify the logConfiguration, beginTime,endTime, and redeliveryDate members. See the Redelivery object type for details.

  4. Make a POST request to /lds-api/v3/log-redeliveries/.

Get a Log Redelivery

Retrieves a specific log redelivery request.

GET /lds-api/v3/log-redeliveries/{redeliveryId}

Sample: /lds-api/v3/log-redeliveries/13526

Parameter Type Sample Description
URL Parameters
redeliveryId Integer 13526 Unique identifier for the request to resend a log.

Status 200 application/json

Response Body:

{
    "status": "new",
    "redeliveryDate": "2016-10-08",
    "links": [
        {
            "href": "/lds-api/v3/log-redeliveries/272480",
            "rel": "self"
        },
        {
            "href": "/lds-api/v3/log-redeliveries",
            "rel": "get-log-redeliveries",
            "title": "Get Log Redeliveries"
        },
        {
            "href": "/lds-api/v3/log-redeliveries",
            "method": "POST",
            "rel": "create-log-redelivery",
            "title": "Create Log Redelivery"
        }
    ],
    "logConfiguration": {
        "id": "154519",
        "links": [
            {
                "href": "/lds-api/v3/log-configurations/154519",
                "rel": "self"
            }
        ]
    },
    "beginTime": 3,
    "createdDate": "2016-10-05",
    "endTime": 6,
    "id": "272480",
    "modifiedDate": "2016-10-07"
}
  1. Run the List Log Redeliveries operation.

  2. Store the redeliveryId from the appropriate object in that listing.

  3. 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/v3/log-sources

Status 200 application/json

Response Body:

[
    {
        "cpCode": "23456 - MOCK CP CODE DESCR ",
        "type": "cpcode-products",
        "products": [
            "Quicktime Streaming"
        ],
        "id": "23456-4",
        "links": [
            {
                "href": "/lds-api/v3/log-sources/cpcode-products/23456-4",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-sources/cpcode-products",
                "rel": "cpcode-products"
            },
            {
                "href": "/lds-api/v3/log-sources",
                "rel": "log-sources"
            },
            {
                "href": "/lds-api/v3/log-sources/cpcode-products/23456-4/log-configurations",
                "method": "POST",
                "rel": "log-configurations",
                "title": "Create log configuration for this log source."
            }
        ]
    },
    {
        "propertyName": "origin-newcolumbus-qa.abgvoice.com.akadns.net",
        "type": "gtm",
        "id": "142981",
        "links": [
            {
                "href": "/lds-api/v3/log-sources/gtm/142981",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-sources/gtm",
                "rel": "gtm"
            },
            {
                "href": "/lds-api/v3/log-sources",
                "rel": "log-sources"
            },
            {
                "href": "/lds-api/v3/log-sources/gtm/142981/log-configurations",
                "method": "POST",
                "rel": "log-configurations",
                "title": "Create log configuration for this log source."
            }
        ]
    }
]
  1. Make a GET request to /lds-api/v3/log-sources/ to retrieve all available log sources to which you have access.

  2. Store the logSourceType and logSourceId to use when creating or modifying a log delivery configuration.

List Log Sources by Type

Returns all log sources of the specified logSourceType, one of cpcode-products, gtm-properties, edns-zones, or answerx-objects.

GET /lds-api/v3/log-sources/{logSourceType}

Sample: /lds-api/v3/log-sources/cpcode-products

Parameter Type Sample Description
URL Parameters
logSourceType Enumeration cpcode-products Type of log source for which you can create a log delivery configuration. 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 invoking /lds-api/v3/log-sources/gtm-properties. Use the logSourceId to create a log delivery configuration. Possible enum values: answerx-objects, cpcode-products, edns-zones, gtm-properties.

Status 200 application/json

Response Body:

[
    {
        "cpCode": "23456 - MOCK CP CODE DESCR ",
        "type": "cpcode-products",
        "products": [
            "Quicktime Streaming"
        ],
        "id": "23456-4",
        "links": [
            {
                "href": "/lds-api/v3/log-sources/cpcode-products/23456-4",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-sources/cpcode-products",
                "rel": "cpcode-products"
            },
            {
                "href": "/lds-api/v3/log-sources",
                "rel": "log-sources"
            },
            {
                "href": "/lds-api/v3/log-sources/cpcode-products/23456-4/log-configurations",
                "method": "POST",
                "rel": "log-configurations",
                "title": "Create log configuration for this log source."
            }
        ]
    },
    {
        "propertyName": "origin-newcolumbus-qa.abgvoice.com.akadns.net",
        "type": "gtm",
        "id": "142981",
        "links": [
            {
                "href": "/lds-api/v3/log-sources/gtm/142981",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-sources/gtm",
                "rel": "gtm"
            },
            {
                "href": "/lds-api/v3/log-sources",
                "rel": "log-sources"
            },
            {
                "href": "/lds-api/v3/log-sources/gtm/142981/log-configurations",
                "method": "POST",
                "rel": "log-configurations",
                "title": "Create log configuration for this log source."
            }
        ]
    }
]
  1. Make a GET request to /lds-api/v3/log-sources/ to retrieve all available log sources to which you have access.

  2. Determine the logSourceType from the response.

  3. Make a GET request to /lds-api/v3/log-sources/{logSourceType}.

  4. Use the logSourceId for a given logSourceType to 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/v3/log-sources/{logSourceType}/log-configurations

Sample: /lds-api/v3/log-sources/cpcode-products/log-configurations

Parameter Type Sample Description
URL Parameters
logSourceType Enumeration cpcode-products Type of log source for which you can create a log delivery configuration. 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 invoking /lds-api/v3/log-sources/gtm-properties. Use the logSourceId to create a log delivery configuration. Possible enum values: answerx-objects, cpcode-products, edns-zones, gtm-properties.

Status 200 application/json

Response Body:

[
    {
        "status": "active",
        "startDate": "2013-01-02",
        "aggregationDetails": {
            "deliveryFrequency": {
                "value": "Every 24 hours",
                "id": "1",
                "links": [
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies/1",
                        "rel": "self"
                    },
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies",
                        "rel": "deliveryFrequencies"
                    }
                ]
            },
            "type": "byLogArrival"
        },
        "logFormatDetails": {
            "logFormat": {
                "value": "combined",
                "id": "2",
                "links": [
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/log-formats/2",
                        "rel": "self"
                    },
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/log-formats",
                        "rel": "logFormats"
                    }
                ]
            },
            "logIdentifier": "200957"
        },
        "links": [
            {
                "href": "/lds-api/v3/log-configuration/163842",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-sources/cpcode-products/200957-1/log-configurations",
                "rel": "get-log-configurations-for-log-source",
                "title": "Get Log Configurations for the same log source"
            },
            {
                "href": "/lds-api/v3/log-sources/cpcode-products/log-configurations",
                "rel": "get-log-configurations-for-log-source-type",
                "title": "Get Log Configurations for the same log source type"
            },
            {
                "href": "/lds-api/v3/log-configuration/163842",
                "method": "PUT",
                "rel": "update-log-configuration",
                "title": "Update Log Configuration"
            },
            {
                "href": "/lds-api/v3/log-configuration/163842",
                "method": "DELETE",
                "rel": "delete-log-configuration",
                "title": "Delete Log Configuration"
            },
            {
                "href": "/lds-api/v3/log-configuration/163842/suspend",
                "method": "POST",
                "rel": "suspend-log-configuration",
                "title": "Suspend Log Configuration"
            }
        ],
        "logSource": {
            "cpCode": "200957 - MOCK CP CODE DESCR ",
            "type": "cpcode-products",
            "products": [
                "HTTP Content Delivery"
            ],
            "id": "200957-1",
            "links": [
                {
                    "href": "/lds-api/v3/log-sources/cpcode-products/200957-1",
                    "rel": "self"
                },
                {
                    "href": "/lds-api/v3/log-sources/cpcode-products",
                    "rel": "cpcode-products"
                },
                {
                    "href": "/lds-api/v3/log-sources",
                    "rel": "log-sources"
                }
            ]
        },
        "contactDetails": {
            "contact": {
                "value": ". Help-Desk - phone: 617.250.3900",
                "id": "1-C30O",
                "links": [
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/contacts/1-C30O",
                        "rel": "self"
                    },
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/contacts",
                        "rel": "contacts"
                    }
                ]
            },
            "mailAddresses": [
                "jjudge@akamai.com"
            ]
        },
        "messageSize": {
            "value": "50 MB (approx. 300 MB uncompressed logs)",
            "id": "1",
            "links": [
                {
                    "href": "/lds-api/v3/log-configuration-parameters/message-sizes/1",
                    "rel": "self"
                },
                {
                    "href": "/lds-api/v3/log-configuration-parameters/message-sizes",
                    "rel": "messageSizes"
                }
            ]
        },
        "deliveryDetails": {
            "machine": "akainsight.upload.akamai.com",
            "directory": "/23567/logs/200957",
            "login": "insightlds",
            "password": "",
            "type": "ftp"
        },
        "encodingDetails": {
            "encoding": {
                "value": "GZIP",
                "id": "3",
                "links": [
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/encodings/3",
                        "rel": "self"
                    },
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/encodings",
                        "rel": "encodings"
                    }
                ]
            }
        },
        "id": "163842"
    },
    {
        "status": "suspended",
        "startDate": "2011-04-05",
        "aggregationDetails": {
            "deliveryFrequency": {
                "value": "Every 1 hour",
                "id": "7",
                "links": [
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies/7",
                        "rel": "self"
                    },
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies",
                        "rel": "deliveryFrequencies"
                    }
                ]
            },
            "type": "byLogArrival"
        },
        "logFormatDetails": {
            "logFormat": {
                "value": "W3C + Edge Tokenization",
                "id": "13",
                "links": [
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/log-formats/13",
                        "rel": "self"
                    },
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/log-formats",
                        "rel": "logFormats"
                    }
                ]
            },
            "logIdentifier": "edgetoken"
        },
        "endDate": "2011-04-08",
        "links": [
            {
                "href": "/lds-api/v3/log-configuration/143296",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-sources/cpcode-products/104523-1/log-configurations",
                "rel": "get-log-configurations-for-log-source",
                "title": "Get Log Configurations for the same log source"
            },
            {
                "href": "/lds-api/v3/log-sources/cpcode-products/log-configurations",
                "rel": "get-log-configurations-for-log-source-type",
                "title": "Get Log Configurations for the same log source type"
            },
            {
                "href": "/lds-api/v3/log-configuration/143296",
                "method": "PUT",
                "rel": "update-log-configuration",
                "title": "Update Log Configuration"
            },
            {
                "href": "/lds-api/v3/log-configuration/143296",
                "method": "DELETE",
                "rel": "delete-log-configuration",
                "title": "Delete Log Configuration"
            },
            {
                "href": "/lds-api/v3/log-configuration/143296/resume",
                "method": "POST",
                "rel": "resume-log-configuration",
                "title": "Resume Log Configuration"
            }
        ],
        "logSource": {
            "cpCode": "104523 - MOCK CP CODE DESCR ",
            "type": "cpcode-products",
            "products": [
                "Web Application Accelerator"
            ],
            "id": "104523-1",
            "links": [
                {
                    "href": "/lds-api/v3/log-sources/cpcode-products/104523-1",
                    "rel": "self"
                },
                {
                    "href": "/lds-api/v3/log-sources/cpcode-products",
                    "rel": "cpcode-products"
                },
                {
                    "href": "/lds-api/v3/log-sources",
                    "rel": "log-sources"
                }
            ]
        },
        "contactDetails": {
            "contact": {
                "value": "Dmitriy Danilevsky - phone: 650.627.5222",
                "id": "VC-GAKY",
                "links": [
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/contacts/VC-GAKY",
                        "rel": "self"
                    },
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/contacts",
                        "rel": "contacts"
                    }
                ]
            },
            "mailAddresses": [
                "jad@akamai.com"
            ]
        },
        "messageSize": {
            "value": "50 MB (approx. 300 MB uncompressed logs)",
            "id": "1",
            "links": [
                {
                    "href": "/lds-api/v3/log-configuration-parameters/message-sizes/1",
                    "rel": "self"
                },
                {
                    "href": "/lds-api/v3/log-configuration-parameters/message-sizes",
                    "rel": "messageSizes"
                }
            ]
        },
        "deliveryDetails": {
            "type": "email",
            "emailAddress": "jad@akamai.com"
        },
        "encodingDetails": {
            "encoding": {
                "value": "GZIP & UUENCODED",
                "id": "1",
                "links": [
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/encodings/1",
                        "rel": "self"
                    },
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/encodings",
                        "rel": "encodings"
                    }
                ]
            }
        },
        "id": "143296"
    }
]
  1. Run the List Log Sources operation.

  2. Store the logSourceType from the appropriate object in that listing.

  3. Make a GET request to /lds-api/v3/log-sources/{logSourceType}/{logSourceId}/log-configurations.

  4. The response object includes a list of all log delivery configurations with the specified logSourceType and logSourceId.

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/v3/log-sources/{logSourceType}/log-formats

Sample: /lds-api/v3/log-sources/cpcode-products/log-formats

Parameter Type Sample Description
URL Parameters
logSourceType Enumeration cpcode-products Type of log source for which you can create a log delivery configuration. 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 invoking /lds-api/v3/log-sources/gtm-properties. Use the logSourceId to create a log delivery configuration. Possible enum values: answerx-objects, cpcode-products, edns-zones, gtm-properties.

Status 200 application/json

Response Body:

[
    {
        "value": "combined",
        "id": "2",
        "links": [
            {
                "href": "/lds-api/v3/log-configuration-parameters/log-formats/2",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-configuration-parameters/log-formats",
                "rel": "logFormats"
            },
            {
                "href": "/lds-api/v3/log-sources/cpcode-products/1-17310",
                "rel": "logSources"
            }
        ]
    },
    {
        "value": "W3C",
        "id": "3",
        "links": [
            {
                "href": "/lds-api/v3/log-configuration-parameters/log-formats/3",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-configuration-parameters/log-formats",
                "rel": "logFormats"
            },
            {
                "href": "/lds-api/v3/log-sources/cpcode-products/1-17310",
                "rel": "logSources"
            }
        ]
    }
]
  1. Run the List Log Sources operation.

  2. Store the logSourceType from the appropriate object in that listing.

  3. Make a GET request to /lds-api/v3/log-sources/{logSourceType}/log-formats.

  4. The response object lists the available log format options for the specified logSourceType. Store the id of 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/v3/log-sources/{logSourceType}/encodings{?deliveryType}

Sample: /lds-api/v3/log-sources/cpcode-products/encodings?deliveryType=email

Parameter Type Sample Description
URL Parameters
logSourceType Enumeration cpcode-products Type of log source for which you can create a log delivery configuration. 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 invoking /lds-api/v3/log-sources/gtm-properties. Use the logSourceId to create a log delivery configuration. Possible enum values: answerx-objects, cpcode-products, edns-zones, gtm-properties.
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:

[
    {
        "value": "GZIP",
        "id": "3",
        "links": [
            {
                "href": "/lds-api/v3/log-configuration-parameters/encodings/3",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-configuration-parameters/encodings",
                "rel": "encodings"
            }
        ]
    },
    {
        "value": "GPG Encrypted",
        "id": "4",
        "links": [
            {
                "href": "/lds-api/v3/log-configuration-parameters/encodings/4",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-configuration-parameters/encodings",
                "rel": "encodings"
            }
        ]
    }
]
  1. You can optionally limit the allowable encodings returned by deliveryType, either email or ftp.

  2. Make a GET request to /lds-api/v{version}/log-sources/encodings/{?deliveryType}.

  3. The response lists the allowable encoding options for the specified deliveryType. Store the encoding id to 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/v3/log-sources/{logSourceType}/{logSourceId}

Sample: /lds-api/v3/log-sources/cpcode-products/124

Parameter Type Sample Description
URL Parameters
logSourceType Enumeration cpcode-products Type of log source for which you can create a log delivery configuration. 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 invoking /lds-api/v3/log-sources/gtm-properties. Use the logSourceId to create a log delivery configuration. Possible enum values: answerx-objects, cpcode-products, edns-zones, gtm-properties.
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:

[
    {
        "cpCode": "23456 - MOCK CP CODE DESCR ",
        "type": "cpcode-products",
        "products": [
            "Quicktime Streaming"
        ],
        "id": "23456-4",
        "links": [
            {
                "href": "/lds-api/v3/log-sources/cpcode-products/23456-4",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-sources/cpcode-products",
                "rel": "cpcode-products"
            },
            {
                "href": "/lds-api/v3/log-sources",
                "rel": "log-sources"
            },
            {
                "href": "/lds-api/v3/log-sources/cpcode-products/23456-4/log-configurations",
                "method": "POST",
                "rel": "log-configurations",
                "title": "Create log configuration for this log source."
            }
        ]
    },
    {
        "propertyName": "origin-newcolumbus-qa.abgvoice.com.akadns.net",
        "type": "gtm",
        "id": "142981",
        "links": [
            {
                "href": "/lds-api/v3/log-sources/gtm/142981",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-sources/gtm",
                "rel": "gtm"
            },
            {
                "href": "/lds-api/v3/log-sources",
                "rel": "log-sources"
            },
            {
                "href": "/lds-api/v3/log-sources/gtm/142981/log-configurations",
                "method": "POST",
                "rel": "log-configurations",
                "title": "Create log configuration for this log source."
            }
        ]
    }
]
  1. Run the List Log Sources operation.

  2. Store the logSourceType and logSourceId from the appropriate object in that listing.

  3. 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/v3/log-sources/{logSourceType}/{logSourceId}/log-configurations

Sample: /lds-api/v3/log-sources/cpcode-products/124/log-configurations

Parameter Type Sample Description
URL Parameters
logSourceType Enumeration cpcode-products Type of log source for which you can create a log delivery configuration. 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 invoking /lds-api/v3/log-sources/gtm-properties. Use the logSourceId to create a log delivery configuration. Possible enum values: answerx-objects, cpcode-products, edns-zones, gtm-properties.
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:

[
    {
        "status": "active",
        "startDate": "2013-01-02",
        "aggregationDetails": {
            "deliveryFrequency": {
                "value": "Every 24 hours",
                "id": "1",
                "links": [
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies/1",
                        "rel": "self"
                    },
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies",
                        "rel": "deliveryFrequencies"
                    }
                ]
            },
            "type": "byLogArrival"
        },
        "logFormatDetails": {
            "logFormat": {
                "value": "combined",
                "id": "2",
                "links": [
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/log-formats/2",
                        "rel": "self"
                    },
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/log-formats",
                        "rel": "logFormats"
                    }
                ]
            },
            "logIdentifier": "200957"
        },
        "links": [
            {
                "href": "/lds-api/v3/log-configuration/163842",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-sources/cpcode-products/200957-1/log-configurations",
                "rel": "get-log-configurations-for-log-source",
                "title": "Get Log Configurations for the same log source"
            },
            {
                "href": "/lds-api/v3/log-sources/cpcode-products/log-configurations",
                "rel": "get-log-configurations-for-log-source-type",
                "title": "Get Log Configurations for the same log source type"
            },
            {
                "href": "/lds-api/v3/log-configuration/163842",
                "method": "PUT",
                "rel": "update-log-configuration",
                "title": "Update Log Configuration"
            },
            {
                "href": "/lds-api/v3/log-configuration/163842",
                "method": "DELETE",
                "rel": "delete-log-configuration",
                "title": "Delete Log Configuration"
            },
            {
                "href": "/lds-api/v3/log-configuration/163842/suspend",
                "method": "POST",
                "rel": "suspend-log-configuration",
                "title": "Suspend Log Configuration"
            }
        ],
        "logSource": {
            "cpCode": "200957 - MOCK CP CODE DESCR ",
            "type": "cpcode-products",
            "products": [
                "HTTP Content Delivery"
            ],
            "id": "200957-1",
            "links": [
                {
                    "href": "/lds-api/v3/log-sources/cpcode-products/200957-1",
                    "rel": "self"
                },
                {
                    "href": "/lds-api/v3/log-sources/cpcode-products",
                    "rel": "cpcode-products"
                },
                {
                    "href": "/lds-api/v3/log-sources",
                    "rel": "log-sources"
                }
            ]
        },
        "contactDetails": {
            "contact": {
                "value": ". Help-Desk - phone: 617.250.3900",
                "id": "1-C30O",
                "links": [
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/contacts/1-C30O",
                        "rel": "self"
                    },
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/contacts",
                        "rel": "contacts"
                    }
                ]
            },
            "mailAddresses": [
                "jjudge@akamai.com"
            ]
        },
        "messageSize": {
            "value": "50 MB (approx. 300 MB uncompressed logs)",
            "id": "1",
            "links": [
                {
                    "href": "/lds-api/v3/log-configuration-parameters/message-sizes/1",
                    "rel": "self"
                },
                {
                    "href": "/lds-api/v3/log-configuration-parameters/message-sizes",
                    "rel": "messageSizes"
                }
            ]
        },
        "deliveryDetails": {
            "machine": "akainsight.upload.akamai.com",
            "directory": "/23567/logs/200957",
            "login": "insightlds",
            "password": "",
            "type": "ftp"
        },
        "encodingDetails": {
            "encoding": {
                "value": "GZIP",
                "id": "3",
                "links": [
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/encodings/3",
                        "rel": "self"
                    },
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/encodings",
                        "rel": "encodings"
                    }
                ]
            }
        },
        "id": "163842"
    },
    {
        "status": "suspended",
        "startDate": "2011-04-05",
        "aggregationDetails": {
            "deliveryFrequency": {
                "value": "Every 1 hour",
                "id": "7",
                "links": [
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies/7",
                        "rel": "self"
                    },
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/delivery-frequencies",
                        "rel": "deliveryFrequencies"
                    }
                ]
            },
            "type": "byLogArrival"
        },
        "logFormatDetails": {
            "logFormat": {
                "value": "W3C + Edge Tokenization",
                "id": "13",
                "links": [
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/log-formats/13",
                        "rel": "self"
                    },
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/log-formats",
                        "rel": "logFormats"
                    }
                ]
            },
            "logIdentifier": "edgetoken"
        },
        "endDate": "2011-04-08",
        "links": [
            {
                "href": "/lds-api/v3/log-configuration/143296",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-sources/cpcode-products/104523-1/log-configurations",
                "rel": "get-log-configurations-for-log-source",
                "title": "Get Log Configurations for the same log source"
            },
            {
                "href": "/lds-api/v3/log-sources/cpcode-products/log-configurations",
                "rel": "get-log-configurations-for-log-source-type",
                "title": "Get Log Configurations for the same log source type"
            },
            {
                "href": "/lds-api/v3/log-configuration/143296",
                "method": "PUT",
                "rel": "update-log-configuration",
                "title": "Update Log Configuration"
            },
            {
                "href": "/lds-api/v3/log-configuration/143296",
                "method": "DELETE",
                "rel": "delete-log-configuration",
                "title": "Delete Log Configuration"
            },
            {
                "href": "/lds-api/v3/log-configuration/143296/resume",
                "method": "POST",
                "rel": "resume-log-configuration",
                "title": "Resume Log Configuration"
            }
        ],
        "logSource": {
            "cpCode": "104523 - MOCK CP CODE DESCR ",
            "type": "cpcode-products",
            "products": [
                "Web Application Accelerator"
            ],
            "id": "104523-1",
            "links": [
                {
                    "href": "/lds-api/v3/log-sources/cpcode-products/104523-1",
                    "rel": "self"
                },
                {
                    "href": "/lds-api/v3/log-sources/cpcode-products",
                    "rel": "cpcode-products"
                },
                {
                    "href": "/lds-api/v3/log-sources",
                    "rel": "log-sources"
                }
            ]
        },
        "contactDetails": {
            "contact": {
                "value": "Dmitriy Danilevsky - phone: 650.627.5222",
                "id": "VC-GAKY",
                "links": [
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/contacts/VC-GAKY",
                        "rel": "self"
                    },
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/contacts",
                        "rel": "contacts"
                    }
                ]
            },
            "mailAddresses": [
                "jad@akamai.com"
            ]
        },
        "messageSize": {
            "value": "50 MB (approx. 300 MB uncompressed logs)",
            "id": "1",
            "links": [
                {
                    "href": "/lds-api/v3/log-configuration-parameters/message-sizes/1",
                    "rel": "self"
                },
                {
                    "href": "/lds-api/v3/log-configuration-parameters/message-sizes",
                    "rel": "messageSizes"
                }
            ]
        },
        "deliveryDetails": {
            "type": "email",
            "emailAddress": "jad@akamai.com"
        },
        "encodingDetails": {
            "encoding": {
                "value": "GZIP & UUENCODED",
                "id": "1",
                "links": [
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/encodings/1",
                        "rel": "self"
                    },
                    {
                        "href": "/lds-api/v3/log-configuration-parameters/encodings",
                        "rel": "encodings"
                    }
                ]
            }
        },
        "id": "143296"
    }
]
  1. Run the List Log Sources operation.

  2. Store the logSourceType and logSourceId from the appropriate object in that listing.

  3. Make a GET request to /lds-api/v3/log-sources/{logSourceType}/{logSourceId}/log-configurations.

  4. 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/v3/log-sources/{logSourceType}/{logSourceId}/log-configurations

Sample: /lds-api/v3/log-sources/cpcode-products/124/log-configurations

Content-Type: application/json

Request Body:

{
    "encodingDetails": {
        "encoding": {
            "id": "1"
        }
    },
    "startDate": "2012-10-31",
    "aggregationDetails": {
        "deliveryFrequency": {
            "id": "1"
        },
        "type": "byLogArrival"
    },
    "logFormatDetails": {
        "logFormat": {
            "id": "12"
        },
        "logIdentifier": "dfgd"
    },
    "contactDetails": {
        "contact": {
            "id": "1-2LPWVP"
        },
        "mailAddresses": [
            "asfasf@fa.pl"
        ]
    },
    "messageSize": {
        "id": "2"
    },
    "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. 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 invoking /lds-api/v3/log-sources/gtm-properties. Use the logSourceId to create a log delivery configuration. Possible enum values: answerx-objects, cpcode-products, edns-zones, gtm-properties.
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
  1. Run the Get Log Configurations by Type operation.

  2. Store the logConfigurationId from the appropriate object in that listing.

  3. Run the Get a Log Configuration operation if you need to review this configuration’s parameters before modifying them.

  4. 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.

  5. 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/v3/log-sources/{logSourceType}/{logSourceId}/log-formats

Sample: /lds-api/v3/log-sources/cpcode-products/124/log-formats

Parameter Type Sample Description
URL Parameters
logSourceType Enumeration cpcode-products Type of log source for which you can create a log delivery configuration. 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 invoking /lds-api/v3/log-sources/gtm-properties. Use the logSourceId to create a log delivery configuration. Possible enum values: answerx-objects, cpcode-products, edns-zones, gtm-properties.
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:

[
    {
        "value": "combined",
        "id": "2",
        "links": [
            {
                "href": "/lds-api/v3/log-configuration-parameters/log-formats/2",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-configuration-parameters/log-formats",
                "rel": "logFormats"
            },
            {
                "href": "/lds-api/v3/log-sources/cpcode-products/1-17310",
                "rel": "logSources"
            }
        ]
    },
    {
        "value": "W3C",
        "id": "3",
        "links": [
            {
                "href": "/lds-api/v3/log-configuration-parameters/log-formats/3",
                "rel": "self"
            },
            {
                "href": "/lds-api/v3/log-configuration-parameters/log-formats",
                "rel": "logFormats"
            },
            {
                "href": "/lds-api/v3/log-sources/cpcode-products/1-17310",
                "rel": "logSources"
            }
        ]
    }
]
  1. Run the List Log Sources operation.

  2. Store the logSourceType and logSourceId from the appropriate object in that listing.

  3. Make a GET request to /lds-api/v3/log-sources/{logSourceType}/{logSourceId}/log-formats.

  4. The response object lists the available log format options for the specified logSourceId. Store the log format id to use when creating or modifying log delivery configurations.


Last modified: 4/11/2017