Akamai

Akamai: Service-Level Agreement API

Access the SLA test configurations and the resulting reports.

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Access the SLA test configurations and the resulting reports.

Endpoints 9

Quotas

  • GETList test configuration quotas/test-quotas?accountSwitchKey=1-5C0YLB:1-8BYUXEach 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…

Tests

  • GETList test configurations/tests?slaTestIds=82,83&accountSwitchKey=1-5C0YLB:1-8BYUXReturns all test configurations, or a filtered set you use the slaTestIds parameter to control.
  • GETGet a test configuration/tests/:slaTestId?accountSwitchKey=1-5C0YLB:1-8BYUXReturn the contents of one test configuration. Set the slaTestId parameter to indicate which test configuration to retrieve.
  • PUTUpdate a test configuration/tests/:slaTestId?accountSwitchKey=1-5C0YLB:1-8BYUXUse this operation change an existing test configuration, such as changing the agent group or adding a performance target. Set the slaTestId parameter to…
  • DELETEDelete a test configuration/tests/:slaTestId?accountSwitchKey=1-5C0YLB:1-8BYUXDeletion 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…

Agent Groups

  • GETList agent groups/agent-groups?accountSwitchKey=1-5C0YLB:1-8BYUXThis returns an array of all agent group identifiers and their corresponding descriptions. You can use this to retrieve a human-readable equivalent of the…

Create Test

  • POSTCreate a new test configuration/tests?accountSwitchKey=1-5C0YLB:1-8BYUXCreate either a new availability test configuration or a new performance test configuration, if there is an available corresponding slot in the contract's…

Reports

  • GETList availability reports/tests/:slaTestId/reports/availability?start=2016-03-09T00:00:00Z&end=2016-03-12T01:00:00Z&accountSwitchKey=1-5C0YLB:1-8BYUXReturns an array of the results of availability tests run in the specified time period.
  • GETList performance reports/tests/:slaTestId/reports/performance?start=2016-03-09T00:00:00Z&end=2016-03-12T01:00:00Z&accountSwitchKey=1-5C0YLB:1-8BYUXReturns an array of the results of performance tests run in the specified time period.

API details

Base URL
https://{hostname}/sla-api/v1
Authentication
None declared in the description
Operations
9 operations on 6 pathsGET 6PUT 1POST 1DELETE 1
Main resources
Tests 4Reports 2Agent Groups 1Create Test 1Quotas 1
Response formats
application/json
Description format
OpenAPI 3.0.0, API version v1

How to test the Akamai: Service-Level Agreement API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Akamai: Service-Level Agreement API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “List test configuration quotas” (GET /test-quotas?accountSwitchKey=1-5C0YLB:1-8BYUX), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Akamai: Service-Level Agreement API?

Access the SLA test configurations and the resulting reports. It is listed under Developer tools and has 9 endpoints.

Who publishes the Akamai: Service-Level Agreement API?

It is listed from Akamai's public API description (an OpenAPI document), not published by Akamai on Swastik Codes. Anyone who controls akamai.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Akamai: Service-Level Agreement API?

Requests go to https://{hostname}/sla-api/v1. Endpoint paths are added to this base URL.

How do I authenticate with the Akamai: Service-Level Agreement API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Akamai: Service-Level Agreement API have?

9 operations on 6 paths (6 GET, 1 PUT, 1 POST, 1 DELETE). The largest groups are Tests, Reports, Agent Groups, Create Test.

Is forking the Akamai: Service-Level Agreement API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.