openapi: 3.0.0 info: title: 'Akamai: API Endpoint Definition Access tokens Custom behaviors 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: Custom behaviors paths: /custom-behaviors: x-akamai: file-path: paths/custom-behaviors.yaml path-for-file: /custom-behaviors x-akamai-descriptor-tools: displayName: customBehaviors group: CustomBehaviors get: description: Lists the set of custom XML metadata behaviors configured for you by Akamai representatives. Referencing the relevant `behaviorId` from a [`customBehavior`](https://techdocs.akamai.com/property-mgr/reference/latest-custom-behavior) within the rule tree injects the custom XML within the rest of the rule tree's metadata XML. See [Custom behaviors and overrides](https://techdocs.akamai.com/property-mgr/reference/custom-behaviors-and-overrides) for guidance on custom overrides. operationId: get-custom-behaviors summary: Akamai List Custom Behaviors tags: - Custom behaviors externalDocs: description: See documentation for this operation in Akamai's Property Manager API url: https://techdocs.akamai.com/property-mgr/reference/get-custom-behaviors responses: '200': description: The response lists custom behaviors. content: application/json: example: accountId: act_A-CCT3456 customBehaviors: items: - behaviorId: cbe_12345 description: Setting custom download receipt. Uses PMUSER_LOG variable. displayName: Custom Download Receipt name: DLR status: ACTIVE updatedByUser: afero updatedDate: '2017-04-24T12:34:56Z' 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/GetCustomBehaviorResponse.json# type: object properties: accountId: description: The account under which this custom behavior is available. minLength: 1 type: string customBehaviors: additionalProperties: false description: The set of requested custom behaviors, available within an `items` array. type: object properties: items: description: Represents a customized XML metadata Akamai sets up on your behalf. You can invoke it in a [`customBehavior`](https://techdocs.akamai.com/property-mgr/reference/latest-custom-behavior) within a rule tree. Relevant response objects appear within the outer envelope's `customBehaviors.items` array. See [Custom behaviors and overrides](https://techdocs.akamai.com/property-mgr/reference/custom-behaviors-and-overrides) for guidance. type: array items: additionalProperties: false type: object required: - behaviorId - description - displayName - name - status - updatedByUser - updatedDate properties: behaviorId: description: The unique identifier for the custom XML metadata that you reference from a [`customBehavior`](https://techdocs.akamai.com/property-mgr/reference/latest-custom-behavior) to insert it in a rule tree. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `cbe_` prefix. type: string description: description: Descriptive text for the custom metadata. type: string displayName: description: A display label for the custom metadata. type: string name: description: A name for the custom metadata. type: string status: description: Current deployment status for the custom metadata. By the time it's available to customers, the only possible value is `ACTIVE`. type: string enum: - ACTIVE updatedByUser: description: The name of the Akamai representative who last updated the custom metadata. type: string updatedDate: description: The date stamp of the custom metadata's latest update. type: string xml: description: The customized XML metadata to inject within the rule. type: string x-akamai: file-path: schemas/custom-behavior-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: 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 /custom-behaviors/{behaviorId}: x-akamai: file-path: paths/custom-behavior.yaml path-for-file: /custom-behaviors/{behaviorId} x-akamai-descriptor-tools: displayName: customBehavior group: CustomBehaviors parameters: - description: Unique identifier for the custom behavior. example: '{{behaviorId}}' in: path name: behaviorId required: true schema: example: cbe_12345 type: string x-akamai: file-path: parameters/behaviorId-path.yaml get: description: Get information for a single custom behavior. Use this operation if you want to examine the custom behavior's XML metadata source. operationId: get-custom-behavior summary: Akamai Get a Custom Behavior tags: - Custom behaviors externalDocs: description: See documentation for this operation in Akamai's Property Manager API url: https://techdocs.akamai.com/property-mgr/reference/get-custom-behavior responses: '200': description: The response shows the specified custom behavior. content: application/json: example: accountId: act_A-CCT7890 customBehaviors: items: - behaviorId: cbe_12345 description: Setting custom download receipt. Uses PMUSER_LOG variable. displayName: Custom Download Receipt name: DLR status: ACTIVE updatedByUser: adevi updatedDate: '2017-04-24T12:34:56Z' xml: logs.customer.com/dlroffon443stuff=%(PMUSER_LOG)&time=%t&url=%uPOST 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/GetCustomBehaviorResponse.json# type: object properties: accountId: description: The account under which this custom behavior is available. minLength: 1 type: string customBehaviors: additionalProperties: false description: The set of requested custom behaviors, available within an `items` array. type: object properties: items: description: Represents a customized XML metadata Akamai sets up on your behalf. You can invoke it in a [`customBehavior`](https://techdocs.akamai.com/property-mgr/reference/latest-custom-behavior) within a rule tree. Relevant response objects appear within the outer envelope's `customBehaviors.items` array. See [Custom behaviors and overrides](https://techdocs.akamai.com/property-mgr/reference/custom-behaviors-and-overrides) for guidance. type: array items: additionalProperties: false type: object required: - behaviorId - description - displayName - name - status - updatedByUser - updatedDate properties: behaviorId: description: The unique identifier for the custom XML metadata that you reference from a [`customBehavior`](https://techdocs.akamai.com/property-mgr/reference/latest-custom-behavior) to insert it in a rule tree. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `cbe_` prefix. type: string description: description: Descriptive text for the custom metadata. type: string displayName: description: A display label for the custom metadata. type: string name: description: A name for the custom metadata. type: string status: description: Current deployment status for the custom metadata. By the time it's available to customers, the only possible value is `ACTIVE`. type: string enum: - ACTIVE updatedByUser: description: The name of the Akamai representative who last updated the custom metadata. type: string updatedDate: description: The date stamp of the custom metadata's latest update. type: string xml: description: The customized XML metadata to inject within the rule. type: string x-akamai: file-path: schemas/custom-behavior-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: 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