Akamai: API Endpoint Definition API
Register and manage your APIs to enable security, delivery, and governance.
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
Register and manage your APIs to enable security, delivery, and
governance.
Endpoints 72
Categories
- GETList categories
/categories?withUsageInfo={{withUsageInfo}}&accountSwitchKey={{accountSwitchKey}}Lists all categories available to tag endpoints and optionally indicates the number of endpoints tagged under each category. - POSTCreate a category
/categories?accountSwitchKey={{accountSwitchKey}}Creates a category that you can use to tag endpoints. The request's apiCategoryName needs to be unique per account. - GETGet a category
/categories/:apiCategoryId?accountSwitchKey={{accountSwitchKey}}Returns a specific category that you can use to tag endpoints. - PUTEdit a category
/categories/:apiCategoryId?accountSwitchKey={{accountSwitchKey}}Updates a category's description or unique name. - DELETEDelete a category
/categories/:apiCategoryId?accountSwitchKey={{accountSwitchKey}}Removes an unassigned category. If you assigned the category to at least one endpoint, the operation returns a 403 error.
Contracts and groups
- GETList contracts and groups
/contracts/groups?accountSwitchKey={{accountSwitchKey}}You provision each API endpoint within the context of your contract with Akamai and a Control Center portal group. The response objects encapsulate pairings… - GETList hostnames
/contracts/:contractId/groups/:groupId/hosts?accountSwitchKey={{accountSwitchKey}}Lists all hostnames through which API consumers can access an endpoint service under a given contract and group pairing. You can use Property Manager (or… - GETList hostnames with access control groups
/contracts/:contractId/groups/:groupId/hostsAcgs?accountSwitchKey={{accountSwitchKey}}Lists all hostnames through which API consumers can access an endpoint service under a given contract and group pairing. Returns each hostname together with…
Endpoints
- GETList endpoints
/endpoints?piiOnly={{piiOnly}}&page={{page}}&pageSize={{pageSize}}&category={{category}}&contains={{contains}}&sortBy={{sortBy}}&sortOrder={{sortOrder}}&versionPreference={{versionPreference}}&show={{show}}&contractId={{contractId}}&groupId={{groupId}}&accountSwitchKey={{accountSwitchKey}}Lists the available API endpoints, with results optionally paginated, sorted, and filtered. If no endpoints are available, the operation responds with an… - POSTRegister an endpoint
/endpoints?accountSwitchKey={{accountSwitchKey}}Creates the first version of an API endpoint configuration. You can specify the new endpoint's full set of resources. Alternatively, you can create them later… - POSTClone an endpoint
/endpoints/cloneEndpoint?accountSwitchKey={{accountSwitchKey}}Creates an endpoint as a clone from the specified source endpoint ID and version. - POSTRegister an endpoint from an API definition file
/endpoints/files?excludeRequestContent={{excludeRequestContent}}&excludeResponseContent={{excludeResponseContent}}&accountSwitchKey={{accountSwitchKey}}Imports an API definition file and creates a new endpoint based on the file contents, optionally stripping out request or response body specifications. You… - GETList user entitlements
/endpoints/user-entitlements?accountSwitchKey={{accountSwitchKey}}Lists user entitlements based on your assigned permissions. It helps you determine if your user identity assigned to the API client can run various other… - POSTVerify secure connection
/endpoints/verify-secure-connection?accountSwitchKey={{accountSwitchKey}}Verifies that provided hostnames are signed with a provided certificate chain. This ensures that edge servers can connect to the hostnames securely. The… - DELETEDelete an endpoint
/endpoints/:apiEndPointId?accountSwitchKey={{accountSwitchKey}}Removes an endpoint configuration from API Gateway if none of the endpoint's versions are active or pending activation on the staging or production network. - POSTHide an endpoint
/endpoints/:apiEndPointId/hide?accountSwitchKey={{accountSwitchKey}}Hides an endpoint and all its versions. You can only hide an endpoint with no active versions on the staging or production network. You can't activate or… - POSTShow an endpoint
/endpoints/:apiEndPointId/show?accountSwitchKey={{accountSwitchKey}}Reveals a hidden endpoint and all its versions. A revealed endpoint appears in the List endpoints operation's response object by default, or when you set the…
Versions
- GETList versions
/endpoints/:apiEndPointId/versions?page={{page}}&pageSize={{pageSize}}&sortBy={{sortBy}}&sortOrder={{sortOrder}}&show={{show}}&accountSwitchKey={{accountSwitchKey}}Returns versions of an endpoint, with results optionally paginated, sorted, and filtered. - GETGet a version summary
/endpoints/:apiEndPointId/versions/:versionNumber?accountSwitchKey={{accountSwitchKey}}Returns a summary for a specific endpoint version. The summary is for purely informational purposes, and you shouldn't use this operation's response in the… - PUTEdit a version
/endpoints/:apiEndPointId/versions/:versionNumber?accountSwitchKey={{accountSwitchKey}}Updates details about an endpoint version that has never been activated on the staging or production network. You can configure the endpoint's security… - DELETEDelete a version
/endpoints/:apiEndPointId/versions/:versionNumber?accountSwitchKey={{accountSwitchKey}}Removes an endpoint version from API Gateway if the version has never been activated on the staging or production network. This is a soft delete operation… - POSTActivate a version
/endpoints/:apiEndPointId/versions/:versionNumber/activate?accountSwitchKey={{accountSwitchKey}}Activates an endpoint version on the staging or production network. If another version of the endpoint is already active on the specified network, that… - POSTClone a version
/endpoints/:apiEndPointId/versions/:versionNumber/cloneVersion?accountSwitchKey={{accountSwitchKey}}Creates a new endpoint version as a clone of an existing version. The system assigns a new number to the version that you clone. - POSTDeactivate a version
/endpoints/:apiEndPointId/versions/:versionNumber/deactivate?accountSwitchKey={{accountSwitchKey}}Deactivates an endpoint version on the staging or production network. A deactivated endpoint version no longer serves traffic through the Akamai network. - POSTEdit an endpoint from an API definition file
/endpoints/:apiEndPointId/versions/:versionNumber/file?accountSwitchKey={{accountSwitchKey}}Imports an API definition file with details about an endpoint. Unlike Register an endpoint from an API definition file, this operation doesn't create a new… - POSTHide a version
/endpoints/:apiEndPointId/versions/:versionNumber/hide?accountSwitchKey={{accountSwitchKey}}Hides an endpoint version. You can only hide inactive or deactivated versions. You can't activate or delete hidden versions. A hidden endpoint version appears… - POSTShow a version
/endpoints/:apiEndPointId/versions/:versionNumber/show?accountSwitchKey={{accountSwitchKey}}Reveals a hidden endpoint version. A revealed endpoint version appears in the List versions operation's response object with the hidden parameter set to…
Personally identifiable information
- GETList parameters with PII for an endpoint version
/endpoints/:apiEndPointId/versions/:versionNumber/piis?status={{status}}&accountSwitchKey={{accountSwitchKey}}Returns all PII objects for an endpoint version. This includes parameters with PII already in your API definition, as well as parameters with PII the network… - POSTAdd or update a user-created PII instance
/endpoints/:apiEndPointId/versions/:versionNumber/piis/parameters/:paramId?accountSwitchKey={{accountSwitchKey}}Adds or updates PII in an API parameter. This is for you to add to or modify in your API definition yourself, rather than the network discovering the PII for… - GETList PII settings for an endpoint version
/endpoints/:apiEndPointId/versions/:versionNumber/piis/settings?accountSwitchKey={{accountSwitchKey}}Returns the PII settings in an endpoint version, including the inspection scope and constraints, and how you want the network to handle PII. - POSTModify PII settings for an endpoint version
/endpoints/:apiEndPointId/versions/:versionNumber/piis/settings?accountSwitchKey={{accountSwitchKey}}Update the PII settings in an endpoint version. These settings are for a PII object per endpoint version, so if you have the same object in multiple endpoint… - POSTModify PII status per endpoint version
/endpoints/:apiEndPointId/versions/:versionNumber/piis/status?accountSwitchKey={{accountSwitchKey}}Update the PII status. This operation applies to PII found by the network and not PII you add to your API definition yourself. - DELETEDelete PII in an endpoint version
/endpoints/:apiEndPointId/versions/:versionNumber/piis/:piiId?accountSwitchKey={{accountSwitchKey}}Removes a PII object from your API endpoint definition for the version you specify. If you want to delete the PII object from all the versions where it… - PATCHPatch PII status per endpoint version
/endpoints/:apiEndPointId/versions/:versionNumber/piis/:piiId/status?accountSwitchKey={{accountSwitchKey}}Update the PII status. This operation applies to PII found by the network and not PII you add to your API definition yourself.
Resources
- GETList resources
/endpoints/:apiEndPointId/versions/:versionNumber/resources?accountSwitchKey={{accountSwitchKey}}Lists all resources assigned to an endpoint version. You can use the apiResourceId of each returned resource to modify resources individually through the Edit… - POSTCreate a resource
/endpoints/:apiEndPointId/versions/:versionNumber/resources?accountSwitchKey={{accountSwitchKey}}Creates a resource in an endpoint version. The resource's full URL (concatenated hostname, basePath, and resourcepath) needs to be unique within the account.… - GETGet a version
/endpoints/:apiEndPointId/versions/:versionNumber/resources-detail?accountSwitchKey={{accountSwitchKey}}Returns an endpoint version. Use this operation's response object when modifying an endpoint version through Edit a version. Don't use Get a version summary… - GETGet a resource
/endpoints/:apiEndPointId/versions/:versionNumber/resources/:apiResourceId?accountSwitchKey={{accountSwitchKey}}Returns a resource within an endpoint version. - PUTEdit a resource
/endpoints/:apiEndPointId/versions/:versionNumber/resources/:apiResourceId?accountSwitchKey={{accountSwitchKey}}Updates a resource within an endpoint version. You can edit information about a resource, the methods, and the parameters assigned to a resource. You can only… - DELETEDelete a resource
/endpoints/:apiEndPointId/versions/:versionNumber/resources/:apiResourceId?accountSwitchKey={{accountSwitchKey}}Removes a resource from an endpoint version. You can only remove resources assigned to versions that have never been activated on the staging or production…
API privacy
- GETGet API privacy settings
/endpoints/:apiEndPointId/versions/:versionNumber/settings/api-privacy?accountSwitchKey={{accountSwitchKey}}Returns the API privacy settings configured for an endpoint version and its assigned resources. - PUTEdit API privacy settings
/endpoints/:apiEndPointId/versions/:versionNumber/settings/api-privacy?accountSwitchKey={{accountSwitchKey}}Updates the API privacy settings configured for an endpoint version and its assigned resources.
Cache
- GETGet cache settings
/endpoints/:apiEndPointId/versions/:versionNumber/settings/cache?accountSwitchKey={{accountSwitchKey}}Returns the caching settings configured for an endpoint version and its assigned resources. You can set all objects independently from the root customize field. - PUTEdit cache settings
/endpoints/:apiEndPointId/versions/:versionNumber/settings/cache?accountSwitchKey={{accountSwitchKey}}Updates the caching settings configured for an endpoint version and its assigned resources.
CORS
- GETGet CORS settings
/endpoints/:apiEndPointId/versions/:versionNumber/settings/cors?accountSwitchKey={{accountSwitchKey}}Returns the cross-origin resource sharing (CORS) settings configured for an endpoint version. - PUTEdit CORS settings
/endpoints/:apiEndPointId/versions/:versionNumber/settings/cors?accountSwitchKey={{accountSwitchKey}}Updates the cross-origin resource sharing (CORS) settings configured for an endpoint version.
Error responses
- GETGet error response settings
/endpoints/:apiEndPointId/versions/:versionNumber/settings/error-responses?accountSwitchKey={{accountSwitchKey}}Returns the error response settings configured for an endpoint version. - PUTEdit error response settings
/endpoints/:apiEndPointId/versions/:versionNumber/settings/error-responses?accountSwitchKey={{accountSwitchKey}}Updates the error response settings configured for an endpoint version. - GETGet an error response
/endpoints/:apiEndPointId/versions/:versionNumber/settings/error-responses/:type?accountSwitchKey={{accountSwitchKey}}Returns a customizable error response of the selected type. - PUTEdit an error response
/endpoints/:apiEndPointId/versions/:versionNumber/settings/error-responses/:type?accountSwitchKey={{accountSwitchKey}}Updates a customizable error response of the selected type.
GraphQL
- GETGet GraphQL cache settings
/endpoints/:apiEndPointId/versions/:versionNumber/settings/graphql?accountSwitchKey={{accountSwitchKey}}Returns the GraphQL caching settings configured for an endpoint version. - PUTEdit GraphQL cache settings
/endpoints/:apiEndPointId/versions/:versionNumber/settings/graphql?accountSwitchKey={{accountSwitchKey}}Updates the GraphQL caching settings configured for an endpoint version.
GZIP
- GETGet GZIP settings
/endpoints/:apiEndPointId/versions/:versionNumber/settings/gzip?accountSwitchKey={{accountSwitchKey}}Returns the GZIP compression settings configured for an endpoint version. - PUTEdit GZIP settings
/endpoints/:apiEndPointId/versions/:versionNumber/settings/gzip?accountSwitchKey={{accountSwitchKey}}Updates the GZIP compression settings configured for an endpoint version.
JWT
- GETGet JWT settings
/endpoints/:apiEndPointId/versions/:versionNumber/settings/jwt?accountSwitchKey={{accountSwitchKey}}Returns the JWT validation settings configured for an endpoint version and its assigned resources. - PUTEdit JWT settings
/endpoints/:apiEndPointId/versions/:versionNumber/settings/jwt?accountSwitchKey={{accountSwitchKey}}Updates the JWT validation settings configured for an endpoint version and its assigned resources.
Routing
- GETGet routing settings
/endpoints/:apiEndPointId/versions/:versionNumber/settings/routing?accountSwitchKey={{accountSwitchKey}}Returns the incoming request's routing, forwarding, and SureRoute settings configured for an endpoint version. You can run this operation if you're taking… - PUTEdit routing settings
/endpoints/:apiEndPointId/versions/:versionNumber/settings/routing?accountSwitchKey={{accountSwitchKey}}Updates the incoming request's routing, forwarding, and SureRoute settings configured for an endpoint version. You can run this operation if you're taking…
Multistep groups
- GETList multistep group details
/endpoints/:endpointId/versions/:versionNumber/multistep-groups?accountSwitchKey={{accountSwitchKey}}Get the multistep group's name. To find out which operations are a part of this multistep group,list resource operations and check their multistepGroupId. - POSTCreate a multistep group
/endpoints/:endpointId/versions/:versionNumber/multistep-groups?accountSwitchKey={{accountSwitchKey}}Create a multistep group with a chosen name. To add operations and create a multistep flow, you need to list resource operations, and then get and update each… - GETGet a multistep group
/endpoints/:endpointId/versions/:versionNumber/multistep-groups/:multistepGroupId?accountSwitchKey={{accountSwitchKey}}Get the multistep group's name. To find out which operations are a part of this multistep group, list resource operations and check their 'multistepGroupId'. - PUTUpdate a multistep group
/endpoints/:endpointId/versions/:versionNumber/multistep-groups/:multistepGroupId?accountSwitchKey={{accountSwitchKey}}Change the multistep group's name. To assign an operation to a multistep group, modify its 'multistepGroupId' value. You can only add any given operation to a… - DELETEDelete a multistep group
/endpoints/:endpointId/versions/:versionNumber/multistep-groups/:multistepGroupId?accountSwitchKey={{accountSwitchKey}}Remove a specific multistep group. This also deletes all operations in this group.
Resources and operations
- GETList resources and operations
/endpoints/:endpointId/versions/:versionNumber/resources-and-operations?accountSwitchKey={{accountSwitchKey}}List all of your resources and resource operations for an API endpoint.
Resource operations
- GETList resource operations
/endpoints/:endpointId/versions/:versionNumber/resources/:apiResourceId/operations?accountSwitchKey={{accountSwitchKey}}List all of your resource operations and their resources. - POSTCreate a resource operation
/endpoints/:endpointId/versions/:versionNumber/resources/:apiResourceId/operations?accountSwitchKey={{accountSwitchKey}}Create a resource operation. These operations define the purposes of your API resources. Use them to identify the expected usage of your resources to protect… - GETGet a resource operation
/endpoints/:endpointId/versions/:versionNumber/resources/:apiResourceId/operations/:operationId?accountSwitchKey={{accountSwitchKey}}Get details about a specific resource operation. - PUTUpdate a resource operation
/endpoints/:endpointId/versions/:versionNumber/resources/:apiResourceId/operations/:operationId?accountSwitchKey={{accountSwitchKey}}Update details about a resource operation. You can change the operation's name, method, purpose, and more. - DELETEDelete a resource operation
/endpoints/:endpointId/versions/:versionNumber/resources/:apiResourceId/operations/:operationId?accountSwitchKey={{accountSwitchKey}}Remove a specific resource operation.
Filter operations
- GETSearch operations
/search-operations?queryType={{queryType}}&activeStartTime={{activeStartTime}}&activeEndTime={{activeEndTime}}&includeDetails={{includeDetails}}&accountSwitchKey={{accountSwitchKey}}Get a filtered list of operations and their endpoints and resources. Use queryType to filter by date ranges or activation statuses. For more complex queries,… - POSTQuery operations
/search-operations?accountSwitchKey={{accountSwitchKey}}Get a filtered list of operations and their endpoints and resources. You can filter by date ranges, activation statuses, API Endpoint hostnames, and resource…
Verify operations
- POSTVerify existing operations
/verify-operations?accountSwitchKey={{accountSwitchKey}}Verify that operations exist. Specify a list of operation summaries and receive a list of matching operations and their details, along with any submission…
API details
- Base URL
https://{hostname}/api-definitions/v2- Authentication
- None declared in the description
- Operations
- 72 operations on 46 pathsGET 29POST 21PUT 14DELETE 7PATCH 1
- Main resources
- Versions 10Endpoints 9Personally identifiable information 7Resources 6Categories 5Multistep groups 5Resource operations 5Error responses 4Contracts and groups 3API privacy 2
- Response formats
application/problem+jsonapplication/json- Description format
- OpenAPI 3.0.0, API version
v2 - Links
- Documentation · OpenAPI document
- Listed from
- Akamai's published OpenAPI description (akamai/akamai-apis) (Apache-2.0)
How to test the Akamai: API Endpoint Definition API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Akamai: API Endpoint Definition API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “List categories” (GET /categories?withUsageInfo={{withUsageInfo}}&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: API Endpoint Definition API?
Register and manage your APIs to enable security, delivery, and governance. It is listed under Developer tools and has 72 endpoints.
Who publishes the Akamai: API Endpoint Definition 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: API Endpoint Definition API?
Requests go to https://{hostname}/api-definitions/v2. Endpoint paths are added to this base URL.
How do I authenticate with the Akamai: API Endpoint Definition 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: API Endpoint Definition API have?
72 operations on 46 paths (29 GET, 21 POST, 14 PUT, 7 DELETE, 1 PATCH). The largest groups are Versions, Endpoints, Personally identifiable information, Resources.
Is forking the Akamai: API Endpoint Definition API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.