{ "opencollection": "1.0.0", "info": { "name": "Akamai: API Endpoint Definition Access tokens Changes API", "version": "2" }, "items": [ { "info": { "name": "Changes", "type": "folder" }, "items": [ { "info": { "name": "Get change status", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/enrollments/:enrollmentId/changes/:changeId", "params": [ { "name": "changeId", "value": "{{changeId}}", "type": "path", "description": "The change for this enrollment on which to perform the desired operation." }, { "name": "enrollmentId", "value": "{{enrollmentId}}", "type": "path", "description": "Enrollment on which to perform the desired operation." }, { "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": "Gets the status of a pending change." }, { "info": { "name": "Cancel a change", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/api-definitions/v2/enrollments/:enrollmentId/changes/:changeId", "params": [ { "name": "changeId", "value": "{{changeId}}", "type": "path", "description": "The change for this enrollment on which to perform the desired operation." }, { "name": "enrollmentId", "value": "{{enrollmentId}}", "type": "path", "description": "Enrollment on which to perform the desired operation." }, { "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": "Cancels a pending change." }, { "info": { "name": "Get a deployment schedule", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/enrollments/:enrollmentId/changes/:changeId/deployment-schedule", "params": [ { "name": "changeId", "value": "{{changeId}}", "type": "path", "description": "The change for this enrollment on which to perform the desired operation." }, { "name": "enrollmentId", "value": "{{enrollmentId}}", "type": "path", "description": "Enrollment on which to perform the desired operation." }, { "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": "Gets the current deployment schedule settings describing when a change deploys to the network." }, { "info": { "name": "Get a change", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/enrollments/:enrollmentId/changes/:changeId/input/info/:allowedInputTypeParam", "headers": [ { "name": "Accept", "value": "{{Accept}}" } ], "params": [ { "name": "allowedInputTypeParam", "value": "{{allowedInputTypeParam}}", "type": "path", "description": "__Enum__ Found as the last part of `Change.allowedInput[].update` hypermedia URL. See [Change Input Content Type Mapping](https://techdocs.akamai.com/cps/reference/change-input-content-type-mapping) for details. Currently supported values include `change-management-info`, `lets-encrypt-challenges`, `post-verification-warnings`, `pre-verification-warnings`, `third-party-csr`." }, { "name": "changeId", "value": "{{changeId}}", "type": "path", "description": "The change for this enrollment on which to perform the desired operation." }, { "name": "enrollmentId", "value": "{{enrollmentId}}", "type": "path", "description": "Enrollment on which to perform the desired operation." }, { "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": "Get detailed information of a pending change. Below is a sample where `allowedInput[].type` has the value `third-party-csr`. The acceptable `Accept` header depends on the value of the `allowedInput.type` for the Change instance. See [Change Input Content Type Mapping](https://techdocs.akamai.com/cps/reference/change-input-content-type-mapping) for details." }, { "info": { "name": "Update a change", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/api-definitions/v2/enrollments/:enrollmentId/changes/:changeId/input/update/:allowedInputTypeParam", "headers": [ { "name": "Content-Type", "value": "{{Content-Type}}" }, { "name": "Accept", "value": "{{Accept}}" } ], "params": [ { "name": "allowedInputTypeParam", "value": "{{allowedInputTypeParam}}", "type": "path", "description": "__Enum__ Found as the last part of `Change.allowedInput[].update` hypermedia URL. See [Change Input Content Type Mapping](https://techdocs.akamai.com/cps/reference/change-input-content-type-mapping) for details. Currently supported values include `change-management-ack`, `lets-encrypt-challenges-completed`, `post-verification-warnings-ack`, `pre-verification-warnings-ack`, `third-party-cert-and-trust-chain`." }, { "name": "changeId", "value": "{{changeId}}", "type": "path", "description": "The change for this enrollment on which to perform the desired operation." }, { "name": "enrollmentId", "value": "{{enrollmentId}}", "type": "path", "description": "Enrollment on which to perform the desired operation." }, { "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 pending change. Below is a sample where `allowedInput[].type` has the value `third-party-cert-and-trust-chain`. The acceptable `Content-Type` and `Accept` headers depends on the value of the `allowedInput.type` for the Change instance. See [Change Input Content Type Mapping](https://techdocs.akamai.com/cps/reference/change-input-content-type-mapping) for details." }, { "info": { "name": "Get change history", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/enrollments/:enrollmentId/history/changes", "params": [ { "name": "enrollmentId", "value": "{{enrollmentId}}", "type": "path", "description": "Enrollment on which to perform the desired operation." }, { "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": "Change history of an enrollment." } ] } ], "bundled": true }