Akamai

Akamai: Case Management API

Manage support requests to resolve issues with your Akamai applications and services.

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

Manage support requests to resolve issues with your Akamai applications and services.

Endpoints 13

Accounts

  • GETList available accounts/accounts-with-categoriesLists accounts you can access. The list also includes types of cases you can create for each account. You need this data to Get a case category details and…

Cases

  • GETList cases/cases?type=MY_ACTIVE_CASES&duration=30&accountIds=A-CCT1234, A-CCT5678&limit=50&cursor=0690f000001y2utLists open or closed cases. You can filter the results to fetch only your cases or cases created by all users of your account. You can also limit the request…
  • POSTCreate a new case/casesCreates a new case for the support team. Run the Get a case category operation first to check what data you need for your case category and available options.…
  • GETGet a case/cases/:caseIdFetches details for a specific case.
  • PATCHUpdate contact details/cases/:caseIdUpdates the list of people to contact about the case. The alternate contact is the contact person if the case's creator is unavailable. The alternate contact…
  • POSTClose a case/cases/:caseId/request-case-closureSends a request to close a specific case.

Case comments

  • GETList comments/cases/:caseId/comments?limit=50&cursor=0690f000001y2utFetches comments added to a specific case. You can set the limit parameter as the maximum number.
  • POSTComment a case/cases/:caseId/commentsAdds a comment to a specific case. You can comment on tickets up to 14 days after they're closed.

Case attachments

  • GETList attached files/cases/:caseId/attachments?limit=50&cursor=0690f000001y2utFetches attachments added to a specific case. Use the limit parameter to limit the number of attachments.
  • POSTAttach a file/cases/:caseId/attachmentsAttaches a file to a specific case. Each case can have up to ten attachments, up to 2GB each. The response includes uploadId necessary to GET the status of an…
  • GETGet the status of an attachment upload/cases/:caseId/attachments/status/:uploadIdFetches the status for a specific attachment upload. Run this operation, to make sure that the upload was successful.
  • GETGet an attached file/cases/:caseId/attachments/:attachmentIdFetches a specific attachment from a specific case.

Case categories

  • GETGet a case category/categories/:categoryId?accountId=A-CCT1234Returns data required to create a case for a specific case category. To learn more about available case categories, see Categories of cases.

API details

Base URL
https://{hostname}/case-management/v3
Authentication
None declared in the description
Operations
13 operations on 9 pathsGET 8POST 4PATCH 1
Main resources
Cases 5Case attachments 4Case comments 2Accounts 1Case categories 1
Response formats
application/json application/octet-stream
Description format
OpenAPI 3.0.0, API version v1

How to test the Akamai: Case Management 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: Case Management 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 available accounts” (GET /accounts-with-categories), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Akamai: Case Management API?

Manage support requests to resolve issues with your Akamai applications and services. It is listed under Developer tools and has 13 endpoints.

Who publishes the Akamai: Case Management 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: Case Management API?

Requests go to https://{hostname}/case-management/v3. Endpoint paths are added to this base URL.

How do I authenticate with the Akamai: Case Management 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: Case Management API have?

13 operations on 9 paths (8 GET, 4 POST, 1 PATCH). The largest groups are Cases, Case attachments, Case comments, Accounts.

Is forking the Akamai: Case Management 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.