openapi: 3.0.0 info: title: 'Akamai: API Endpoint Definition Access tokens Property activations API' version: '2' license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html servers: - url: https://{hostname}/api-definitions/v2 tags: - name: Property activations paths: /properties/{propertyId}/activations: x-akamai: file-path: paths/property-activations.yaml path-for-file: /properties/{propertyId}/activations x-akamai-descriptor-tools: displayName: propertyActivations group: Property activations parameters: - description: Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `prp_` prefix. example: '{{propertyId}}' in: path name: propertyId required: true schema: example: prp_12345 type: string x-akamai: file-path: parameters/propertyId-path.yaml post: description: 'This operation creates a new property activation, which deactivates any currently active version. After a necessary delay, this activates your property version''s rule tree and set of hostnames across Akamai''s network of edge servers, 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. If there''s a problem with the property you activated, you may have the option to fall back to the previous version. To build the request object, go to the `activationLink` from the activation''s response and note down the `fallbackVersion` value. Within an hour of activating, POST another activation with `propertyVersion` set to the version you noted down and `useFastFallback` set to `true`. This disables the current activation and falls back to the specified version. A fallback takes a few seconds, but the option is available only if there have been no changes to the set of property hostnames, as indicated by `canFastFallback`.' operationId: post-property-activations summary: Akamai Activate or Deactivate a Property tags: - Property activations externalDocs: description: See documentation for this operation in Akamai's Property Manager API url: https://techdocs.akamai.com/property-mgr/reference/post-property-activations requestBody: required: true content: application/json: example: network: STAGING note: Sample activation propertyVersion: 1 useFastFallback: false acknowledgeWarnings: - msg_baa4560881774a45b5fd25f5b1eab021d7c40b4f notifyEmails: - you@example.com - them@example.com schema: $schema: http://json-schema.org/draft-04-schema# description: Activates property versions on a specific network. Relevant response objects appear within the outer envelope's `activations.items` array. id: resource:/descriptors/papi/v1/schemas/CreateNewActivationOrDeactivationRequestV0.json# javaType: com.akamai.luna.papi.model.PropertyActivationRequest type: object required: - propertyVersion - network - notifyEmails properties: acknowledgeAllWarnings: default: false description: When POSTing an activation, you can skip acknowledging each warning. With this enabled, you can omit the `acknowledgeWarnings` array. example: '{{acknowledgeAllWarnings}}' type: boolean acknowledgeWarnings: description: String IDs prefixed with `msg_` to acknowledge any warnings noted in responses to previous activation requests. type: array items: type: string activationType: default: ACTIVATE description: Either `ACTIVATE` or `DEACTIVATE`. The default is `ACTIVATE`. Any new activation automatically deactivates the current activation. Note that if you were to POST a `DEACTIVATE` type on an active property, it would no longer serve any traffic. You'd need to modify your DNS configuration and specify a different way to field the traffic. example: '{{activationType}}' type: string enum: - ACTIVATE - DEACTIVATE delayValidations: description: This makes the operation respond with an `activationLink` more quickly. Some time-consuming validations ordinarily result in a direct error response. Enabling this delays them so that any errors appear later once you [Get a property activation](https://techdocs.akamai.com/property-mgr/reference/get-property-activation). In that case, the activation's `status` is `FAILED`. example: '{{delayValidations}}' nullable: true type: boolean fastPush: default: true description: Enable a fast metadata push when activating a new property, `true` by default. example: '{{fastPush}}' type: boolean ignoreHttpErrors: default: true description: Ignore any HTTP errors when pushing fast metadata activation, `true` by default. example: '{{ignoreHttpErrors}}' type: boolean network: description: The network to activate on, either `STAGING` or `PRODUCTION`. example: '{{network}}' type: string enum: - STAGING - PRODUCTION note: description: A descriptive log comment. example: '{{note}}' type: string notifyEmails: description: Email addresses to notify when the activation status changes. minItems: 1 type: array items: type: string propertyVersion: description: The version of the property to activate. example: '{{propertyVersion}}' minimum: 1 type: integer useFastFallback: default: false description: After activating a property and finding it causes problems, POSTing another activation within one hour with `useFastFallback` enabled quickly rolls back to the previous version. This option is only available for activations where `canFastFallback` is `true`. example: '{{useFastFallback}}' type: boolean x-akamai: file-path: schemas/property-activation-create-request.yaml responses: '201': description: The response provides a URL link to the newly created activation. content: application/json: example: activationLink: /papi/v0/properties/prp_173136/activations/atv_67037?contractId=ctr_C-0N7RAC7&groupId=grp_15225 schema: $schema: http://json-schema.org/draft-04-schema# additionalProperties: false description: Provides a hypermedia link to a newly created resource. The response's single member name indicates the type of resource. id: resource:/descriptors/papi/v1/schemas/PostPropertyActivationResponse.json# type: object required: - activationLink properties: activationLink: description: Links the new activation. type: string x-akamai: file-path: schemas/property-activation-post-response.yaml headers: Location: description: Provides a URL path you can GET the newly created resource from. schema: type: string x-akamai: file-path: headers/Location.yaml '400': description: '[Bad request](https://techdocs.akamai.com/property-mgr/reference/400).' content: application/problem+json: example: detail: The system cannot understand your request. Please check the syntax and correct any problems. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 400 title: Bad Request type: https://problems.luna.akamaiapis.net/papi/v0/http/bad-request schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/400.yaml '401': description: '[Unauthorized](https://techdocs.akamai.com/property-mgr/reference/401).' content: application/problem+json: example: detail: The request requires authentication. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 401 title: Unauthorized type: https://problems.luna.akamaiapis.net/papi/v0/http/unauthorized schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/401.yaml '403': description: '[Forbidden](https://techdocs.akamai.com/property-mgr/reference/403).' content: application/problem+json: example: detail: The authorization token you provided does not allow access to this resource. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 403 title: Forbidden type: https://problems.luna.akamaiapis.net/papi/v1/http/forbidden schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/403.yaml '404': description: '[Not found](https://techdocs.akamai.com/property-mgr/reference/404).' content: application/problem+json: example: detail: The system was unable to locate the requested resource. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 404 title: Not Found type: https://problems.luna.akamaiapis.net/papi/v1/http/not-found schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/404.yaml '405': description: '[Method not allowed](https://techdocs.akamai.com/property-mgr/reference/405).' content: application/problem+json: example: detail: The system does not support the method you provided for this resource. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 405 title: Method not allowed type: https://problems.luna.akamaiapis.net/papi/v1/http/method-not-allowed schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/405.yaml '406': description: '[Not acceptable](https://techdocs.akamai.com/property-mgr/reference/406).' content: application/problem+json: example: detail: The system does not support the content-type restrictions provided by your 'Accept' header. instance: papi/v1/build#abc12345abcc02a7 status: 406 title: Not Acceptable type: https://problems.luna.akamaiapis.net/papi/v1/http/not-acceptable schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/406.yaml '409': description: '[Conflict](https://techdocs.akamai.com/property-mgr/reference/409).' content: application/problem+json: example: detail: Another edit or activation request on same network in progress for this property version. instance: papi/v1/properties/prp_123456/activations?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 409 title: Operation failed type: https://problems.luna.akamaiapis.net/papi/v1/resource-busy schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/409.yaml '415': description: '[Unsupported media type](https://techdocs.akamai.com/property-mgr/reference/415).' content: application/problem+json: example: detail: Our system does not support requests in the format you're sending. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 415 title: Unsupported Media Type type: https://problems.luna.akamaiapis.net/papi/v1/http/unsupported-media-type schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/415.yaml '422': description: '[Unprocessable content](https://techdocs.akamai.com/property-mgr/reference/422).' content: application/problem+json: example: instance: papi/v1/activations/#abc12345abcc02a7 messageId: property_activation_still_pending result: ERROR status: 422 title: Property Manager Exception type: https://problems.luna.akamaiapis.net/papi/v1/property_activation_still_pending params: - Property 123456 - Version 1 details: {} errors: - detail: property_activation_still_pending title: Property Manager Exception type: papi/v1/property_activation_still_pending schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - instance - status - errors - details - messageId - params - result properties: details: description: Diagnostic instructions to locate and fix the problem. type: object errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string messageId: description: Summarizes the cause of the problem. minLength: 1 type: string params: description: Details of the property and version where the problem occured. minItems: 0 type: array items: type: string result: description: Indicates the severity of the problem. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-422.yaml x-akamai: file-path: errors/422.yaml '429': description: '[Too many requests](https://techdocs.akamai.com/property-mgr/reference/429).' content: application/problem+json: example: detail: Too many includes exist on contract ctr_1-12345. You must delete an include before continuing. instance: /papi/v1/includes?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 instanceKey: 1-12345 limit: 500 limitKey: INCLUDES_PER_CONTRACT remaining: 0 status: 429 title: Too many includes type: https://problems.luna.akamaiapis.net/papi/v1/limit-exceeded schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance - limitKey - instanceKey - limit - remaining properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string instanceKey: description: Identifies the resource the limit is imposed on. minLength: 1 type: string limit: description: The overall limit. type: integer limitKey: description: The limit that got exceeded with the operation. minLength: 1 type: string remaining: description: Number of items left to deploy. type: integer status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-429.yaml x-akamai: file-path: errors/429.yaml '500': description: '[Internal server error](https://techdocs.akamai.com/property-mgr/reference/500).' content: application/problem+json: example: detail: Our system is experiencing errors. We''ll get this fixed as soon as possible. instance: /papi/v1/properties/12345/activations#abc12345abcc02a7 status: 500 title: Internal Server Error type: https://problems.luna.akamaiapis.net/papi/proxy/internal-server-error schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/500.yaml parameters: - description: __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to `false` when exchanging PAPI data with other APIs. example: '{{PAPI-Use-Prefixes}}' in: header name: PAPI-Use-Prefixes required: true schema: example: 'false' type: string enum: - 'true' - 'false' x-akamai: file-path: parameters/PAPI-Use-Prefixes-header.yaml - 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. example: '{{contractId}}' in: query name: contractId required: false schema: example: ctr_1-1TJZFW type: string x-akamai: file-path: parameters/contractId-optional.yaml - 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. example: '{{groupId}}' in: query name: groupId required: false schema: example: grp_15166 type: string x-akamai: file-path: parameters/groupId-optional.yaml - 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). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string get: description: This lists all activations for all versions of a property, on both production and staging networks. operationId: get-property-activations summary: Akamai List Property's Activations tags: - Property activations externalDocs: description: See documentation for this operation in Akamai's Property Manager API url: https://techdocs.akamai.com/property-mgr/reference/get-property-activations responses: '200': description: The response lists all activations for the requested property. content: application/json: example: accountId: act_A-CCT3456 contractId: ctr_K-0N7RAK71 groupId: grp_15225 activations: items: - activationId: atv_1696985 activationType: ACTIVATE fmaActivationState: steady network: STAGING note: Sample activation propertyId: prp_173136 propertyName: example.com propertyVersion: 1 status: PENDING submitDate: '2014-03-02T02:22:12Z' updateDate: '2014-03-01T21:12:57Z' notifyEmails: - you@example.com - them@example.com fallbackInfo: canFastFallback: true fallbackVersion: 10 fastFallbackAttempted: false fastFallbackExpirationTime: 1506451772 fastFallbackRecoveryState: null steadyStateTime: 1506448172 schema: $schema: http://json-schema.org/draft-04/schema# additionalProperties: false description: A common outer wrapping object structure. It provides additional contextual details for a set of requested data. The data itself is available under various inner members' `items` array. id: resource:/descriptors/papi/v1/schemas/GetActivationResponse.json# type: object properties: accountId: description: Identifies the prevailing account under which you requested the data. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `act_` prefix. minLength: 1 type: string activations: additionalProperties: false description: The set of requested activations, available within an `items` array. type: object properties: items: description: Activated property versions on a specific network. Relevant response objects appear within the outer envelope's `activations.items` array. type: array items: additionalProperties: false type: object required: - activationId - activationType - network - note - notifyEmails - propertyId - propertyName - status - submitDate - updateDate properties: accountId: description: Identifies the account under which the property activated. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `act_` prefix. type: string activationId: description: The activation's unique identifier. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `atv_` prefix. type: string activationType: description: Either `ACTIVATE` or `DEACTIVATE`. The default is `ACTIVATE`. Any new activation automatically deactivates the current activation. Note that if you were to POST a `DEACTIVATE` type on an active property, it would no longer serve any traffic. You'd need to modify your DNS configuration and specify a different way to field the traffic. type: string enum: - ACTIVATE - DEACTIVATE failureCause: description: If the activation's `status` is `FAILED`, this HTTP problem object describes the reason for the failure. This only appears when activating with `delayValidations` enabled. type: object fallbackInfo: additionalProperties: false description: Encapsulates information about fast fallback. You can use it to fall back to a previous activation when POSTing an activation with `useFastFallback` enabled. type: object required: - canFastFallback - fallbackVersion - fastFallbackAttempted - fastFallbackExpirationTime - fastFallbackRecoveryState - steadyStateTime properties: canFastFallback: description: Whether the current activation can fallback to a previous version. This is typically `false` for new properties, or for property versions whose set of hostnames has changed. type: boolean fallbackVersion: description: Indicates the property version that activates when a fast fallback succeeds. minimum: 1 type: integer fastFallbackAttempted: description: Whether a fast fallback has already been attempted on this activation. type: boolean fastFallbackExpirationTime: description: Epoch second timestamp marking when fast fallback is no longer possible for this activation. type: integer fastFallbackRecoveryState: description: Represents additional information available for any attempted fallback. nullable: true type: - string - 'null' propertyVersion: description: The version for which fast fallback may be available. minimum: 1 type: integer steadyStateTime: description: Epoch second timestamp marking when the activation completed, signaled by an `fmaActivationState` of `steady`. type: integer fmaActivationState: description: Indicates fast metadata activation state. A value of `steady` indicates the property is currently active or has been cancelled. Values of `received`, `lived`, and `deployed` represent progressive stages of activation, while `cancelling` happens either after failing a network safety check or in response to a [DELETE operation](https://techdocs.akamai.com/property-mgr/reference/delete-property-activation). Note that the `status` member indicates whether the activation is live. type: string enum: - steady - received - lived - deployed - cancelling groupId: description: Identifies the group under which the property activated. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `grp_` prefix. type: string network: description: The network to activate on, either `STAGING` or `PRODUCTION`. type: string enum: - STAGING - PRODUCTION note: description: Assigns a log message to the activation request. type: string notifyEmails: description: Email addresses to notify when the activation status changes. minItems: 0 type: array items: type: string propertyId: description: Identifies property targeted with activation. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `prp_` prefix. Don't use this value if you want to exchange data with the Identity and Access Manager API. See [Manage properties and includes](https://techdocs.akamai.com/iam-api/reference/manage-access-to-properties-and-includes). type: string propertyName: description: The name of the property targeted with activation. type: string propertyVersion: description: The property version targeted with activation. Once activated, you can no longer modify that version of the property. minimum: 1 type: integer status: description: The activation's status. `ACTIVE` if currently serving traffic. `INACTIVE` if another activation has superseded this one. `NEW`, `PENDING`, `ZONE_1`, `ZONE_2`, or `ZONE_3` if not yet active. `ABORTED` if the client followed up with a [DELETE request](https://techdocs.akamai.com/property-mgr/reference/delete-property-activation) in time. `FAILED` if the activation causes a range of edge network errors that [may cause a fallback to the previous activation](https://techdocs.akamai.com/property-mgr/reference/property-activation-error-handling). `PENDING_DEACTIVATION` or `DEACTIVATED` when the `activationType` is `DEACTIVATE` to no longer serve traffic. type: string enum: - ACTIVE - INACTIVE - PENDING - ZONE_1 - ZONE_2 - ZONE_3 - ABORTED - FAILED - DEACTIVATED - PENDING_DEACTIVATION - NEW submitDate: description: A date stamp marking when the activation initiated. type: string updateDate: description: A date stamp marking when the `status` last changed. type: string contractId: description: Identifies the prevailing contract under which you requested the data. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `ctr_` prefix. minLength: 1 type: string groupId: description: Identifies the prevailing group under which you requested the data. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `grp_` prefix. minLength: 1 type: string x-akamai: file-path: schemas/property-activation-get-response.yaml '400': description: '[Bad request](https://techdocs.akamai.com/property-mgr/reference/400).' content: application/problem+json: example: detail: The system cannot understand your request. Please check the syntax and correct any problems. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 400 title: Bad Request type: https://problems.luna.akamaiapis.net/papi/v0/http/bad-request schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/400.yaml '401': description: '[Unauthorized](https://techdocs.akamai.com/property-mgr/reference/401).' content: application/problem+json: example: detail: The request requires authentication. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 401 title: Unauthorized type: https://problems.luna.akamaiapis.net/papi/v0/http/unauthorized schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/401.yaml '403': description: '[Forbidden](https://techdocs.akamai.com/property-mgr/reference/403).' content: application/problem+json: example: detail: The authorization token you provided does not allow access to this resource. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 403 title: Forbidden type: https://problems.luna.akamaiapis.net/papi/v1/http/forbidden schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/403.yaml '404': description: '[Not found](https://techdocs.akamai.com/property-mgr/reference/404).' content: application/problem+json: example: detail: The system was unable to locate the requested resource. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 404 title: Not Found type: https://problems.luna.akamaiapis.net/papi/v1/http/not-found schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/404.yaml '405': description: '[Method not allowed](https://techdocs.akamai.com/property-mgr/reference/405).' content: application/problem+json: example: detail: The system does not support the method you provided for this resource. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 405 title: Method not allowed type: https://problems.luna.akamaiapis.net/papi/v1/http/method-not-allowed schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/405.yaml '406': description: '[Not acceptable](https://techdocs.akamai.com/property-mgr/reference/406).' content: application/problem+json: example: detail: The system does not support the content-type restrictions provided by your 'Accept' header. instance: papi/v1/build#abc12345abcc02a7 status: 406 title: Not Acceptable type: https://problems.luna.akamaiapis.net/papi/v1/http/not-acceptable schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/406.yaml '429': description: '[Too many requests](https://techdocs.akamai.com/property-mgr/reference/429).' content: application/problem+json: example: detail: Too many includes exist on contract ctr_1-12345. You must delete an include before continuing. instance: /papi/v1/includes?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 instanceKey: 1-12345 limit: 500 limitKey: INCLUDES_PER_CONTRACT remaining: 0 status: 429 title: Too many includes type: https://problems.luna.akamaiapis.net/papi/v1/limit-exceeded schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance - limitKey - instanceKey - limit - remaining properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string instanceKey: description: Identifies the resource the limit is imposed on. minLength: 1 type: string limit: description: The overall limit. type: integer limitKey: description: The limit that got exceeded with the operation. minLength: 1 type: string remaining: description: Number of items left to deploy. type: integer status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-429.yaml x-akamai: file-path: errors/429.yaml '500': description: '[Internal server error](https://techdocs.akamai.com/property-mgr/reference/500).' content: application/problem+json: example: detail: Our system is experiencing errors. We''ll get this fixed as soon as possible. instance: /papi/v1/properties/12345/activations#abc12345abcc02a7 status: 500 title: Internal Server Error type: https://problems.luna.akamaiapis.net/papi/proxy/internal-server-error schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/500.yaml parameters: - description: __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to `false` when exchanging PAPI data with other APIs. example: '{{PAPI-Use-Prefixes}}' in: header name: PAPI-Use-Prefixes required: true schema: example: 'false' type: string enum: - 'true' - 'false' x-akamai: file-path: parameters/PAPI-Use-Prefixes-header.yaml - 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. example: '{{contractId}}' in: query name: contractId required: false schema: example: ctr_1-1TJZFW type: string x-akamai: file-path: parameters/contractId-optional.yaml - 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. example: '{{groupId}}' in: query name: groupId required: false schema: example: grp_15166 type: string x-akamai: file-path: parameters/groupId-optional.yaml - 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). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string /properties/{propertyId}/activations/{activationId}: x-akamai: file-path: paths/property-activation.yaml path-for-file: /properties/{propertyId}/activations/{activationId} x-akamai-descriptor-tools: displayName: propertyActivation group: Property activations parameters: - description: Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `prp_` prefix. example: '{{propertyId}}' in: path name: propertyId required: true schema: example: prp_12345 type: string x-akamai: file-path: parameters/propertyId-path.yaml - description: Unique identifier for the property or include activation. example: '{{activationId}}' in: path name: activationId required: true schema: example: atv_1696855 type: string x-akamai: file-path: parameters/activationId-path.yaml get: description: Gets details about an activation. You typically get a single activation from an `activationLink` when [launching a new activation](https://techdocs.akamai.com/property-mgr/reference/post-property-activations) and following up to poll its `status`. For activations whose `status` is `PENDING`, a `Retry-After` header provides an estimate for when it's likely to change. operationId: get-property-activation summary: Akamai Get a Property Activation tags: - Property activations externalDocs: description: See documentation for this operation in Akamai's Property Manager API url: https://techdocs.akamai.com/property-mgr/reference/get-property-activation responses: '200': description: The response shows the property activation details. content: application/json: example: accountId: act_A-CCT9012 contractId: ctr_C-0N7RAC7 groupId: grp_15225 activations: items: - activationId: atv_1696985 activationType: ACTIVATE fmaActivationState: steady network: STAGING note: Sample activation propertyId: prp_173136 propertyName: example.com propertyVersion: 1 status: PENDING submitDate: '2014-03-02T02:22:12Z' updateDate: '2014-03-01T21:12:57Z' notifyEmails: - you@example.com - them@example.com fallbackInfo: canFastFallback: true fallbackVersion: 10 fastFallbackAttempted: false fastFallbackExpirationTime: 1506451772 fastFallbackRecoveryState: null steadyStateTime: 1506448172 schema: $schema: http://json-schema.org/draft-04/schema# additionalProperties: false description: A common outer wrapping object structure. It provides additional contextual details for a set of requested data. The data itself is available under various inner members' `items` array. id: resource:/descriptors/papi/v1/schemas/GetActivationResponse.json# type: object properties: accountId: description: Identifies the prevailing account under which you requested the data. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `act_` prefix. minLength: 1 type: string activations: additionalProperties: false description: The set of requested activations, available within an `items` array. type: object properties: items: description: Activated property versions on a specific network. Relevant response objects appear within the outer envelope's `activations.items` array. type: array items: additionalProperties: false type: object required: - activationId - activationType - network - note - notifyEmails - propertyId - propertyName - status - submitDate - updateDate properties: accountId: description: Identifies the account under which the property activated. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `act_` prefix. type: string activationId: description: The activation's unique identifier. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `atv_` prefix. type: string activationType: description: Either `ACTIVATE` or `DEACTIVATE`. The default is `ACTIVATE`. Any new activation automatically deactivates the current activation. Note that if you were to POST a `DEACTIVATE` type on an active property, it would no longer serve any traffic. You'd need to modify your DNS configuration and specify a different way to field the traffic. type: string enum: - ACTIVATE - DEACTIVATE failureCause: description: If the activation's `status` is `FAILED`, this HTTP problem object describes the reason for the failure. This only appears when activating with `delayValidations` enabled. type: object fallbackInfo: additionalProperties: false description: Encapsulates information about fast fallback. You can use it to fall back to a previous activation when POSTing an activation with `useFastFallback` enabled. type: object required: - canFastFallback - fallbackVersion - fastFallbackAttempted - fastFallbackExpirationTime - fastFallbackRecoveryState - steadyStateTime properties: canFastFallback: description: Whether the current activation can fallback to a previous version. This is typically `false` for new properties, or for property versions whose set of hostnames has changed. type: boolean fallbackVersion: description: Indicates the property version that activates when a fast fallback succeeds. minimum: 1 type: integer fastFallbackAttempted: description: Whether a fast fallback has already been attempted on this activation. type: boolean fastFallbackExpirationTime: description: Epoch second timestamp marking when fast fallback is no longer possible for this activation. type: integer fastFallbackRecoveryState: description: Represents additional information available for any attempted fallback. nullable: true type: - string - 'null' propertyVersion: description: The version for which fast fallback may be available. minimum: 1 type: integer steadyStateTime: description: Epoch second timestamp marking when the activation completed, signaled by an `fmaActivationState` of `steady`. type: integer fmaActivationState: description: Indicates fast metadata activation state. A value of `steady` indicates the property is currently active or has been cancelled. Values of `received`, `lived`, and `deployed` represent progressive stages of activation, while `cancelling` happens either after failing a network safety check or in response to a [DELETE operation](https://techdocs.akamai.com/property-mgr/reference/delete-property-activation). Note that the `status` member indicates whether the activation is live. type: string enum: - steady - received - lived - deployed - cancelling groupId: description: Identifies the group under which the property activated. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `grp_` prefix. type: string network: description: The network to activate on, either `STAGING` or `PRODUCTION`. type: string enum: - STAGING - PRODUCTION note: description: Assigns a log message to the activation request. type: string notifyEmails: description: Email addresses to notify when the activation status changes. minItems: 0 type: array items: type: string propertyId: description: Identifies property targeted with activation. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `prp_` prefix. Don't use this value if you want to exchange data with the Identity and Access Manager API. See [Manage properties and includes](https://techdocs.akamai.com/iam-api/reference/manage-access-to-properties-and-includes). type: string propertyName: description: The name of the property targeted with activation. type: string propertyVersion: description: The property version targeted with activation. Once activated, you can no longer modify that version of the property. minimum: 1 type: integer status: description: The activation's status. `ACTIVE` if currently serving traffic. `INACTIVE` if another activation has superseded this one. `NEW`, `PENDING`, `ZONE_1`, `ZONE_2`, or `ZONE_3` if not yet active. `ABORTED` if the client followed up with a [DELETE request](https://techdocs.akamai.com/property-mgr/reference/delete-property-activation) in time. `FAILED` if the activation causes a range of edge network errors that [may cause a fallback to the previous activation](https://techdocs.akamai.com/property-mgr/reference/property-activation-error-handling). `PENDING_DEACTIVATION` or `DEACTIVATED` when the `activationType` is `DEACTIVATE` to no longer serve traffic. type: string enum: - ACTIVE - INACTIVE - PENDING - ZONE_1 - ZONE_2 - ZONE_3 - ABORTED - FAILED - DEACTIVATED - PENDING_DEACTIVATION - NEW submitDate: description: A date stamp marking when the activation initiated. type: string updateDate: description: A date stamp marking when the `status` last changed. type: string contractId: description: Identifies the prevailing contract under which you requested the data. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `ctr_` prefix. minLength: 1 type: string groupId: description: Identifies the prevailing group under which you requested the data. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `grp_` prefix. minLength: 1 type: string x-akamai: file-path: schemas/property-activation-get-response.yaml headers: Retry-After: description: For activations whose `status` remains `PENDING`, this specifies the number of seconds it will likely take to go live. schema: type: string x-akamai: file-path: headers/Retry-After.yaml '400': description: '[Bad request](https://techdocs.akamai.com/property-mgr/reference/400).' content: application/problem+json: example: detail: The system cannot understand your request. Please check the syntax and correct any problems. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 400 title: Bad Request type: https://problems.luna.akamaiapis.net/papi/v0/http/bad-request schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/400.yaml '401': description: '[Unauthorized](https://techdocs.akamai.com/property-mgr/reference/401).' content: application/problem+json: example: detail: The request requires authentication. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 401 title: Unauthorized type: https://problems.luna.akamaiapis.net/papi/v0/http/unauthorized schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/401.yaml '403': description: '[Forbidden](https://techdocs.akamai.com/property-mgr/reference/403).' content: application/problem+json: example: detail: The authorization token you provided does not allow access to this resource. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 403 title: Forbidden type: https://problems.luna.akamaiapis.net/papi/v1/http/forbidden schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/403.yaml '404': description: '[Not found](https://techdocs.akamai.com/property-mgr/reference/404).' content: application/problem+json: example: detail: The system was unable to locate the requested resource. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 404 title: Not Found type: https://problems.luna.akamaiapis.net/papi/v1/http/not-found schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/404.yaml '405': description: '[Method not allowed](https://techdocs.akamai.com/property-mgr/reference/405).' content: application/problem+json: example: detail: The system does not support the method you provided for this resource. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 405 title: Method not allowed type: https://problems.luna.akamaiapis.net/papi/v1/http/method-not-allowed schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/405.yaml '406': description: '[Not acceptable](https://techdocs.akamai.com/property-mgr/reference/406).' content: application/problem+json: example: detail: The system does not support the content-type restrictions provided by your 'Accept' header. instance: papi/v1/build#abc12345abcc02a7 status: 406 title: Not Acceptable type: https://problems.luna.akamaiapis.net/papi/v1/http/not-acceptable schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/406.yaml '429': description: '[Too many requests](https://techdocs.akamai.com/property-mgr/reference/429).' content: application/problem+json: example: detail: Too many includes exist on contract ctr_1-12345. You must delete an include before continuing. instance: /papi/v1/includes?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 instanceKey: 1-12345 limit: 500 limitKey: INCLUDES_PER_CONTRACT remaining: 0 status: 429 title: Too many includes type: https://problems.luna.akamaiapis.net/papi/v1/limit-exceeded schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance - limitKey - instanceKey - limit - remaining properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string instanceKey: description: Identifies the resource the limit is imposed on. minLength: 1 type: string limit: description: The overall limit. type: integer limitKey: description: The limit that got exceeded with the operation. minLength: 1 type: string remaining: description: Number of items left to deploy. type: integer status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-429.yaml x-akamai: file-path: errors/429.yaml '500': description: '[Internal server error](https://techdocs.akamai.com/property-mgr/reference/500).' content: application/problem+json: example: detail: Our system is experiencing errors. We''ll get this fixed as soon as possible. instance: /papi/v1/properties/12345/activations#abc12345abcc02a7 status: 500 title: Internal Server Error type: https://problems.luna.akamaiapis.net/papi/proxy/internal-server-error schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/500.yaml parameters: - description: __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to `false` when exchanging PAPI data with other APIs. example: '{{PAPI-Use-Prefixes}}' in: header name: PAPI-Use-Prefixes required: true schema: example: 'false' type: string enum: - 'true' - 'false' x-akamai: file-path: parameters/PAPI-Use-Prefixes-header.yaml - 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. example: '{{contractId}}' in: query name: contractId required: false schema: example: ctr_1-1TJZFW type: string x-akamai: file-path: parameters/contractId-optional.yaml - 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. example: '{{groupId}}' in: query name: groupId required: false schema: example: grp_15166 type: string x-akamai: file-path: parameters/groupId-optional.yaml - 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). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string delete: description: If you detect a problem with a property 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 a property](https://techdocs.akamai.com/property-mgr/reference/post-property-activations) 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-property-activations), but you can still [access it individually](https://techdocs.akamai.com/property-mgr/reference/get-property-activation). If there are unexpected problems with an activation that goes live before you're able to cancel it, you often have a one-hour window to quickly fall back to a previous activation. See [Activate or deactivate a property](https://techdocs.akamai.com/property-mgr/reference/post-property-activations) for details. operationId: delete-property-activation summary: Akamai Cancel a Property's Pending Activation tags: - Property activations externalDocs: description: See documentation for this operation in Akamai's Property Manager API url: https://techdocs.akamai.com/property-mgr/reference/delete-property-activation responses: '200': description: The response shows details for the cancelled property activation. content: application/json: example: activations: items: - accountId: act_A-CCT5678 activationId: atv_1696985 activationType: ACTIVATE groupId: grp_15225 network: STAGING note: Sample activation cancellation propertyId: prp_173136 propertyName: example.com propertyVersion: 1 status: ABORTED submitDate: '2014-03-02T02:22:12Z' updateDate: '2014-03-01T21:12:57Z' notifyEmails: - you@example.com - them@example.com schema: $schema: http://json-schema.org/draft-04/schema# additionalProperties: false description: A common outer wrapping object structure. It provides additional contextual details for a set of requested data. The data itself is available under various inner members' `items` array. id: resource:/descriptors/papi/v1/schemas/GetActivationResponse.json# type: object properties: accountId: description: Identifies the prevailing account under which you requested the data. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `act_` prefix. minLength: 1 type: string activations: additionalProperties: false description: The set of requested activations, available within an `items` array. type: object properties: items: description: Activated property versions on a specific network. Relevant response objects appear within the outer envelope's `activations.items` array. type: array items: additionalProperties: false type: object required: - activationId - activationType - network - note - notifyEmails - propertyId - propertyName - status - submitDate - updateDate properties: accountId: description: Identifies the account under which the property activated. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `act_` prefix. type: string activationId: description: The activation's unique identifier. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `atv_` prefix. type: string activationType: description: Either `ACTIVATE` or `DEACTIVATE`. The default is `ACTIVATE`. Any new activation automatically deactivates the current activation. Note that if you were to POST a `DEACTIVATE` type on an active property, it would no longer serve any traffic. You'd need to modify your DNS configuration and specify a different way to field the traffic. type: string enum: - ACTIVATE - DEACTIVATE failureCause: description: If the activation's `status` is `FAILED`, this HTTP problem object describes the reason for the failure. This only appears when activating with `delayValidations` enabled. type: object fallbackInfo: additionalProperties: false description: Encapsulates information about fast fallback. You can use it to fall back to a previous activation when POSTing an activation with `useFastFallback` enabled. type: object required: - canFastFallback - fallbackVersion - fastFallbackAttempted - fastFallbackExpirationTime - fastFallbackRecoveryState - steadyStateTime properties: canFastFallback: description: Whether the current activation can fallback to a previous version. This is typically `false` for new properties, or for property versions whose set of hostnames has changed. type: boolean fallbackVersion: description: Indicates the property version that activates when a fast fallback succeeds. minimum: 1 type: integer fastFallbackAttempted: description: Whether a fast fallback has already been attempted on this activation. type: boolean fastFallbackExpirationTime: description: Epoch second timestamp marking when fast fallback is no longer possible for this activation. type: integer fastFallbackRecoveryState: description: Represents additional information available for any attempted fallback. nullable: true type: - string - 'null' propertyVersion: description: The version for which fast fallback may be available. minimum: 1 type: integer steadyStateTime: description: Epoch second timestamp marking when the activation completed, signaled by an `fmaActivationState` of `steady`. type: integer fmaActivationState: description: Indicates fast metadata activation state. A value of `steady` indicates the property is currently active or has been cancelled. Values of `received`, `lived`, and `deployed` represent progressive stages of activation, while `cancelling` happens either after failing a network safety check or in response to a [DELETE operation](https://techdocs.akamai.com/property-mgr/reference/delete-property-activation). Note that the `status` member indicates whether the activation is live. type: string enum: - steady - received - lived - deployed - cancelling groupId: description: Identifies the group under which the property activated. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `grp_` prefix. type: string network: description: The network to activate on, either `STAGING` or `PRODUCTION`. type: string enum: - STAGING - PRODUCTION note: description: Assigns a log message to the activation request. type: string notifyEmails: description: Email addresses to notify when the activation status changes. minItems: 0 type: array items: type: string propertyId: description: Identifies property targeted with activation. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `prp_` prefix. Don't use this value if you want to exchange data with the Identity and Access Manager API. See [Manage properties and includes](https://techdocs.akamai.com/iam-api/reference/manage-access-to-properties-and-includes). type: string propertyName: description: The name of the property targeted with activation. type: string propertyVersion: description: The property version targeted with activation. Once activated, you can no longer modify that version of the property. minimum: 1 type: integer status: description: The activation's status. `ACTIVE` if currently serving traffic. `INACTIVE` if another activation has superseded this one. `NEW`, `PENDING`, `ZONE_1`, `ZONE_2`, or `ZONE_3` if not yet active. `ABORTED` if the client followed up with a [DELETE request](https://techdocs.akamai.com/property-mgr/reference/delete-property-activation) in time. `FAILED` if the activation causes a range of edge network errors that [may cause a fallback to the previous activation](https://techdocs.akamai.com/property-mgr/reference/property-activation-error-handling). `PENDING_DEACTIVATION` or `DEACTIVATED` when the `activationType` is `DEACTIVATE` to no longer serve traffic. type: string enum: - ACTIVE - INACTIVE - PENDING - ZONE_1 - ZONE_2 - ZONE_3 - ABORTED - FAILED - DEACTIVATED - PENDING_DEACTIVATION - NEW submitDate: description: A date stamp marking when the activation initiated. type: string updateDate: description: A date stamp marking when the `status` last changed. type: string contractId: description: Identifies the prevailing contract under which you requested the data. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `ctr_` prefix. minLength: 1 type: string groupId: description: Identifies the prevailing group under which you requested the data. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `grp_` prefix. minLength: 1 type: string x-akamai: file-path: schemas/property-activation-get-response.yaml '400': description: '[Bad request](https://techdocs.akamai.com/property-mgr/reference/400).' content: application/problem+json: example: detail: The system cannot understand your request. Please check the syntax and correct any problems. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 400 title: Bad Request type: https://problems.luna.akamaiapis.net/papi/v0/http/bad-request schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/400.yaml '401': description: '[Unauthorized](https://techdocs.akamai.com/property-mgr/reference/401).' content: application/problem+json: example: detail: The request requires authentication. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 401 title: Unauthorized type: https://problems.luna.akamaiapis.net/papi/v0/http/unauthorized schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/401.yaml '403': description: '[Forbidden](https://techdocs.akamai.com/property-mgr/reference/403).' content: application/problem+json: example: detail: The authorization token you provided does not allow access to this resource. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 403 title: Forbidden type: https://problems.luna.akamaiapis.net/papi/v1/http/forbidden schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/403.yaml '404': description: '[Not found](https://techdocs.akamai.com/property-mgr/reference/404).' content: application/problem+json: example: detail: The system was unable to locate the requested resource. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 404 title: Not Found type: https://problems.luna.akamaiapis.net/papi/v1/http/not-found schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/404.yaml '405': description: '[Method not allowed](https://techdocs.akamai.com/property-mgr/reference/405).' content: application/problem+json: example: detail: The system does not support the method you provided for this resource. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 405 title: Method not allowed type: https://problems.luna.akamaiapis.net/papi/v1/http/method-not-allowed schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/405.yaml '406': description: '[Not acceptable](https://techdocs.akamai.com/property-mgr/reference/406).' content: application/problem+json: example: detail: The system does not support the content-type restrictions provided by your 'Accept' header. instance: papi/v1/build#abc12345abcc02a7 status: 406 title: Not Acceptable type: https://problems.luna.akamaiapis.net/papi/v1/http/not-acceptable schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/406.yaml '409': description: '[Conflict](https://techdocs.akamai.com/property-mgr/reference/409).' content: application/problem+json: example: detail: Another edit or activation request on same network in progress for this property version. instance: papi/v1/properties/prp_123456/activations?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 409 title: Operation failed type: https://problems.luna.akamaiapis.net/papi/v1/resource-busy schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/409.yaml '422': description: '[Unprocessable content](https://techdocs.akamai.com/property-mgr/reference/422).' content: application/problem+json: example: instance: papi/v1/activations/#abc12345abcc02a7 messageId: property_activation_still_pending result: ERROR status: 422 title: Property Manager Exception type: https://problems.luna.akamaiapis.net/papi/v1/property_activation_still_pending params: - Property 123456 - Version 1 details: {} errors: - detail: property_activation_still_pending title: Property Manager Exception type: papi/v1/property_activation_still_pending schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - instance - status - errors - details - messageId - params - result properties: details: description: Diagnostic instructions to locate and fix the problem. type: object errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string messageId: description: Summarizes the cause of the problem. minLength: 1 type: string params: description: Details of the property and version where the problem occured. minItems: 0 type: array items: type: string result: description: Indicates the severity of the problem. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-422.yaml x-akamai: file-path: errors/422.yaml '429': description: '[Too many requests](https://techdocs.akamai.com/property-mgr/reference/429).' content: application/problem+json: example: detail: Too many includes exist on contract ctr_1-12345. You must delete an include before continuing. instance: /papi/v1/includes?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 instanceKey: 1-12345 limit: 500 limitKey: INCLUDES_PER_CONTRACT remaining: 0 status: 429 title: Too many includes type: https://problems.luna.akamaiapis.net/papi/v1/limit-exceeded schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance - limitKey - instanceKey - limit - remaining properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string instanceKey: description: Identifies the resource the limit is imposed on. minLength: 1 type: string limit: description: The overall limit. type: integer limitKey: description: The limit that got exceeded with the operation. minLength: 1 type: string remaining: description: Number of items left to deploy. type: integer status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-429.yaml x-akamai: file-path: errors/429.yaml '500': description: '[Internal server error](https://techdocs.akamai.com/property-mgr/reference/500).' content: application/problem+json: example: detail: Our system is experiencing errors. We''ll get this fixed as soon as possible. instance: /papi/v1/properties/12345/activations#abc12345abcc02a7 status: 500 title: Internal Server Error type: https://problems.luna.akamaiapis.net/papi/proxy/internal-server-error schema: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - status - detail - instance properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string errors: description: For errors with more than one detected problem, this represents each as a nested Problem Details object. minItems: 0 type: array uniqueItems: true items: additionalProperties: false description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format. type: object required: - type - title - detail properties: detail: description: Diagnostic instructions to locate and fix the problem. minLength: 1 type: string instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem-nested.yaml instance: description: Unique value generated with each API call. minLength: 1 type: string status: description: The HTTP status code that categorizes this error case. maximum: 600 minimum: 100 type: integer title: description: A summary of each error case. minLength: 1 type: string type: description: Identifies each error case. format: uri type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/500.yaml parameters: - description: __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to `false` when exchanging PAPI data with other APIs. example: '{{PAPI-Use-Prefixes}}' in: header name: PAPI-Use-Prefixes required: true schema: example: 'false' type: string enum: - 'true' - 'false' x-akamai: file-path: parameters/PAPI-Use-Prefixes-header.yaml - 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. example: '{{contractId}}' in: query name: contractId required: false schema: example: ctr_1-1TJZFW type: string x-akamai: file-path: parameters/contractId-optional.yaml - 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. example: '{{groupId}}' in: query name: groupId required: false schema: example: grp_15166 type: string x-akamai: file-path: parameters/groupId-optional.yaml - 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). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string externalDocs: description: See documentation for Akamai's API Endpoint Definition API url: https://techdocs.akamai.com/api-definitions/reference x-readme: samples-languages: - curl - python - node