Akamai

Akamai: CP Codes and Reporting Groups API

Akamai: CP Codes and Reporting Groups API endpoints from Akamai

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

Akamai: CP Codes and Reporting Groups API endpoints from Akamai

Endpoints 11

CP codes

  • GETList CP codes/cpcodes?contractId={{contractId}}&groupId={{groupId}}&productId={{productId}}&cpcodeName={{cpcodeName}}&accountSwitchKey={{accountSwitchKey}}Lists detailed information about CP codes available within your account and contract.
  • GETGet a CP code/cpcodes/:cpcodeId?accountSwitchKey={{accountSwitchKey}}Get detailed information about a specific CP code. The details include the CP code type, name, time zone, as well as the account, contracts, and products it's…
  • PUTUpdate a CP code/cpcodes/:cpcodeId?accountSwitchKey={{accountSwitchKey}}Modifies a specific CP code. After running the GET a CP code operation, use the response to build a request body. You can only modify a CP code's name, time…

Watermark limits

  • GETGet a water-mark limit/cpcodes/contracts/:contractId/watermark-limits?accountSwitchKey={{accountSwitchKey}}Get a watermark limit for CP codes for a specific contract within your account. For more details, see Rate and resource limiting.
  • GETGet a water-mark limit for reporting groups/reporting-groups/contracts/:contractId/watermark-limits?accountSwitchKey={{accountSwitchKey}}Get a watermark limit for CP reporting groups for a specific contract within your account. For more details, see Rate and resource limiting.

Reporting groups

  • GETList reporting groups/reporting-groups?contractId={{contractId}}&groupId={{groupId}}&reportingGroupName={{reportingGroupName}}&cpcodeId={{cpcodeId}}&accountSwitchKey={{accountSwitchKey}}Lists detailed information about reporting groups available for your account and contract.
  • POSTCreate a reporting group/reporting-groups?accountSwitchKey={{accountSwitchKey}}Creates a reporting group. Make sure the reporting group's name is unique within an account. The location header in the response provides a relative path to…
  • GETGet a reporting group/reporting-groups/:reportingGroupId?accountSwitchKey={{accountSwitchKey}}Get detailed information about a specific reporting group. The details include the reporting group name and the access control group that it belongs to. This…
  • PUTUpdate a reporting group/reporting-groups/:reportingGroupId?accountSwitchKey={{accountSwitchKey}}Modifies a specific reporting group. You should only modify a reporting group's name and assigned CP codes.
  • DELETEDelete a reporting group/reporting-groups/:reportingGroupId?accountSwitchKey={{accountSwitchKey}}Deletes a specific reporting group.

Products

  • GETList products within a reporting group/reporting-groups/:reportingGroupId/products?accountSwitchKey={{accountSwitchKey}}Lists products and services assigned to a specific reporting group.

API details

Base URL
https://{hostname}/cprg/v1
Authentication
None declared in the description
Operations
11 operations on 7 pathsGET 7PUT 2POST 1DELETE 1
Main resources
Reporting groups 5CP codes 3Watermark limits 2Products 1
Response formats
application/problem+json application/json */*
Description format
OpenAPI 3.0.0, API version 1.0

How to test the Akamai: CP Codes and Reporting Groups 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: CP Codes and Reporting Groups 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 CP codes” (GET /cpcodes?contractId={{contractId}}&groupId={{groupId}}&productId={{productId}}&cpcodeName={{cpcodeName}}&accountSwitchKey={{accountSwitchKey}}), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Akamai: CP Codes and Reporting Groups API?

Akamai: CP Codes and Reporting Groups API endpoints from Akamai It is listed under Developer tools and has 11 endpoints.

Who publishes the Akamai: CP Codes and Reporting Groups 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: CP Codes and Reporting Groups API?

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

How do I authenticate with the Akamai: CP Codes and Reporting Groups 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: CP Codes and Reporting Groups API have?

11 operations on 7 paths (7 GET, 2 PUT, 1 POST, 1 DELETE). The largest groups are Reporting groups, CP codes, Watermark limits, Products.

Is forking the Akamai: CP Codes and Reporting Groups 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.