{ "opencollection": "1.0.0", "info": { "name": "Akamai: API Endpoint Definition Access tokens Versions API", "version": "2" }, "items": [ { "info": { "name": "Versions", "type": "folder" }, "items": [ { "info": { "name": "List versions", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions", "params": [ { "name": "apiEndPointId", "value": "{{apiEndPointId}}", "type": "path", "description": "The unique identifier for the endpoint." }, { "name": "page", "value": "{{page}}", "type": "query", "description": "The page number index, starting at the default value of `1`." }, { "name": "pageSize", "value": "{{pageSize}}", "type": "query", "description": "The number of endpoint versions on each page of results." }, { "name": "sortBy", "value": "{{sortBy}}", "type": "query", "description": "__Enum__ The field to sort endpoint versions by." }, { "name": "sortOrder", "value": "{{sortOrder}}", "type": "query", "description": "__Enum__ The sort order, either `asc` for ascending or the default `desc` for descending." }, { "name": "show", "value": "{{show}}", "type": "query", "description": "__Enum__ The type of endpoint versions to return based on their visibility status. By default the API returns `ALL` endpoint version. You can instead decide to return `ONLY_VISIBLE` endpoint versions, or `ONLY_HIDDEN` endpoint versions. Run the [Show a version](https://techdocs.akamai.com/api-definitions/reference/post-version-show) and [Hide a version](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-version-hide) operations to control which endpoint versions are listed." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "Returns versions of an endpoint, with results optionally paginated, sorted, and filtered." }, { "info": { "name": "Get a version summary", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber", "params": [ { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "The unique identifier for the endpoint version." }, { "name": "apiEndPointId", "value": "{{apiEndPointId}}", "type": "path", "description": "The unique identifier for the endpoint." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "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 corresponding [Edit a version](https://techdocs.akamai.com/api-definitions/reference/put-endpoint-version) PUT request. For the PUT request, use the response object of [Get a version](https://techdocs.akamai.com/api-definitions/reference/get-endpoint-version-resource)." }, { "info": { "name": "Edit a version", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber", "params": [ { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "The unique identifier for the endpoint version." }, { "name": "apiEndPointId", "value": "{{apiEndPointId}}", "type": "path", "description": "The unique identifier for the endpoint." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates details about an endpoint version that has never been activated on the staging or production network. You can configure the endpoint's security settings and other top-level metadata, or modify the endpoint's entire set of resources as an alternative to separate calls to [Edit a resource](https://techdocs.akamai.com/api-definitions/reference/put-version-resource). Note that the corresponding [Get a version](https://techdocs.akamai.com/api-definitions/reference/get-endpoint-version-resourc" }, { "info": { "name": "Delete a version", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber", "params": [ { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "The unique identifier for the endpoint version." }, { "name": "apiEndPointId", "value": "{{apiEndPointId}}", "type": "path", "description": "The unique identifier for the endpoint." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "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 that preserves the version's information, such as its number, in the database. You can't remove the permanent number assigned to each endpoint version, even if you remove that version. A removed endpoint version no longer appears in the [List versions](https://techdocs.akamai.com/api-definitions/reference/get-endpoint-versions) operation's res" }, { "info": { "name": "Activate a version", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/activate", "params": [ { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "The unique identifier for the endpoint version." }, { "name": "apiEndPointId", "value": "{{apiEndPointId}}", "type": "path", "description": "The unique identifier for the endpoint." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Activates an endpoint version on the staging or production network. If another version of the endpoint is already active on the specified network, that version automatically deactivates and the newly activated version takes its place. If an active version of another endpoint shares any hostnames with the version you activate, the API automatically deactivates the version with conflicting hostnames, creates a new version of the impacted endpoint, migrates the non-conflicting hostnames and other A" }, { "info": { "name": "Clone a version", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/cloneVersion", "params": [ { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "The unique identifier for the endpoint version." }, { "name": "apiEndPointId", "value": "{{apiEndPointId}}", "type": "path", "description": "The unique identifier for the endpoint." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "Creates a new endpoint version as a clone of an existing version. The system assigns a new number to the version that you clone." }, { "info": { "name": "Deactivate a version", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/deactivate", "params": [ { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "The unique identifier for the endpoint version." }, { "name": "apiEndPointId", "value": "{{apiEndPointId}}", "type": "path", "description": "The unique identifier for the endpoint." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deactivates an endpoint version on the staging or production network. A deactivated endpoint version no longer serves traffic through the Akamai network." }, { "info": { "name": "Edit an endpoint from an API definition file", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/file", "params": [ { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "The unique identifier for the endpoint version." }, { "name": "apiEndPointId", "value": "{{apiEndPointId}}", "type": "path", "description": "The unique identifier for the endpoint." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Imports an API definition file with details about an endpoint. Unlike [Register an endpoint from an API definition file](https://techdocs.akamai.com/api-definitions/reference/post-endpoints-file), this operation doesn't create a new endpoint, but updates details of an existing endpoint. You can run this operation in two ways. To POST JSON data, see [Make a JSON request to edit an endpoint from an API definition file](https://techdocs.akamai.com/api-definitions/reference/endpoint-edit-json). To m" }, { "info": { "name": "Hide a version", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/hide", "params": [ { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "The unique identifier for the endpoint version." }, { "name": "apiEndPointId", "value": "{{apiEndPointId}}", "type": "path", "description": "The unique identifier for the endpoint." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "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 in the [List versions](https://techdocs.akamai.com/api-definitions/reference/get-endpoint-versions) operation's response object with the `hidden` parameter set to `true`. Running this operation affects the version listing in the API Definitions user interface." }, { "info": { "name": "Show a version", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/show", "params": [ { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "The unique identifier for the endpoint version." }, { "name": "apiEndPointId", "value": "{{apiEndPointId}}", "type": "path", "description": "The unique identifier for the endpoint." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "Reveals a hidden endpoint version. A revealed endpoint version appears in the [List versions](https://techdocs.akamai.com/api-definitions/reference/get-endpoint-versions) operation's response object with the `hidden` parameter set to `false`. Running this operation affects the version listing in the API Definitions user interface." }, { "info": { "name": "Akamai List Versions", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/ids/:edgeWorkerId/versions", "params": [ { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "View a list of EdgeWorker versions." }, { "info": { "name": "Akamai Create a New Version", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/api-definitions/v2/ids/:edgeWorkerId/versions", "params": [ { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "Create a new version of an EdgeWorker. In order to run this operation you need to build an [EdgeWorkers code bundle](https://techdocs.akamai.com/edgeworkers/docs/create-a-code-bundle) and save it in GZIP format. You need to provide the GZIP binary file in the request body, with a `Content-Type` of `application/gzip`." }, { "info": { "name": "Akamai Get Version Details", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/ids/:edgeWorkerId/versions/:version", "params": [ { "name": "version", "value": "{{version}}", "type": "path", "description": "Unique identifier for an EdgeWorker version." }, { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "View details for a specific version." }, { "info": { "name": "Akamai Delete Version", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/api-definitions/v2/ids/:edgeWorkerId/versions/:version", "params": [ { "name": "version", "value": "{{version}}", "type": "path", "description": "Unique identifier for an EdgeWorker version." }, { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "Delete a specific version." }, { "info": { "name": "Akamai Download an EdgeWorkers Code Bundle", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/ids/:edgeWorkerId/versions/:version/content", "params": [ { "name": "version", "value": "{{version}}", "type": "path", "description": "Unique identifier for an EdgeWorker version." }, { "name": "edgeWorkerId", "value": "{{edgeWorkerId}}", "type": "path", "description": "Unique identifier for an EdgeWorker." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "Download the bundle containing the code the EdgeWorker executes." } ] } ], "bundled": true }