openapi: 3.0.0 info: title: 'Akamai: API Endpoint Definition Access tokens CP codes 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: CP codes paths: /cpcodes: x-akamai: file-path: paths/cpcodes.yaml path-for-file: /cpcodes x-akamai-descriptor-tools: displayName: cpCodes group: CpCodes get: description: Lists detailed information about CP codes available within your account and contract. operationId: get-cpcodes summary: List CP codes tags: - CP codes externalDocs: description: See documentation for this operation in Akamai's CP Codes and Reporting Groups API url: https://techdocs.akamai.com/cp-codes/reference/get-cpcodes responses: '200': description: Lists details of CP codes available for a specified account and contract. content: application/json: example: cpcodes: - accountId: A-CCT9012 cpcodeId: 1234567 cpcodeName: Digital Company CP Code defaultTimezone: GMT 0 (Greenwich Mean Time) purgeable: true type: Regular accessGroup: contractId: C-0N7RAC7 groupId: 15225 overrideTimezone: timezoneId: '0' timezoneValue: GMT 0 (Greenwich Mean Time) contracts: - contractId: K-0N7RAK71 status: ongoing products: - productId: AdvSite::Reporter productName: Monitor site advance - accountId: A-CCT9012 cpcodeId: 1234567 cpcodeName: Internet Company CP Code defaultTimezone: GMT 0 (Greenwich Mean Time) purgeable: true type: Regular accessGroup: contractId: K-0N7RAK71 groupId: 15225 overrideTimezone: timezoneId: '0' timezoneValue: GMT 0 (Greenwich Mean Time) contracts: - contractId: C-0N7RAC71 status: ongoing products: - productId: Dev::Cloud productName: Cloud development CD schema: additionalProperties: false description: Provides details about the CP codes available for your contract. type: object required: - cpcodes properties: cpcodes: description: A collection of CP codes available for your contract. minItems: 0 type: array items: additionalProperties: false description: Provides detailed information about a CP code. type: object required: - cpcodeId - cpcodeName - contracts - products properties: accessGroup: additionalProperties: false description: A group that controls access to specific CP codes. type: object required: - contractId - groupId properties: contractId: description: 'Identifies the contract assigned to the access control group. Get and store this ID from your account using the [Contracts API](https://techdocs.akamai.com/contract-api/reference/get-contract-ids). **Note**: See [ID prefixes](https://techdocs.akamai.com/cp-codes/reference/id-prefixes) for guidance on comparing this value with data from PAPI.' minLength: 1 type: string groupId: description: 'Identifies the access control group. Reporting groups may belong to many groups. If that happens, this member''s value is `null`. **Note**: See [ID prefixes](https://techdocs.akamai.com/cp-codes/reference/id-prefixes) for guidance on comparing this value with data from PAPI.' minimum: 0 nullable: true type: integer x-akamai: file-path: schemas/access-group.yaml accountId: description: 'Identifies an account assigned to the CP code. **Note**: See [ID prefixes](https://techdocs.akamai.com/cp-codes/reference/id-prefixes) for guidance on comparing this value with data from PAPI.' minLength: 1 type: string contracts: description: Provides detailed information about the contracts assigned to the CP code. minItems: 0 readOnly: true type: array items: additionalProperties: false description: Specifies details of a single contract. type: object required: - contractId properties: contractId: description: 'Identifies the contract. **Note**: See [ID prefixes](https://techdocs.akamai.com/cp-codes/reference/id-prefixes) for guidance on comparing this value with data from PAPI.' minLength: 1 readOnly: true type: string status: description: The status of a contract. minLength: 1 readOnly: true type: string x-akamai: file-path: schemas/contracts-status-array.yaml cpcodeId: description: 'Identifies the CP code. **Note**: See [ID prefixes](https://techdocs.akamai.com/cp-codes/reference/id-prefixes) for guidance on comparing this value with data from PAPI.' minimum: 1 type: integer cpcodeName: description: The descriptive label for the CP code. minLength: 1 type: string defaultTimezone: description: The default GMT time zone assigned to the CP code. minLength: 1 type: string overrideTimezone: additionalProperties: false description: The GMT time zone that overrides the default time zone assigned to the CP code. Only a few legacy reports override the default time zone for the time axis. Most reports, and all new ones, use the user's own time zone for the time axis. type: object required: - timezoneId properties: timezoneId: description: Identifies the GMT time zone. minLength: 1 type: string timezoneValue: description: The offset value for the GMT time zone. minLength: 1 type: string x-akamai: file-path: schemas/override-timezone.yaml products: description: A collection of products and services assigned to the CP code. minItems: 0 type: array items: additionalProperties: false description: Specifies details of a single product. type: object required: - productId properties: productId: description: 'Identifies a product or service. **Note**: See [ID prefixes](https://techdocs.akamai.com/cp-codes/reference/id-prefixes) for guidance on comparing this value with data from PAPI.' minLength: 1 type: string productName: description: The descriptive label for a product or service. minLength: 1 type: string x-akamai: file-path: schemas/products-array.yaml purgeable: description: Whether you can purge the content cached by the CP code. type: boolean type: description: Whether the CP code supports serving traffic from `China`, or `Regular` traffic elsewhere. type: string enum: - Regular - China x-akamai: file-path: schemas/cpcode-200.yaml x-akamai: file-path: schemas/cpcodes-200.yaml '400': description: '[Bad request](https://techdocs.akamai.com/cp-codes/reference/400).' content: application/problem+json: example: code: bad.request incidentId: dc2f405e-29d3-4845-a4ac-2f6b4a732aca title: Bad Request details: - code: invalid.data message: Group name is mandatory schema: additionalProperties: true description: Provides detailed information about a failed request. type: object required: - title - code - details - incidentId properties: code: description: A descriptive code that corresponds to overall HTTP status. minLength: 1 type: string details: additionalProperties: true description: Each array member object encodes context for the failed request. For example, malformed query parameter field values. type: object required: - code - message properties: code: description: A descriptive identifier for each problem. minLength: 1 type: string data: description: A loosely structured object that, when available, encapsulates the set of erroneous input values. type: object message: description: A description of the problem. minLength: 1 type: string incidentId: description: A logging key useful when communicating about problems with Technical Support representatives. minLength: 1 type: string title: description: A descriptive title that labels each error case. minLength: 1 type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/400.yaml '401': description: '[Unauthorized](https://techdocs.akamai.com/cp-codes/reference/401).' content: application/problem+json: example: code: unauthorized incidentId: dc2f405e-29d3-4845-a4ac-2f6b4a732aca title: Unauthorized details: - code: invalid.data message: The request requires authentication schema: additionalProperties: true description: Provides detailed information about a failed request. type: object required: - title - code - details - incidentId properties: code: description: A descriptive code that corresponds to overall HTTP status. minLength: 1 type: string details: additionalProperties: true description: Each array member object encodes context for the failed request. For example, malformed query parameter field values. type: object required: - code - message properties: code: description: A descriptive identifier for each problem. minLength: 1 type: string data: description: A loosely structured object that, when available, encapsulates the set of erroneous input values. type: object message: description: A description of the problem. minLength: 1 type: string incidentId: description: A logging key useful when communicating about problems with Technical Support representatives. minLength: 1 type: string title: description: A descriptive title that labels each error case. minLength: 1 type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/401.yaml '403': description: '[Forbidden](https://techdocs.akamai.com/cp-codes/reference/403).' content: application/problem+json: example: code: forbidden incidentId: dc2f405e-29d3-4845-a4ac-2f6b4a732aca title: Forbidden details: - code: invalid.role message: User is not authorized schema: additionalProperties: true description: Provides detailed information about a failed request. type: object required: - title - code - details - incidentId properties: code: description: A descriptive code that corresponds to overall HTTP status. minLength: 1 type: string details: additionalProperties: true description: Each array member object encodes context for the failed request. For example, malformed query parameter field values. type: object required: - code - message properties: code: description: A descriptive identifier for each problem. minLength: 1 type: string data: description: A loosely structured object that, when available, encapsulates the set of erroneous input values. type: object message: description: A description of the problem. minLength: 1 type: string incidentId: description: A logging key useful when communicating about problems with Technical Support representatives. minLength: 1 type: string title: description: A descriptive title that labels each error case. minLength: 1 type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/403.yaml '404': description: '[Not found](https://techdocs.akamai.com/cp-codes/reference/404).' content: application/problem+json: example: code: not.found incidentId: dc2f405e-29d3-4845-a4ac-2f6b4a732aca title: Not Found details: - code: invalid.data message: The reporting group with id 000 is already deleted schema: additionalProperties: true description: Provides detailed information about a failed request. type: object required: - title - code - details - incidentId properties: code: description: A descriptive code that corresponds to overall HTTP status. minLength: 1 type: string details: additionalProperties: true description: Each array member object encodes context for the failed request. For example, malformed query parameter field values. type: object required: - code - message properties: code: description: A descriptive identifier for each problem. minLength: 1 type: string data: description: A loosely structured object that, when available, encapsulates the set of erroneous input values. type: object message: description: A description of the problem. minLength: 1 type: string incidentId: description: A logging key useful when communicating about problems with Technical Support representatives. minLength: 1 type: string title: description: A descriptive title that labels each error case. minLength: 1 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/cp-codes/reference/405).' content: application/problem+json: example: code: method.not.allowed incidentId: 3714936a-07a6-4991-939f-c201adbf35f3 title: Method Not Allowed details: - code: method.not.supported message: method.not.supported schema: additionalProperties: true description: Provides detailed information about a failed request. type: object required: - title - code - details - incidentId properties: code: description: A descriptive code that corresponds to overall HTTP status. minLength: 1 type: string details: additionalProperties: true description: Each array member object encodes context for the failed request. For example, malformed query parameter field values. type: object required: - code - message properties: code: description: A descriptive identifier for each problem. minLength: 1 type: string data: description: A loosely structured object that, when available, encapsulates the set of erroneous input values. type: object message: description: A description of the problem. minLength: 1 type: string incidentId: description: A logging key useful when communicating about problems with Technical Support representatives. minLength: 1 type: string title: description: A descriptive title that labels each error case. minLength: 1 type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/405.yaml parameters: - description: Identifies the contract to filter data by. Include this optional parameter to narrow down the results to a specific contract only. example: '{{contractId}}' in: query name: contractId schema: example: 1Q004 type: string x-akamai: file-path: parameters/contractId-query.yaml - description: Identifies the access group to filter data by. Include this optional parameter to narrow down the results to a specific access group only. example: '{{groupId}}' in: query name: groupId schema: example: '9760' type: string x-akamai: file-path: parameters/groupId-query.yaml - description: Identifies the product or service to filter data by. Include this optional parameter to narrow down the results to a specific product only. example: '{{productId}}' in: query name: productId schema: example: prd_Web_App_Accel type: string x-akamai: file-path: parameters/productId-query.yaml - description: The name of the CP code to filter data by. Include this optional parameter to narrow down the results to a specific CP code name only. example: '{{cpcodeName}}' in: query name: cpcodeName schema: example: CPC XYZ type: string x-akamai: file-path: parameters/cpcodeName-query.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 post: description: 'To create a new CP code, you need to associate it with a product. You can assign any CP code within a property''s rule tree as detailed in the [Rule Trees](https://techdocs.akamai.com/property-mgr/reference/rule-trees) section. You should match the same `productId` that''s assigned to properties that invoke the CP code to the one assigned to the CP code, otherwise you may get a warning. To view or update certain CP code data, such as name, time zone, and purgeability, use the [CP Codes and Reporting Groups API](https://techdocs.akamai.com/cp-codes/reference/api).' operationId: post-cpcodes summary: Akamai Create a New CP Code tags: - CP codes externalDocs: description: See documentation for this operation in Akamai's Property Manager API url: https://techdocs.akamai.com/property-mgr/reference/post-cpcodes requestBody: required: true content: application/json: example: cpcodeName: SME WAA productId: prd_Web_App_Accel schema: $schema: http://json-schema.org/draft-04-schema# description: Specifies billing and reporting codes. To make a POST request that creates a new CP code, specify an object with `productId` and `cpcodeName` members. Relevant response objects appear within the outer envelope's `cpcodes.items` array. id: resource:/descriptors/papi/v1/schemas/CreateNewCPCodeRequestV0.json# javaType: com.akamai.luna.papi.model.CPCodeCreateRequest type: object required: - productId - cpcodeName properties: cpcodeName: description: 'A descriptive label for the CP code. The name can''t include commas, underscores, quotes, or any of these special characters: `^ # %`.' example: '{{cpcodeName}}' type: string productId: description: On POST, the product to assign to this CP code. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `prd_` prefix. example: '{{productId}}' type: string x-akamai: file-path: schemas/cpcode-create-request.yaml responses: '201': description: The response provides a URL link to the newly created CP code. content: application/json: example: cpcodeLink: /papi/v0/cpcodes/cpc_33190?contractId=ctr_C-0N7RAC7&groupId=grp_15166 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/PostCpCodeResponse.json# type: object required: - cpcodeLink properties: cpcodeLink: description: Links the newly created CP code. type: string x-akamai: file-path: schemas/cpcode-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 '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. 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: true schema: example: ctr_1-1TJZFW type: string x-akamai: file-path: parameters/contractId-required.yaml - description: Unique identifier for the group. 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: true schema: example: grp_15166 type: string x-akamai: file-path: parameters/groupId-required.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 /cpcodes/{cpcodeId}: x-akamai: file-path: paths/cpcode.yaml path-for-file: /cpcodes/{cpcodeId} parameters: - description: The identifier for the CP code. example: '{{cpcodeId}}' in: path name: cpcodeId required: true schema: example: 123456 type: integer x-akamai: file-path: parameters/cpcodeId-path.yaml x-akamai-descriptor-tools: displayName: cpCode group: CpCodes get: description: Get detailed information about a specific CP code. The details include the CP code type, name, time zone, as well as the account, contracts, and products it's assigned to. This operation also lists the access control group the CP code belongs to. operationId: get-cpcode summary: Get a CP code tags: - CP codes externalDocs: description: See documentation for this operation in Akamai's CP Codes and Reporting Groups API url: https://techdocs.akamai.com/cp-codes/reference/get-cpcode responses: '200': description: Provides details of a specified CP code. content: application/json: example: accountId: A-CCT9012 cpcodeId: 1234567 cpcodeName: Digital Company CP Code defaultTimezone: GMT 0 (Greenwich Mean Time) purgeable: true type: Regular accessGroup: contractId: C-0N7RAC7 groupId: 15225 overrideTimezone: timezoneId: '0' timezoneValue: GMT 0 (Greenwich Mean Time) contracts: - contractId: K-0N7RAK7 status: ongoing products: - productId: AdvSite::Reporter productName: Monitor site advance schema: additionalProperties: false description: Provides detailed information about a CP code. type: object required: - cpcodeId - cpcodeName - contracts - products properties: accessGroup: additionalProperties: false description: A group that controls access to specific CP codes. type: object required: - contractId - groupId properties: contractId: description: 'Identifies the contract assigned to the access control group. Get and store this ID from your account using the [Contracts API](https://techdocs.akamai.com/contract-api/reference/get-contract-ids). **Note**: See [ID prefixes](https://techdocs.akamai.com/cp-codes/reference/id-prefixes) for guidance on comparing this value with data from PAPI.' minLength: 1 type: string groupId: description: 'Identifies the access control group. Reporting groups may belong to many groups. If that happens, this member''s value is `null`. **Note**: See [ID prefixes](https://techdocs.akamai.com/cp-codes/reference/id-prefixes) for guidance on comparing this value with data from PAPI.' minimum: 0 nullable: true type: integer x-akamai: file-path: schemas/access-group.yaml accountId: description: 'Identifies an account assigned to the CP code. **Note**: See [ID prefixes](https://techdocs.akamai.com/cp-codes/reference/id-prefixes) for guidance on comparing this value with data from PAPI.' minLength: 1 type: string contracts: description: Provides detailed information about the contracts assigned to the CP code. minItems: 0 readOnly: true type: array items: additionalProperties: false description: Specifies details of a single contract. type: object required: - contractId properties: contractId: description: 'Identifies the contract. **Note**: See [ID prefixes](https://techdocs.akamai.com/cp-codes/reference/id-prefixes) for guidance on comparing this value with data from PAPI.' minLength: 1 readOnly: true type: string status: description: The status of a contract. minLength: 1 readOnly: true type: string x-akamai: file-path: schemas/contracts-status-array.yaml cpcodeId: description: 'Identifies the CP code. **Note**: See [ID prefixes](https://techdocs.akamai.com/cp-codes/reference/id-prefixes) for guidance on comparing this value with data from PAPI.' minimum: 1 type: integer cpcodeName: description: The descriptive label for the CP code. minLength: 1 type: string defaultTimezone: description: The default GMT time zone assigned to the CP code. minLength: 1 type: string overrideTimezone: additionalProperties: false description: The GMT time zone that overrides the default time zone assigned to the CP code. Only a few legacy reports override the default time zone for the time axis. Most reports, and all new ones, use the user's own time zone for the time axis. type: object required: - timezoneId properties: timezoneId: description: Identifies the GMT time zone. minLength: 1 type: string timezoneValue: description: The offset value for the GMT time zone. minLength: 1 type: string x-akamai: file-path: schemas/override-timezone.yaml products: description: A collection of products and services assigned to the CP code. minItems: 0 type: array items: additionalProperties: false description: Specifies details of a single product. type: object required: - productId properties: productId: description: 'Identifies a product or service. **Note**: See [ID prefixes](https://techdocs.akamai.com/cp-codes/reference/id-prefixes) for guidance on comparing this value with data from PAPI.' minLength: 1 type: string productName: description: The descriptive label for a product or service. minLength: 1 type: string x-akamai: file-path: schemas/products-array.yaml purgeable: description: Whether you can purge the content cached by the CP code. type: boolean type: description: Whether the CP code supports serving traffic from `China`, or `Regular` traffic elsewhere. type: string enum: - Regular - China x-akamai: file-path: schemas/cpcode-200.yaml '400': description: '[Bad request](https://techdocs.akamai.com/cp-codes/reference/400).' content: application/problem+json: example: code: bad.request incidentId: dc2f405e-29d3-4845-a4ac-2f6b4a732aca title: Bad Request details: - code: invalid.data message: Group name is mandatory schema: additionalProperties: true description: Provides detailed information about a failed request. type: object required: - title - code - details - incidentId properties: code: description: A descriptive code that corresponds to overall HTTP status. minLength: 1 type: string details: additionalProperties: true description: Each array member object encodes context for the failed request. For example, malformed query parameter field values. type: object required: - code - message properties: code: description: A descriptive identifier for each problem. minLength: 1 type: string data: description: A loosely structured object that, when available, encapsulates the set of erroneous input values. type: object message: description: A description of the problem. minLength: 1 type: string incidentId: description: A logging key useful when communicating about problems with Technical Support representatives. minLength: 1 type: string title: description: A descriptive title that labels each error case. minLength: 1 type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/400.yaml '401': description: '[Unauthorized](https://techdocs.akamai.com/cp-codes/reference/401).' content: application/problem+json: example: code: unauthorized incidentId: dc2f405e-29d3-4845-a4ac-2f6b4a732aca title: Unauthorized details: - code: invalid.data message: The request requires authentication schema: additionalProperties: true description: Provides detailed information about a failed request. type: object required: - title - code - details - incidentId properties: code: description: A descriptive code that corresponds to overall HTTP status. minLength: 1 type: string details: additionalProperties: true description: Each array member object encodes context for the failed request. For example, malformed query parameter field values. type: object required: - code - message properties: code: description: A descriptive identifier for each problem. minLength: 1 type: string data: description: A loosely structured object that, when available, encapsulates the set of erroneous input values. type: object message: description: A description of the problem. minLength: 1 type: string incidentId: description: A logging key useful when communicating about problems with Technical Support representatives. minLength: 1 type: string title: description: A descriptive title that labels each error case. minLength: 1 type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/401.yaml '403': description: '[Forbidden](https://techdocs.akamai.com/cp-codes/reference/403).' content: application/problem+json: example: code: forbidden incidentId: dc2f405e-29d3-4845-a4ac-2f6b4a732aca title: Forbidden details: - code: invalid.role message: User is not authorized schema: additionalProperties: true description: Provides detailed information about a failed request. type: object required: - title - code - details - incidentId properties: code: description: A descriptive code that corresponds to overall HTTP status. minLength: 1 type: string details: additionalProperties: true description: Each array member object encodes context for the failed request. For example, malformed query parameter field values. type: object required: - code - message properties: code: description: A descriptive identifier for each problem. minLength: 1 type: string data: description: A loosely structured object that, when available, encapsulates the set of erroneous input values. type: object message: description: A description of the problem. minLength: 1 type: string incidentId: description: A logging key useful when communicating about problems with Technical Support representatives. minLength: 1 type: string title: description: A descriptive title that labels each error case. minLength: 1 type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/403.yaml '404': description: '[Not found](https://techdocs.akamai.com/cp-codes/reference/404).' content: application/problem+json: example: code: not.found incidentId: dc2f405e-29d3-4845-a4ac-2f6b4a732aca title: Not Found details: - code: invalid.data message: The reporting group with id 000 is already deleted schema: additionalProperties: true description: Provides detailed information about a failed request. type: object required: - title - code - details - incidentId properties: code: description: A descriptive code that corresponds to overall HTTP status. minLength: 1 type: string details: additionalProperties: true description: Each array member object encodes context for the failed request. For example, malformed query parameter field values. type: object required: - code - message properties: code: description: A descriptive identifier for each problem. minLength: 1 type: string data: description: A loosely structured object that, when available, encapsulates the set of erroneous input values. type: object message: description: A description of the problem. minLength: 1 type: string incidentId: description: A logging key useful when communicating about problems with Technical Support representatives. minLength: 1 type: string title: description: A descriptive title that labels each error case. minLength: 1 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/cp-codes/reference/405).' content: application/problem+json: example: code: method.not.allowed incidentId: 3714936a-07a6-4991-939f-c201adbf35f3 title: Method Not Allowed details: - code: method.not.supported message: method.not.supported schema: additionalProperties: true description: Provides detailed information about a failed request. type: object required: - title - code - details - incidentId properties: code: description: A descriptive code that corresponds to overall HTTP status. minLength: 1 type: string details: additionalProperties: true description: Each array member object encodes context for the failed request. For example, malformed query parameter field values. type: object required: - code - message properties: code: description: A descriptive identifier for each problem. minLength: 1 type: string data: description: A loosely structured object that, when available, encapsulates the set of erroneous input values. type: object message: description: A description of the problem. minLength: 1 type: string incidentId: description: A logging key useful when communicating about problems with Technical Support representatives. minLength: 1 type: string title: description: A descriptive title that labels each error case. minLength: 1 type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/405.yaml parameters: - 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 put: description: Modifies a specific CP code. After running the [GET a CP code](https://techdocs.akamai.com/cp-codes/reference/get-cpcode) operation, use the response to build a request body. You can only modify a CP code's name, time zone, and purgeable member. operationId: put-cpcode summary: Update a CP code tags: - CP codes externalDocs: description: See documentation for this operation in Akamai's CP Codes and Reporting Groups API url: https://techdocs.akamai.com/cp-codes/reference/put-cpcode requestBody: required: true content: application/json: example: accountId: A-CCT9012 cpcodeId: 1234567 cpcodeName: Digital Company CP Code new defaultTimezone: GMT 0 (Greenwich Mean Time) purgeable: true type: Regular accessGroup: contractId: K-0N7RAK7 groupId: 15225 overrideTimezone: timezoneId: '0' timezoneValue: GMT 0 (Greenwich Mean Time) contracts: - contractId: C-0N7RAC7 status: ongoing products: - productId: AdvSite::Reporter productName: Monitor site advance schema: additionalProperties: false description: Contains the request members that you can specify when updating a CP code. You should only modify a CP code's name, time zone, and purgeable member. Modifying other members results in a 400 error response and causes the request to fail. type: object required: - cpcodeId - products - contracts - cpcodeName - overrideTimezone properties: accessGroup: additionalProperties: false description: A group that controls access to specific CP codes. type: object required: - contractId - groupId properties: contractId: description: 'Identifies the contract assigned to the access control group. Get and store this ID from your account using the [Contracts API](https://techdocs.akamai.com/contract-api/reference/get-contract-ids). **Note**: See [ID prefixes](https://techdocs.akamai.com/cp-codes/reference/id-prefixes) for guidance on comparing this value with data from PAPI.' minLength: 1 type: string groupId: description: 'Identifies the access control group. Reporting groups may belong to many groups. If that happens, this member''s value is `null`. **Note**: See [ID prefixes](https://techdocs.akamai.com/cp-codes/reference/id-prefixes) for guidance on comparing this value with data from PAPI.' minimum: 0 nullable: true type: integer x-akamai: file-path: schemas/access-group.yaml accountId: description: 'Identifies an account assigned to the CP code. **Note**: See [ID prefixes](https://techdocs.akamai.com/cp-codes/reference/id-prefixes) for guidance on comparing this value with data from PAPI.' example: '{{accountId}}' minLength: 1 readOnly: true type: string contracts: description: Provides detailed information about the contracts assigned to the CP code. minItems: 0 readOnly: true type: array items: additionalProperties: false description: Specifies details of a single contract. type: object required: - contractId properties: contractId: description: 'Identifies the contract. **Note**: See [ID prefixes](https://techdocs.akamai.com/cp-codes/reference/id-prefixes) for guidance on comparing this value with data from PAPI.' minLength: 1 readOnly: true type: string status: description: The status of a contract. minLength: 1 readOnly: true type: string x-akamai: file-path: schemas/contracts-status-array.yaml cpcodeId: description: 'Identifies the CP code. **Note**: See [ID prefixes](https://techdocs.akamai.com/cp-codes/reference/id-prefixes) for guidance on comparing this value with data from PAPI.' example: '{{cpcodeId}}' minimum: 1 readOnly: true type: integer cpcodeName: description: The descriptive label for the CP code. example: '{{cpcodeName}}' minLength: 1 type: string defaultTimezone: description: The default GMT time zone assigned to the CP code. example: '{{defaultTimezone}}' minLength: 1 readOnly: true type: string overrideTimezone: additionalProperties: false description: The GMT time zone that overrides the default time zone assigned to the CP code. Only a few legacy reports override the default time zone for the time axis. Most reports, and all new ones, use the user's own time zone for the time axis. type: object required: - timezoneId properties: timezoneId: description: Identifies the GMT time zone. minLength: 1 type: string timezoneValue: description: The offset value for the GMT time zone. minLength: 1 type: string x-akamai: file-path: schemas/override-timezone.yaml products: description: A collection of products and services assigned to the CP code. minItems: 0 readOnly: true type: array items: additionalProperties: false description: Specifies details of a single product. type: object required: - productId properties: productId: description: 'Identifies a product or service. **Note**: See [ID prefixes](https://techdocs.akamai.com/cp-codes/reference/id-prefixes) for guidance on comparing this value with data from PAPI.' minLength: 1 type: string productName: description: The descriptive label for a product or service. minLength: 1 type: string x-akamai: file-path: schemas/products-array.yaml purgeable: description: Whether you can purge the content cached by the CP code. example: '{{purgeable}}' type: boolean type: description: Whether the CP code supports serving traffic from `China`, or `Regular` traffic elsewhere. example: '{{type}}' type: string enum: - Regular - China x-akamai: file-path: schemas/cpcode-put.yaml responses: '200': description: Provides details of a modified CP code. content: application/json: example: accountId: A-CCT9012 cpcodeId: 1234567 cpcodeName: Digital Company CP Code new defaultTimezone: GMT 0 (Greenwich Mean Time) purgeable: true type: Regular accessGroup: contractId: K-0N7RAK71 groupId: 15225 overrideTimezone: timezoneId: '0' timezoneValue: GMT 0 (Greenwich Mean Time) contracts: - contractId: K-0N7RAK71 status: ongoing products: - productId: AdvSite::Reporter productName: Monitor site advance schema: additionalProperties: false description: Provides detailed information about a CP code. type: object required: - cpcodeId - cpcodeName - contracts - products properties: accessGroup: additionalProperties: false description: A group that controls access to specific CP codes. type: object required: - contractId - groupId properties: contractId: description: 'Identifies the contract assigned to the access control group. Get and store this ID from your account using the [Contracts API](https://techdocs.akamai.com/contract-api/reference/get-contract-ids). **Note**: See [ID prefixes](https://techdocs.akamai.com/cp-codes/reference/id-prefixes) for guidance on comparing this value with data from PAPI.' minLength: 1 type: string groupId: description: 'Identifies the access control group. Reporting groups may belong to many groups. If that happens, this member''s value is `null`. **Note**: See [ID prefixes](https://techdocs.akamai.com/cp-codes/reference/id-prefixes) for guidance on comparing this value with data from PAPI.' minimum: 0 nullable: true type: integer x-akamai: file-path: schemas/access-group.yaml accountId: description: 'Identifies an account assigned to the CP code. **Note**: See [ID prefixes](https://techdocs.akamai.com/cp-codes/reference/id-prefixes) for guidance on comparing this value with data from PAPI.' minLength: 1 type: string contracts: description: Provides detailed information about the contracts assigned to the CP code. minItems: 0 readOnly: true type: array items: additionalProperties: false description: Specifies details of a single contract. type: object required: - contractId properties: contractId: description: 'Identifies the contract. **Note**: See [ID prefixes](https://techdocs.akamai.com/cp-codes/reference/id-prefixes) for guidance on comparing this value with data from PAPI.' minLength: 1 readOnly: true type: string status: description: The status of a contract. minLength: 1 readOnly: true type: string x-akamai: file-path: schemas/contracts-status-array.yaml cpcodeId: description: 'Identifies the CP code. **Note**: See [ID prefixes](https://techdocs.akamai.com/cp-codes/reference/id-prefixes) for guidance on comparing this value with data from PAPI.' minimum: 1 type: integer cpcodeName: description: The descriptive label for the CP code. minLength: 1 type: string defaultTimezone: description: The default GMT time zone assigned to the CP code. minLength: 1 type: string overrideTimezone: additionalProperties: false description: The GMT time zone that overrides the default time zone assigned to the CP code. Only a few legacy reports override the default time zone for the time axis. Most reports, and all new ones, use the user's own time zone for the time axis. type: object required: - timezoneId properties: timezoneId: description: Identifies the GMT time zone. minLength: 1 type: string timezoneValue: description: The offset value for the GMT time zone. minLength: 1 type: string x-akamai: file-path: schemas/override-timezone.yaml products: description: A collection of products and services assigned to the CP code. minItems: 0 type: array items: additionalProperties: false description: Specifies details of a single product. type: object required: - productId properties: productId: description: 'Identifies a product or service. **Note**: See [ID prefixes](https://techdocs.akamai.com/cp-codes/reference/id-prefixes) for guidance on comparing this value with data from PAPI.' minLength: 1 type: string productName: description: The descriptive label for a product or service. minLength: 1 type: string x-akamai: file-path: schemas/products-array.yaml purgeable: description: Whether you can purge the content cached by the CP code. type: boolean type: description: Whether the CP code supports serving traffic from `China`, or `Regular` traffic elsewhere. type: string enum: - Regular - China x-akamai: file-path: schemas/cpcode-200.yaml '400': description: '[Bad request](https://techdocs.akamai.com/cp-codes/reference/400).' content: application/problem+json: example: code: bad.request incidentId: dc2f405e-29d3-4845-a4ac-2f6b4a732aca title: Bad Request details: - code: invalid.data message: Group name is mandatory schema: additionalProperties: true description: Provides detailed information about a failed request. type: object required: - title - code - details - incidentId properties: code: description: A descriptive code that corresponds to overall HTTP status. minLength: 1 type: string details: additionalProperties: true description: Each array member object encodes context for the failed request. For example, malformed query parameter field values. type: object required: - code - message properties: code: description: A descriptive identifier for each problem. minLength: 1 type: string data: description: A loosely structured object that, when available, encapsulates the set of erroneous input values. type: object message: description: A description of the problem. minLength: 1 type: string incidentId: description: A logging key useful when communicating about problems with Technical Support representatives. minLength: 1 type: string title: description: A descriptive title that labels each error case. minLength: 1 type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/400.yaml '401': description: '[Unauthorized](https://techdocs.akamai.com/cp-codes/reference/401).' content: application/problem+json: example: code: unauthorized incidentId: dc2f405e-29d3-4845-a4ac-2f6b4a732aca title: Unauthorized details: - code: invalid.data message: The request requires authentication schema: additionalProperties: true description: Provides detailed information about a failed request. type: object required: - title - code - details - incidentId properties: code: description: A descriptive code that corresponds to overall HTTP status. minLength: 1 type: string details: additionalProperties: true description: Each array member object encodes context for the failed request. For example, malformed query parameter field values. type: object required: - code - message properties: code: description: A descriptive identifier for each problem. minLength: 1 type: string data: description: A loosely structured object that, when available, encapsulates the set of erroneous input values. type: object message: description: A description of the problem. minLength: 1 type: string incidentId: description: A logging key useful when communicating about problems with Technical Support representatives. minLength: 1 type: string title: description: A descriptive title that labels each error case. minLength: 1 type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/401.yaml '403': description: '[Forbidden](https://techdocs.akamai.com/cp-codes/reference/403).' content: application/problem+json: example: code: forbidden incidentId: dc2f405e-29d3-4845-a4ac-2f6b4a732aca title: Forbidden details: - code: invalid.role message: User is not authorized schema: additionalProperties: true description: Provides detailed information about a failed request. type: object required: - title - code - details - incidentId properties: code: description: A descriptive code that corresponds to overall HTTP status. minLength: 1 type: string details: additionalProperties: true description: Each array member object encodes context for the failed request. For example, malformed query parameter field values. type: object required: - code - message properties: code: description: A descriptive identifier for each problem. minLength: 1 type: string data: description: A loosely structured object that, when available, encapsulates the set of erroneous input values. type: object message: description: A description of the problem. minLength: 1 type: string incidentId: description: A logging key useful when communicating about problems with Technical Support representatives. minLength: 1 type: string title: description: A descriptive title that labels each error case. minLength: 1 type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/403.yaml '404': description: '[Not found](https://techdocs.akamai.com/cp-codes/reference/404).' content: application/problem+json: example: code: not.found incidentId: dc2f405e-29d3-4845-a4ac-2f6b4a732aca title: Not Found details: - code: invalid.data message: The reporting group with id 000 is already deleted schema: additionalProperties: true description: Provides detailed information about a failed request. type: object required: - title - code - details - incidentId properties: code: description: A descriptive code that corresponds to overall HTTP status. minLength: 1 type: string details: additionalProperties: true description: Each array member object encodes context for the failed request. For example, malformed query parameter field values. type: object required: - code - message properties: code: description: A descriptive identifier for each problem. minLength: 1 type: string data: description: A loosely structured object that, when available, encapsulates the set of erroneous input values. type: object message: description: A description of the problem. minLength: 1 type: string incidentId: description: A logging key useful when communicating about problems with Technical Support representatives. minLength: 1 type: string title: description: A descriptive title that labels each error case. minLength: 1 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/cp-codes/reference/405).' content: application/problem+json: example: code: method.not.allowed incidentId: 3714936a-07a6-4991-939f-c201adbf35f3 title: Method Not Allowed details: - code: method.not.supported message: method.not.supported schema: additionalProperties: true description: Provides detailed information about a failed request. type: object required: - title - code - details - incidentId properties: code: description: A descriptive code that corresponds to overall HTTP status. minLength: 1 type: string details: additionalProperties: true description: Each array member object encodes context for the failed request. For example, malformed query parameter field values. type: object required: - code - message properties: code: description: A descriptive identifier for each problem. minLength: 1 type: string data: description: A loosely structured object that, when available, encapsulates the set of erroneous input values. type: object message: description: A description of the problem. minLength: 1 type: string incidentId: description: A logging key useful when communicating about problems with Technical Support representatives. minLength: 1 type: string title: description: A descriptive title that labels each error case. minLength: 1 type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/405.yaml '415': description: '[Unsupported media type](https://techdocs.akamai.com/cp-codes/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=K-0N7RAK7&groupId=123456#abc12345abcc02a7 status: 415 title: Unsupported Media Type type: https://problems.luna.akamaiapis.net/papi/v1/http/unsupported-media-type schema: additionalProperties: true description: Provides detailed information about a failed request. type: object required: - title - code - details - incidentId properties: code: description: A descriptive code that corresponds to overall HTTP status. minLength: 1 type: string details: additionalProperties: true description: Each array member object encodes context for the failed request. For example, malformed query parameter field values. type: object required: - code - message properties: code: description: A descriptive identifier for each problem. minLength: 1 type: string data: description: A loosely structured object that, when available, encapsulates the set of erroneous input values. type: object message: description: A description of the problem. minLength: 1 type: string incidentId: description: A logging key useful when communicating about problems with Technical Support representatives. minLength: 1 type: string title: description: A descriptive title that labels each error case. minLength: 1 type: string x-akamai: file-path: schemas/problem.yaml x-akamai: file-path: errors/415.yaml parameters: - 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