{ "opencollection": "1.0.0", "info": { "name": "Akamai: API Endpoint Definition API", "version": "2" }, "items": [ { "info": { "name": "Categories", "type": "folder" }, "items": [ { "info": { "name": "List categories", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/categories", "params": [ { "name": "withUsageInfo", "value": "{{withUsageInfo}}", "type": "query", "description": "Whether the response should include the `usageCount` data indicating the number of endpoints under a category, `false` by default." }, { "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": "Lists all categories available to tag endpoints and optionally indicates the number of endpoints tagged under each category." }, { "info": { "name": "Create a category", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/api-definitions/v2/categories", "params": [ { "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": "Creates a category that you can use to tag endpoints. The request's `apiCategoryName` needs to be unique per account." }, { "info": { "name": "Get a category", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/categories/:apiCategoryId", "params": [ { "name": "apiCategoryId", "value": "{{apiCategoryId}}", "type": "path", "description": "The unique identifier for the category." }, { "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 specific category that you can use to tag endpoints." }, { "info": { "name": "Edit a category", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/api-definitions/v2/categories/:apiCategoryId", "params": [ { "name": "apiCategoryId", "value": "{{apiCategoryId}}", "type": "path", "description": "The unique identifier for the category." }, { "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 a category's description or unique name." }, { "info": { "name": "Delete a category", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/api-definitions/v2/categories/:apiCategoryId", "params": [ { "name": "apiCategoryId", "value": "{{apiCategoryId}}", "type": "path", "description": "The unique identifier for the category." }, { "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 unassigned category. If you assigned the category to at least one endpoint, the operation returns a 403 error." } ] }, { "info": { "name": "Contracts and groups", "type": "folder" }, "items": [ { "info": { "name": "List contracts and groups", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/contracts/groups", "params": [ { "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": "You provision each API endpoint within the context of your contract with Akamai and a Control Center portal group. The response objects encapsulate pairings of contract and group identifiers available within the scope of the user who provisioned the API token, as described in [Get started](https://techdocs.akamai.com/api-definitions/reference/api-get-started)." }, { "info": { "name": "List hostnames", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/contracts/:contractId/groups/:groupId/hosts", "params": [ { "name": "groupId", "value": "{{groupId}}", "type": "path", "description": "The unique identifier for the group." }, { "name": "contractId", "value": "{{contractId}}", "type": "path", "description": "The unique identifier for the contract." }, { "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": "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 [PAPI](https://techdocs.akamai.com/property-mgr/reference/api)) to create new hostnames to make available to users." }, { "info": { "name": "List hostnames with access control groups", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/contracts/:contractId/groups/:groupId/hostsAcgs", "params": [ { "name": "groupId", "value": "{{groupId}}", "type": "path", "description": "The unique identifier for the group." }, { "name": "contractId", "value": "{{contractId}}", "type": "path", "description": "The unique identifier for the contract." }, { "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": "Lists all hostnames through which API consumers can access an endpoint service under a given contract and group pairing. Returns each hostname together with the access control group where the hostname is registered. You can use Property Manager (or [PAPI](https://techdocs.akamai.com/property-mgr/reference/api)) to create new hostnames to make available to users." } ] }, { "info": { "name": "Endpoints", "type": "folder" }, "items": [ { "info": { "name": "List endpoints", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/endpoints", "params": [ { "name": "piiOnly", "value": "{{piiOnly}}", "type": "query", "description": "Whether to return only endpoints with personally identifiable information (PII)." }, { "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 endpoints on each page of results, `25` by default." }, { "name": "category", "value": "{{category}}", "type": "query", "description": "Filters endpoints by the specified `apiCategoryName`, including the `__UNCATEGORIZED__` keyword." }, { "name": "contains", "value": "{{contains}}", "type": "query", "description": "The search query substring criteria matching the endpoint's name, description, `basePath`, `apiCategoryName`, and `resourcePath`." }, { "name": "sortBy", "value": "{{sortBy}}", "type": "query", "description": "__Enum__ The field to sort endpoints by, either the API `name` (corresponding to the `apiEndPointName` member) or `updateDate`." }, { "name": "sortOrder", "value": "{{sortOrder}}", "type": "query", "description": "__Enum__ The sort order, either `desc` for descending or the default `asc` for ascending." }, { "name": "versionPreference", "value": "{{versionPreference}}", "type": "query", "description": "__Enum__ The preference for selecting the endpoint version to return. By default the API returns the `LAST_UPDATED` version. If you set the preference to `ACTIVATED_FIRST`, the API first attempts to return the version currently active on the production network. If such version doesn't exist, the API attempts to return the version currently active on the staging network. If both of these checks fail, the API returns the last updated version." }, { "name": "show", "value": "{{show}}", "type": "query", "description": "__Enum__ The type of endpoints to return based on their visibility status. By default the API returns `ALL` endpoints. You can instead decide to return `ONLY_VISIBLE` endpoints, or `ONLY_HIDDEN` endpoints. Run the [Show an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-show) and [Hide an endpoint](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-hide) operations to control which endpoints are listed." }, { "name": "contractId", "value": "{{contractId}}", "type": "query", "description": "Filters endpoints to a specific contract. You need to specify this along with a `groupId`." }, { "name": "groupId", "value": "{{groupId}}", "type": "query", "description": "Filters endpoints to a specific group. You need to specify this along with a `contractId`." }, { "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": "Lists the available API endpoints, with results optionally paginated, sorted, and filtered. If no endpoints are available, the operation responds with an empty array." }, { "info": { "name": "Register an endpoint", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/api-definitions/v2/endpoints", "params": [ { "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": "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 either by modifying the endpoint object, or separately with the [Create a resource](https://techdocs.akamai.com/api-definitions/reference/post-resource) operation. The endpoint's name needs to be unique within an account." }, { "info": { "name": "Clone an endpoint", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/api-definitions/v2/endpoints/cloneEndpoint", "params": [ { "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": "Creates an endpoint as a clone from the specified source endpoint ID and version." }, { "info": { "name": "Register an endpoint from an API definition file", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/api-definitions/v2/endpoints/files", "params": [ { "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 and creates a new endpoint based on the file contents. You can run this operation in two ways. To POST JSON data, see [Make a JSON request to register an endpoint from an API definition file](https://techdocs.akamai.com/api-definitions/reference/endpoint-request-json). To make a form request using these parameters, see [Make a form request to register an endpoint from an API definition file](https://techdocs.akamai.com/api-definitions/reference/endpoint-request-for" }, { "info": { "name": "List user entitlements", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/endpoints/user-entitlements", "params": [ { "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": "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 operations to modify data. See [Get started](https://techdocs.akamai.com/api-definitions/reference/api-get-started) for details on setting up the API client with the appropriate level of access. This operation's array values include `API_READ` for read-only access, `API_WRITE` for modifying the existing endpoint versions, `API_VERSIONING` for v" }, { "info": { "name": "Verify secure connection", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/api-definitions/v2/endpoints/verify-secure-connection", "params": [ { "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": "Verifies that provided hostnames are signed with a provided certificate chain. This ensures that edge servers can connect to the hostnames securely. The response is a map of hostnames to connection status values. For the list of available connection status values and their descriptions, see Connection status values. You can use the response information when setting up JWKS in the [Edit JWT settings](https://techdocs.akamai.com/api-definitions/reference/put-jwt-settings) operation." }, { "info": { "name": "Delete an endpoint", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId", "params": [ { "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 configuration from API Gateway if none of the endpoint's versions are active or pending activation on the staging or production network." }, { "info": { "name": "Hide an endpoint", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/hide", "params": [ { "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 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 delete versions of a hidden endpoint. A hidden endpoint appears in the [List endpoints](https://techdocs.akamai.com/api-definitions/reference/get-endpoints) operation's response object by default, or when you set the operation's `show` query parameter to `ONLY_HIDDEN`. Running this operation affects the endpoint listing in the API Definitions u" }, { "info": { "name": "Show an endpoint", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/show", "params": [ { "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 and all its versions. A revealed endpoint appears in the [List endpoints](https://techdocs.akamai.com/api-definitions/reference/get-endpoints) operation's response object by default, or when you set the operation's `show` query parameter to `ONLY_VISIBLE`. Running this operation affects the endpoint listing in the API Definitions user interface." } ] }, { "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": "Personally identifiable information", "type": "folder" }, "items": [ { "info": { "name": "List parameters with PII for an endpoint version", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/piis", "params": [ { "name": "apiEndPointId", "value": "{{apiEndPointId}}", "type": "path", "description": "The unique identifier for the endpoint." }, { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "The unique identifier for the endpoint version." }, { "name": "status", "value": "{{status}}", "type": "query", "description": "__Enum__ The status of an instance of personally identifiable information (PII) discovered on the network. See [PII status](https://techdocs.akamai.com/api-definitions/reference/personally-identifiable-information-status)." }, { "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 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 discovers on your behalf. You can return this information for both active and inactive endpoint versions. All operations for PII are per endpoint version. Run [Enable PII learning settings for a configuration](https://techdocs.akamai.com/application-security/reference/put-advanced-settings-pii-learning) to use this feature." }, { "info": { "name": "Add or update a user-created PII instance", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/piis/parameters/:paramId", "params": [ { "name": "apiEndPointId", "value": "{{apiEndPointId}}", "type": "path", "description": "The unique identifier for the endpoint." }, { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "The unique identifier for the endpoint version." }, { "name": "paramId", "value": "{{paramId}}", "type": "path", "description": "The unique identifier for a parameter." }, { "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": "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 you." }, { "info": { "name": "List PII settings for an endpoint version", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/piis/settings", "params": [ { "name": "apiEndPointId", "value": "{{apiEndPointId}}", "type": "path", "description": "The unique identifier for the endpoint." }, { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "The unique identifier for the endpoint version." }, { "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 the PII settings in an endpoint version, including the inspection scope and constraints, and how you want the network to handle PII." }, { "info": { "name": "Modify PII settings for an endpoint version", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/piis/settings", "params": [ { "name": "apiEndPointId", "value": "{{apiEndPointId}}", "type": "path", "description": "The unique identifier for the endpoint." }, { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "The unique identifier for the endpoint version." }, { "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": "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 versions, you'll need to run the operation for each version. n as well as parameters with PII the network discovers on your behalf. You can return this information for both active and inactive endpoint versions. All operations for PII are per endpoint version. Run [Enable PII learning settings for a configuration](https://techdocs.akamai.co" }, { "info": { "name": "Modify PII status per endpoint version", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/piis/status", "params": [ { "name": "apiEndPointId", "value": "{{apiEndPointId}}", "type": "path", "description": "The unique identifier for the endpoint." }, { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "The unique identifier for the endpoint version." }, { "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": "Update the PII status. This operation applies to PII found by the network and not PII you add to your API definition yourself." }, { "info": { "name": "Delete PII in an endpoint version", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/piis/:piiId", "params": [ { "name": "apiEndPointId", "value": "{{apiEndPointId}}", "type": "path", "description": "The unique identifier for the endpoint." }, { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "The unique identifier for the endpoint version." }, { "name": "piiId", "value": "{{piiId}}", "type": "path", "description": "The unique identifier for the PII object." }, { "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 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 exists, you'll need to make this request for each version of the endpoint." }, { "info": { "name": "Patch PII status per endpoint version", "type": "http" }, "http": { "method": "PATCH", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/piis/:piiId/status", "params": [ { "name": "apiEndPointId", "value": "{{apiEndPointId}}", "type": "path", "description": "The unique identifier for the endpoint." }, { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "The unique identifier for the endpoint version." }, { "name": "piiId", "value": "{{piiId}}", "type": "path", "description": "The unique identifier for the PII object." }, { "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": "Update the PII status. This operation applies to PII found by the network and not PII you add to your API definition yourself." } ] }, { "info": { "name": "Resources", "type": "folder" }, "items": [ { "info": { "name": "List resources", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/resources", "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": "Lists all resources assigned to an endpoint version. You can use the `apiResourceId` of each returned resource to modify resources individually through the [Edit a resource](https://techdocs.akamai.com/api-definitions/reference/put-version-resource) operation, or run the [Edit a version](https://techdocs.akamai.com/api-definitions/reference/put-endpoint-version) operation to batch-modify a group of resources." }, { "info": { "name": "Create a resource", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/resources", "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": "Creates a resource in an endpoint version. The resource's full URL (concatenated hostname, `basePath`, and `resourcepath`) needs to be unique within the account. You can only create resources for versions that have never been activated on the staging or production network." }, { "info": { "name": "Get a version", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/resources-detail", "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 an endpoint version. Use this operation's response object when modifying an endpoint version through [Edit a version](https://techdocs.akamai.com/api-definitions/reference/put-endpoint-version). Don't use [Get a version summary](https://techdocs.akamai.com/api-definitions/reference/get-endpoint-version) for the [Edit a version](https://techdocs.akamai.com/api-definitions/reference/put-endpoint-version) operation." }, { "info": { "name": "Get a resource", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/resources/:apiResourceId", "params": [ { "name": "apiResourceId", "value": "{{apiResourceId}}", "type": "path", "description": "The unique identifier for the resource." }, { "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 resource within an endpoint version." }, { "info": { "name": "Edit a resource", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/resources/:apiResourceId", "params": [ { "name": "apiResourceId", "value": "{{apiResourceId}}", "type": "path", "description": "The unique identifier for the resource." }, { "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 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 modify resources assigned to versions that have never been activated on the staging or production network." }, { "info": { "name": "Delete a resource", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/resources/:apiResourceId", "params": [ { "name": "apiResourceId", "value": "{{apiResourceId}}", "type": "path", "description": "The unique identifier for the resource." }, { "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 a resource from an endpoint version. You can only remove resources assigned to versions that have never been activated on the staging or production network." } ] }, { "info": { "name": "API privacy", "type": "folder" }, "items": [ { "info": { "name": "Get API privacy settings", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/settings/api-privacy", "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 the API privacy settings configured for an endpoint version and its assigned resources." }, { "info": { "name": "Edit API privacy settings", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/settings/api-privacy", "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 the API privacy settings configured for an endpoint version and its assigned resources." } ] }, { "info": { "name": "Cache", "type": "folder" }, "items": [ { "info": { "name": "Get cache settings", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/settings/cache", "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 the caching settings configured for an endpoint version and its assigned resources." }, { "info": { "name": "Edit cache settings", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/settings/cache", "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 the caching settings configured for an endpoint version and its assigned resources." } ] }, { "info": { "name": "CORS", "type": "folder" }, "items": [ { "info": { "name": "Get CORS settings", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/settings/cors", "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 the cross-origin resource sharing (CORS) settings configured for an endpoint version." }, { "info": { "name": "Edit CORS settings", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/settings/cors", "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 the cross-origin resource sharing (CORS) settings configured for an endpoint version." } ] }, { "info": { "name": "Error responses", "type": "folder" }, "items": [ { "info": { "name": "Get error response settings", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/settings/error-responses", "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 the error response settings configured for an endpoint version." }, { "info": { "name": "Edit error response settings", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/settings/error-responses", "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 the error response settings configured for an endpoint version." }, { "info": { "name": "Get an error response", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/settings/error-responses/:type", "params": [ { "name": "type", "value": "{{type}}", "type": "path", "description": "__Enum__ The type of the customizable error response." }, { "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 customizable error response of the selected type." }, { "info": { "name": "Edit an error response", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/settings/error-responses/:type", "params": [ { "name": "type", "value": "{{type}}", "type": "path", "description": "__Enum__ The type of the customizable error response." }, { "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 a customizable error response of the selected type." } ] }, { "info": { "name": "GraphQL", "type": "folder" }, "items": [ { "info": { "name": "Get GraphQL cache settings", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/settings/graphql", "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 the GraphQL caching settings configured for an endpoint version." }, { "info": { "name": "Edit GraphQL cache settings", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/settings/graphql", "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 the GraphQL caching settings configured for an endpoint version." } ] }, { "info": { "name": "GZIP", "type": "folder" }, "items": [ { "info": { "name": "Get GZIP settings", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/settings/gzip", "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 the GZIP compression settings configured for an endpoint version." }, { "info": { "name": "Edit GZIP settings", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/settings/gzip", "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 the GZIP compression settings configured for an endpoint version." } ] }, { "info": { "name": "JWT", "type": "folder" }, "items": [ { "info": { "name": "Get JWT settings", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/settings/jwt", "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 the JWT validation settings configured for an endpoint version and its assigned resources." }, { "info": { "name": "Edit JWT settings", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/settings/jwt", "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 the JWT validation settings configured for an endpoint version and its assigned resources." } ] }, { "info": { "name": "Routing", "type": "folder" }, "items": [ { "info": { "name": "Get routing settings", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/settings/routing", "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 the incoming request's routing, forwarding, and SureRoute settings configured for an endpoint version. You can run this operation if you're taking part in the API Gateway beta program." }, { "info": { "name": "Edit routing settings", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/settings/routing", "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 the incoming request's routing, forwarding, and SureRoute settings configured for an endpoint version. You can run this operation if you're taking part in the API Gateway beta program." } ] } ], "bundled": true }