{ "opencollection": "1.0.0", "info": { "name": "Akamai: API Endpoint Definition Access tokens Include activations API", "version": "2" }, "items": [ { "info": { "name": "Include activations", "type": "folder" }, "items": [ { "info": { "name": "Akamai List Include's Activations", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/includes/:includeId/activations", "headers": [ { "name": "PAPI-Use-Prefixes", "value": "{{PAPI-Use-Prefixes}}" } ], "params": [ { "name": "includeId", "value": "{{includeId}}", "type": "path", "description": "Unique identifier for the include. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `inc_` prefix." }, { "name": "contractId", "value": "{{contractId}}", "type": "query", "description": "Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it along with the `groupId`. In other operations that don't specify a `propertyId` URL parameter, this parameter is always required. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix." }, { "name": "groupId", "value": "{{groupId}}", "type": "query", "description": "Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along with the `contractId`. In other operations that don't specify a `propertyId` URL parameter, this parameter is always required. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix." }, { "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": "__Limited availability__ This lists all activations for all versions of an include, on both production and staging networks." }, { "info": { "name": "Akamai Activate or Deactivate an Include", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/api-definitions/v2/includes/:includeId/activations", "headers": [ { "name": "PAPI-Use-Prefixes", "value": "{{PAPI-Use-Prefixes}}" } ], "params": [ { "name": "includeId", "value": "{{includeId}}", "type": "path", "description": "Unique identifier for the include. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `inc_` prefix." }, { "name": "contractId", "value": "{{contractId}}", "type": "query", "description": "Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it along with the `groupId`. In other operations that don't specify a `propertyId` URL parameter, this parameter is always required. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix." }, { "name": "groupId", "value": "{{groupId}}", "type": "query", "description": "Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along with the `contractId`. In other operations that don't specify a `propertyId` URL parameter, this parameter is always required. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix." }, { "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": "__Limited availability__ This operation creates a new include activation, which deactivates any current activation. After a necessary delay, this activates your version's rule tree modifying how your edge content responds to end-user requests. To reduce software vulnerability, avoid calling PAPI with separate clients on the same data and frequent polling of status values, progressively increasing the delay." }, { "info": { "name": "Akamai Get an Include Activation", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/includes/:includeId/activations/:activationId", "headers": [ { "name": "PAPI-Use-Prefixes", "value": "{{PAPI-Use-Prefixes}}" } ], "params": [ { "name": "activationId", "value": "{{activationId}}", "type": "path", "description": "Unique identifier for the property or include activation." }, { "name": "includeId", "value": "{{includeId}}", "type": "path", "description": "Unique identifier for the include. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `inc_` prefix." }, { "name": "contractId", "value": "{{contractId}}", "type": "query", "description": "Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it along with the `groupId`. In other operations that don't specify a `propertyId` URL parameter, this parameter is always required. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix." }, { "name": "groupId", "value": "{{groupId}}", "type": "query", "description": "Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along with the `contractId`. In other operations that don't specify a `propertyId` URL parameter, this parameter is always required. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix." }, { "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": "__Limited availability__ Gets details about an activation. The response also shows the results of a validation against the rule trees of active parent properties that reference the include. While you can ignore any warnings that indicate non-blocking, logical inconsistencies, you need to resolve all errors to activate an include. You typically get a single activation from an `activationLink` when [launching a new activation](https://techdocs.akamai.com/property-mgr/reference/post-include-activat" }, { "info": { "name": "Akamai Cancel an Include's Pending Activation", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/api-definitions/v2/includes/:includeId/activations/:activationId", "headers": [ { "name": "PAPI-Use-Prefixes", "value": "{{PAPI-Use-Prefixes}}" } ], "params": [ { "name": "activationId", "value": "{{activationId}}", "type": "path", "description": "Unique identifier for the property or include activation." }, { "name": "includeId", "value": "{{includeId}}", "type": "path", "description": "Unique identifier for the include. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `inc_` prefix." }, { "name": "contractId", "value": "{{contractId}}", "type": "query", "description": "Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it along with the `groupId`. In other operations that don't specify a `propertyId` URL parameter, this parameter is always required. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix." }, { "name": "groupId", "value": "{{groupId}}", "type": "query", "description": "Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along with the `contractId`. In other operations that don't specify a `propertyId` URL parameter, this parameter is always required. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix." }, { "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": "__Limited availability__ If you detect a problem with an include version while its activation is still `PENDING`, use this operation to cancel it. Make a DELETE request on the `activationLink` you get from the [Activate an include](https://techdocs.akamai.com/property-mgr/reference/post-include-activation) operation's response. Once you DELETE the activation, it no longer appears in the [list of activations](https://techdocs.akamai.com/property-mgr/reference/get-include-activations), but you can" } ] } ], "bundled": true }