{ "openapi": "3.0.0", "externalDocs": { "description": "See documentation for Akamai's CP Codes and Reporting Groups API", "url": "https://techdocs.akamai.com/cp-codes/reference" }, "info": { "title": "Akamai: CP Codes and Reporting Groups API", "version": "1.0", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" } }, "paths": { "/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).\n\n**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`.\n\n**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.\n\n**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.\n\n**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.\n\n**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.\n\n**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" } } ] }, "x-akamai": { "file-path": "paths/cpcodes.yaml", "path-for-file": "/cpcodes" } }, "/cpcodes/contracts/{contractId}/watermark-limits": { "get": { "description": "Get a watermark limit for CP codes for a specific contract within your account. For more details, see [Rate and resource limiting](https://techdocs.akamai.com/cp-codes/reference/rate-and-resource-limiting).", "operationId": "get-cpcodes-watermark-limits", "summary": "Get a water-mark limit", "tags": [ "Watermark limits" ], "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-watermark-limits" }, "responses": { "200": { "description": "Provides the current number of resources and available limit.", "content": { "application/json": { "example": { "currentCapacity": 3500, "limit": 5000, "limitType": "account" }, "schema": { "additionalProperties": false, "description": "Provides watermark limits for CP codes or reporting groups within a specific contract.", "type": "object", "required": [ "currentCapacity", "limit", "limitType" ], "properties": { "currentCapacity": { "description": "The current number of CP codes or reporting groups.", "minimum": 0, "type": "integer" }, "limit": { "description": "The number of allowed CP codes or reporting groups.", "minimum": 0, "type": "integer" }, "limitType": { "description": "Identifies whether the `limit` applies to an account or a contract. For more details, see [Rate and resource limiting](https://techdocs.akamai.com/cp-codes/reference/rate-and-resource-limiting).", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/watermark-limits-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" } } ] }, "x-akamai": { "file-path": "paths/cpcodes-watermark-limit.yaml", "path-for-file": "/cpcodes/contracts/{contractId}/watermark-limits" }, "parameters": [ { "description": "The identifier for the contract for which you want to check water-mark limits.", "example": "{{contractId}}", "in": "path", "name": "contractId", "required": true, "schema": { "example": "1Q004", "type": "string" }, "x-akamai": { "file-path": "parameters/contractId-path.yaml" } } ] }, "/cpcodes/{cpcodeId}": { "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).\n\n**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`.\n\n**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.\n\n**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.\n\n**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.\n\n**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.\n\n**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).\n\n**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`.\n\n**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.\n\n**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.\n\n**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.\n\n**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.\n\n**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).\n\n**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`.\n\n**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.\n\n**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.\n\n**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.\n\n**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.\n\n**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" } } ] }, "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" } } ] }, "/reporting-groups": { "post": { "description": "Creates a reporting group. Make sure the reporting group's name is unique within an account. The `location` header in the response provides a relative path to the created reporting group.", "operationId": "post-reporting-groups", "summary": "Create a reporting group", "tags": [ "Reporting groups" ], "externalDocs": { "description": "See documentation for this operation in Akamai's CP Codes and Reporting Groups API", "url": "https://techdocs.akamai.com/cp-codes/reference/post-reporting-groups" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "reportingGroupName": "Region XYZ", "accessGroup": { "contractId": "K-0N7RAK71", "groupId": 15225 }, "contracts": [ { "contractId": "C-0N7RAC71", "cpcodes": [ { "cpcodeId": 1234567, "cpcodeName": "Digital Company CP Code" }, { "cpcodeId": 1234567, "cpcodeName": "Internet Company CP Code" } ] } ] }, "schema": { "additionalProperties": false, "description": "Provides the request members that you can specify when creating a reporting group.", "type": "object", "required": [ "reportingGroupName", "contracts", "accessGroup" ], "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).\n\n**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`.\n\n**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" } }, "contracts": { "description": "A collection of contracts and CP codes assigned to the reporting group.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Specifies details of a single contract and collection of CP codes assigned to the reporting group.", "type": "object", "required": [ "contractId", "cpcodes" ], "properties": { "contractId": { "description": "Identifies the contract assigned to the reporting group.\n\n**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" }, "cpcodes": { "description": "A collection of CP codes assigned to the reporting group.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Specifies details of a single CP code.", "type": "object", "required": [ "cpcodeId" ], "properties": { "cpcodeId": { "description": "Identifies a CP code.\n\n**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, "type": "integer" }, "cpcodeName": { "description": "The descriptive label for the CP code.", "minLength": 1, "type": "string" } } } } } }, "x-akamai": { "file-path": "schemas/contracts-array.yaml" } }, "reportingGroupName": { "description": "The descriptive label for the reporting group.", "example": "{{reportingGroupName}}", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/reporting-group-post.yaml" } } } } }, "responses": { "201": { "description": "Provides details of a newly created reporting group.", "content": { "application/json": { "example": { "reportingGroupName": "Region XYZ", "accessGroup": { "contractId": "K-0N7RAK7", "groupId": 15225 }, "contracts": [ { "contractId": "K-0N7RAK71", "cpcodes": [ { "cpcodeId": 1234567, "cpcodeName": "Digital Company CP Code" }, { "cpcodeId": 1234567, "cpcodeName": "Internet Company CP Code" } ] } ] }, "schema": { "additionalProperties": false, "description": "On GET, provides detailed information about a specific reporting group. On PUR, provides the request members that you can specify when updating a reporting group. When updating a reporting group, you should only modify a reporting group's name and assigned CP codes. Modifying other members results in an 400 error response and causes the request to fail.", "type": "object", "required": [ "reportingGroupId", "reportingGroupName", "contracts", "accessGroup" ], "properties": { "accessGroup": { "additionalProperties": false, "description": "A group that controls access to specific CP codes.", "readOnly": true, "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).\n\n**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`.\n\n**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" } }, "contracts": { "description": "A collection of contracts and CP codes assigned to the reporting group.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Specifies details of a single contract and collection of CP codes assigned to the reporting group.", "type": "object", "required": [ "contractId", "cpcodes" ], "properties": { "contractId": { "description": "Identifies the contract assigned to the reporting group.\n\n**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" }, "cpcodes": { "description": "A collection of CP codes assigned to the reporting group.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Specifies details of a single CP code.", "type": "object", "required": [ "cpcodeId" ], "properties": { "cpcodeId": { "description": "Identifies a CP code.\n\n**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, "type": "integer" }, "cpcodeName": { "description": "The descriptive label for the CP code.", "minLength": 1, "type": "string" } } } } } }, "x-akamai": { "file-path": "schemas/contracts-array.yaml" } }, "reportingGroupId": { "description": "Identifies the reporting group.", "minimum": 0, "readOnly": true, "type": "integer" }, "reportingGroupName": { "description": "The descriptive label for the reporting group.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/reporting-group-200.yaml" } } } }, "headers": { "Location": { "description": "The relative path to the created reporting group.", "schema": { "type": "string" }, "x-akamai": { "file-path": "headers/Location.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": "[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" } } ] }, "get": { "description": "Lists detailed information about reporting groups available for your account and contract.", "operationId": "get-reporting-groups", "summary": "List reporting groups", "tags": [ "Reporting groups" ], "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-reporting-groups" }, "responses": { "200": { "description": "Lists details of reporting groups available for a specified account and contract.", "content": { "application/json": { "example": { "groups": [ { "reportingGroupId": 101010, "reportingGroupName": "Region XYZ", "accessGroup": { "contractId": "K-0N7RAK7", "groupId": 15225 }, "contracts": [ { "contractId": "K-0N7RAK71", "cpcodes": [ { "cpcodeId": 1234567, "cpcodeName": "Digital Company CP Code" } ] } ] }, { "reportingGroupId": 101011, "reportingGroupName": "Region gLobal XYZ", "accessGroup": { "contractId": "C-0N7RAC71", "groupId": 15225 }, "contracts": [ { "contractId": "K-0N7RAK71", "cpcodes": [ { "cpcodeId": 1234567, "cpcodeName": "Internet Company CP Code" }, { "cpcodeId": 1234567, "cpcodeName": "High Street Company CP Code" } ] } ] } ] }, "schema": { "additionalProperties": false, "description": "Provides details about the reporting groups available for your contract.", "type": "object", "required": [ "groups" ], "properties": { "groups": { "description": "A set of reporting groups available for your contract.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "On GET, provides detailed information about a specific reporting group. On PUR, provides the request members that you can specify when updating a reporting group. When updating a reporting group, you should only modify a reporting group's name and assigned CP codes. Modifying other members results in an 400 error response and causes the request to fail.", "type": "object", "required": [ "reportingGroupId", "reportingGroupName", "contracts", "accessGroup" ], "properties": { "accessGroup": { "additionalProperties": false, "description": "A group that controls access to specific CP codes.", "readOnly": true, "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).\n\n**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`.\n\n**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" } }, "contracts": { "description": "A collection of contracts and CP codes assigned to the reporting group.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Specifies details of a single contract and collection of CP codes assigned to the reporting group.", "type": "object", "required": [ "contractId", "cpcodes" ], "properties": { "contractId": { "description": "Identifies the contract assigned to the reporting group.\n\n**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" }, "cpcodes": { "description": "A collection of CP codes assigned to the reporting group.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Specifies details of a single CP code.", "type": "object", "required": [ "cpcodeId" ], "properties": { "cpcodeId": { "description": "Identifies a CP code.\n\n**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, "type": "integer" }, "cpcodeName": { "description": "The descriptive label for the CP code.", "minLength": 1, "type": "string" } } } } } }, "x-akamai": { "file-path": "schemas/contracts-array.yaml" } }, "reportingGroupId": { "description": "Identifies the reporting group.", "minimum": 0, "readOnly": true, "type": "integer" }, "reportingGroupName": { "description": "The descriptive label for the reporting group.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/reporting-group-200.yaml" } } } }, "x-akamai": { "file-path": "schemas/reporting-groups-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": "The name of the reporting group to filter data by. Include this optional parameter to narrow down the results to a specific reporting group name only.", "example": "{{reportingGroupName}}", "in": "query", "name": "reportingGroupName", "schema": { "example": "Region XYZ", "type": "string" }, "x-akamai": { "file-path": "parameters/reportingGroupName-query.yaml" } }, { "description": "Identifies the CP code to filter data by. Include this optional parameter to narrow down the results to a specific CP code only.", "example": "{{cpcodeId}}", "in": "query", "name": "cpcodeId", "schema": { "example": "12345", "type": "string" }, "x-akamai": { "file-path": "parameters/cpcodeId-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" } } ] }, "x-akamai": { "file-path": "paths/reporting-groups.yaml", "path-for-file": "/reporting-groups" } }, "/reporting-groups/contracts/{contractId}/watermark-limits": { "get": { "description": "Get a watermark limit for CP reporting groups for a specific contract within your account. For more details, see [Rate and resource limiting](https://techdocs.akamai.com/cp-codes/reference/rate-and-resource-limiting).", "operationId": "get-reporting-groups-watermark-limits", "summary": "Get a water-mark limit for reporting groups", "tags": [ "Watermark limits" ], "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-reporting-groups-watermark-limits" }, "responses": { "200": { "description": "Provides the current number of resources and available limit.", "content": { "application/json": { "examples": { "reporting-groups-contract-limit": { "value": { "currentCapacity": 25, "limit": 100, "limitType": "account" } }, "reporting-groups-contract-override": { "value": { "currentCapacity": 25, "limit": 100, "limitType": "contract" } } }, "schema": { "additionalProperties": false, "description": "Provides watermark limits for CP codes or reporting groups within a specific contract.", "type": "object", "required": [ "currentCapacity", "limit", "limitType" ], "properties": { "currentCapacity": { "description": "The current number of CP codes or reporting groups.", "minimum": 0, "type": "integer" }, "limit": { "description": "The number of allowed CP codes or reporting groups.", "minimum": 0, "type": "integer" }, "limitType": { "description": "Identifies whether the `limit` applies to an account or a contract. For more details, see [Rate and resource limiting](https://techdocs.akamai.com/cp-codes/reference/rate-and-resource-limiting).", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/watermark-limits-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" } } ] }, "x-akamai": { "file-path": "paths/reporting-groups-watermark-limit.yaml", "path-for-file": "/cpcodes/contracts/{contractId}/watermark-limits" }, "parameters": [ { "description": "The identifier for the contract for which you want to check water-mark limits.", "example": "{{contractId}}", "in": "path", "name": "contractId", "required": true, "schema": { "example": "1Q004", "type": "string" }, "x-akamai": { "file-path": "parameters/contractId-path.yaml" } } ] }, "/reporting-groups/{reportingGroupId}": { "get": { "description": "Get detailed information about a specific reporting group. The details include the reporting group name and the access control group that it belongs to. This operations also lists the contracts and CP codes assigned to the reporting group.", "operationId": "get-reporting-group", "summary": "Get a reporting group", "tags": [ "Reporting groups" ], "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-reporting-group" }, "responses": { "200": { "description": "Provides details of a specified reporting group.", "content": { "application/json": { "example": { "reportingGroupId": 101010, "reportingGroupName": "Region XYZ", "accessGroup": { "contractId": "K-0N7RAK71", "groupId": 15225 }, "contracts": [ { "contractId": "C-0N7RAC7", "cpcodes": [ { "cpcodeId": 1234567, "cpcodeName": "Digital Company CP Code" }, { "cpcodeId": 1234567, "cpcodeName": "Internet Company CP Code" } ] } ] }, "schema": { "additionalProperties": false, "description": "On GET, provides detailed information about a specific reporting group. On PUR, provides the request members that you can specify when updating a reporting group. When updating a reporting group, you should only modify a reporting group's name and assigned CP codes. Modifying other members results in an 400 error response and causes the request to fail.", "type": "object", "required": [ "reportingGroupId", "reportingGroupName", "contracts", "accessGroup" ], "properties": { "accessGroup": { "additionalProperties": false, "description": "A group that controls access to specific CP codes.", "readOnly": true, "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).\n\n**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`.\n\n**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" } }, "contracts": { "description": "A collection of contracts and CP codes assigned to the reporting group.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Specifies details of a single contract and collection of CP codes assigned to the reporting group.", "type": "object", "required": [ "contractId", "cpcodes" ], "properties": { "contractId": { "description": "Identifies the contract assigned to the reporting group.\n\n**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" }, "cpcodes": { "description": "A collection of CP codes assigned to the reporting group.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Specifies details of a single CP code.", "type": "object", "required": [ "cpcodeId" ], "properties": { "cpcodeId": { "description": "Identifies a CP code.\n\n**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, "type": "integer" }, "cpcodeName": { "description": "The descriptive label for the CP code.", "minLength": 1, "type": "string" } } } } } }, "x-akamai": { "file-path": "schemas/contracts-array.yaml" } }, "reportingGroupId": { "description": "Identifies the reporting group.", "minimum": 0, "readOnly": true, "type": "integer" }, "reportingGroupName": { "description": "The descriptive label for the reporting group.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/reporting-group-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 reporting group. You should only modify a reporting group's name and assigned CP codes.", "operationId": "put-reporting-group", "summary": "Update a reporting group", "tags": [ "Reporting groups" ], "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-reporting-group" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "description": "Region XYZ", "reportingGroupId": 101010, "reportingGroupName": "Region XYZ", "contracts": [ { "contractId": "C-0N7RAC71", "cpcodes": [ { "cpcodeId": 1234567, "cpcodeName": "Digital Company CP Code" }, { "cpcodeId": 1234567, "cpcodeName": "Internet Company CP Code" } ] } ] }, "schema": { "additionalProperties": false, "description": "On GET, provides detailed information about a specific reporting group. On PUR, provides the request members that you can specify when updating a reporting group. When updating a reporting group, you should only modify a reporting group's name and assigned CP codes. Modifying other members results in an 400 error response and causes the request to fail.", "type": "object", "required": [ "reportingGroupId", "reportingGroupName", "contracts", "accessGroup" ], "properties": { "accessGroup": { "additionalProperties": false, "description": "A group that controls access to specific CP codes.", "readOnly": true, "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).\n\n**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`.\n\n**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" } }, "contracts": { "description": "A collection of contracts and CP codes assigned to the reporting group.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Specifies details of a single contract and collection of CP codes assigned to the reporting group.", "type": "object", "required": [ "contractId", "cpcodes" ], "properties": { "contractId": { "description": "Identifies the contract assigned to the reporting group.\n\n**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" }, "cpcodes": { "description": "A collection of CP codes assigned to the reporting group.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Specifies details of a single CP code.", "type": "object", "required": [ "cpcodeId" ], "properties": { "cpcodeId": { "description": "Identifies a CP code.\n\n**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, "type": "integer" }, "cpcodeName": { "description": "The descriptive label for the CP code.", "minLength": 1, "type": "string" } } } } } }, "x-akamai": { "file-path": "schemas/contracts-array.yaml" } }, "reportingGroupId": { "description": "Identifies the reporting group.", "example": "{{reportingGroupId}}", "minimum": 0, "readOnly": true, "type": "integer" }, "reportingGroupName": { "description": "The descriptive label for the reporting group.", "example": "{{reportingGroupName}}", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/reporting-group-200.yaml" } } } } }, "responses": { "200": { "description": "Provides details of a modified reporting group.", "content": { "application/json": { "example": { "reportingGroupId": 101010, "reportingGroupName": "Region XYZ", "accessGroup": { "contractId": "K-0N7RAK7", "groupId": 15225 }, "contracts": [ { "contractId": "C-0N7RAC7", "cpcodes": [ { "cpcodeId": 1234567, "cpcodeName": "Digital Company CP Code" }, { "cpcodeId": 1234567, "cpcodeName": "Internet Company CP Code" } ] } ] }, "schema": { "additionalProperties": false, "description": "On GET, provides detailed information about a specific reporting group. On PUR, provides the request members that you can specify when updating a reporting group. When updating a reporting group, you should only modify a reporting group's name and assigned CP codes. Modifying other members results in an 400 error response and causes the request to fail.", "type": "object", "required": [ "reportingGroupId", "reportingGroupName", "contracts", "accessGroup" ], "properties": { "accessGroup": { "additionalProperties": false, "description": "A group that controls access to specific CP codes.", "readOnly": true, "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).\n\n**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`.\n\n**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" } }, "contracts": { "description": "A collection of contracts and CP codes assigned to the reporting group.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Specifies details of a single contract and collection of CP codes assigned to the reporting group.", "type": "object", "required": [ "contractId", "cpcodes" ], "properties": { "contractId": { "description": "Identifies the contract assigned to the reporting group.\n\n**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" }, "cpcodes": { "description": "A collection of CP codes assigned to the reporting group.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Specifies details of a single CP code.", "type": "object", "required": [ "cpcodeId" ], "properties": { "cpcodeId": { "description": "Identifies a CP code.\n\n**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, "type": "integer" }, "cpcodeName": { "description": "The descriptive label for the CP code.", "minLength": 1, "type": "string" } } } } } }, "x-akamai": { "file-path": "schemas/contracts-array.yaml" } }, "reportingGroupId": { "description": "Identifies the reporting group.", "minimum": 0, "readOnly": true, "type": "integer" }, "reportingGroupName": { "description": "The descriptive label for the reporting group.", "minLength": 1, "type": "string" } }, "x-akamai": { "file-path": "schemas/reporting-group-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": "[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" } } ] }, "delete": { "description": "Deletes a specific reporting group.", "operationId": "delete-reporting-group", "summary": "Delete a reporting group", "tags": [ "Reporting groups" ], "externalDocs": { "description": "See documentation for this operation in Akamai's CP Codes and Reporting Groups API", "url": "https://techdocs.akamai.com/cp-codes/reference/delete-reporting-group" }, "responses": { "201": { "description": "Reporting group deleted successfully.", "content": { "*/*": {} } }, "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" } } ] }, "x-akamai": { "file-path": "paths/reporting-group.yaml", "path-for-file": "/reporting-groups/{reportingGroupId}" }, "parameters": [ { "description": "The identifier for the reporting group.", "example": "{{reportingGroupId}}", "in": "path", "name": "reportingGroupId", "required": true, "schema": { "example": 101010, "type": "integer" }, "x-akamai": { "file-path": "parameters/reportingGroupId-path.yaml" } } ] }, "/reporting-groups/{reportingGroupId}/products": { "get": { "description": "Lists products and services assigned to a specific reporting group.", "operationId": "get-reporting-group-products", "summary": "List products within a reporting group", "tags": [ "Products" ], "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-reporting-group-products" }, "responses": { "200": { "description": "Lists products and services assigned to a specific reporting group.", "content": { "application/json": { "example": { "products": [ { "productId": "Dev::Cloud", "productName": "Cloud development CD" }, { "productId": "AdvSite::Reporter", "productName": "Monitor site advance" } ] }, "schema": { "additionalProperties": false, "description": "Provides information about products and services assigned to a specific reporting group.", "type": "object", "required": [ "products" ], "properties": { "products": { "description": "A collection of products and services assigned to the reporting group.", "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.\n\n**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" } } }, "x-akamai": { "file-path": "schemas/reporting-group-products-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" } } ] }, "x-akamai": { "file-path": "paths/reporting-group-products.yaml", "path-for-file": "/reporting-groups/{reportingGroupId}/products" }, "parameters": [ { "description": "The identifier for the reporting group.", "example": "{{reportingGroupId}}", "in": "path", "name": "reportingGroupId", "required": true, "schema": { "example": 101010, "type": "integer" }, "x-akamai": { "file-path": "parameters/reportingGroupId-path.yaml" } } ] } }, "x-readme": { "samples-languages": [ "curl", "python", "node" ] }, "servers": [ { "url": "https://{hostname}/cprg/v1" } ] }