Akamai APIs API Documentation

Service-Level Agreement API

Number of APIs: 9

Use the Service-Level Agreement (SLA) API to access SLA test configurations and the resulting reports to track your test results. With this API, you can also add and delete these configurations as well as retrieve the availability and performance SLA test reports.

The results of the SLA tests can help you check whether Akamai is achieving the performance gains and platform availability as specified in the SLA included with your purchase contract.

Authentication

Create an authentication credential that contains the client token and client secret required to authenticate Akamai API requests.

Note: Only Akamai customers can create credentials. If you aren't an Akamai customer and wish to become one, you can sign up for our services.

Navigate to the Identity and Access Management section of Akamai Control Center and click Create API Client.

Note: If you don't have access to the Identity and Access Management tool, contact your local Akamai Control Center admin or your Akamai account team for assistance.

Click Quick and then Download in the Credentials section.

Note: If you need to refine access levels or permissions, see Create a client with custom permissions.

Open the downloaded file with a text editor and add [default] as a header above all text.

  [default]
  client_secret = C113nt53KR3TN6N90yVuAgICxIRwsObLi0E67/N8eRN=
  host = akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net
  access_token = akab-acc35t0k3nodujqunph3w7hzp7-gtm6ij
  client_token = akab-c113ntt0k3n4qtari252bfxxbsl-yvsdj

Fork the [Akamai Authentication] environment, populate the variables, and [set it for your workspace]

Dependencies

To enable this API, go to the API list of your API client in Control Center, choose the API service named SLA API, and set the access level to READ-WRITE.

Integration methods

You can use this API collection in these integration methods: - API

1. Quotas - List test configuration quotas

GET https://{{host}}/sla-api/v1/test-quotas

Each contract has a maximum number of allowed test configurations. Get the test quotas to find out how many test configurations are allowed and how many are in use.

2. Tests - List test configurations

GET https://{{host}}/sla-api/v1/tests

Returns all test configurations, or a filtered set you use the slaTestIds parameter to control.

3. Tests - Get a test configuration

GET https://{{host}}/sla-api/v1/tests/:slaTestId

Return the contents of one test configuration. Set the slaTestId parameter to indicate which test configuration to retrieve.

4. Tests - Update a test configuration

PUT https://{{host}}/sla-api/v1/tests/:slaTestId

Use this operation change an existing test configuration, such as changing the agent group or adding a performance target. Set the slaTestId parameter to indicate which test configuration to update.

5. Tests - Delete a test configuration

DELETE https://{{host}}/sla-api/v1/tests/:slaTestId

Deletion cannot be undone. Once you delete a test configuration, you can't retrieve it or any data that it has collected. Set the slaTestId parameter to indicate which test configuration to delete.

6. Agent Groups - List agent groups

GET https://{{host}}/sla-api/v1/agent-groups

This returns an array of all agent group identifiers and their corresponding descriptions. You can use this to retrieve a human-readable equivalent of the agentGroupId numbers.

7. Create Test - Create a new test configuration

POST https://{{host}}/sla-api/v1/tests

Create either a new availability test configuration or a new performance test configuration, if there is an available corresponding slot in the contract's quotas.

8. Reports - List availability reports

GET https://{{host}}/sla-api/v1/tests/:slaTestId/reports/availability?start={{start}}&end={{end}}

Returns an array of the results of availability tests run in the specified time period.

9. Reports - List performance reports

GET https://{{host}}/sla-api/v1/tests/:slaTestId/reports/performance?start={{start}}&end={{end}}

Returns an array of the results of performance tests run in the specified time period.