Akamai Products API

openapi: 3.0.0
info:
  title: 'Akamai: API Endpoint Definition Access tokens Products API'
  version: '2'
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://{hostname}/api-definitions/v2
tags:
- name: Products
paths:
  /reporting-groups/{reportingGroupId}/products:
    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
    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.


                            **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
  /products:
    x-akamai:
      file-path: paths/products.yaml
      path-for-file: /products
    x-akamai-descriptor-tools:
      displayName: products
      group: Products
    get:
      description: This operation lists the set of products that are available under a given contract. You need a product identifier to create new edge hostnames, CP codes, or properties. The assigned product determines the supported set of rule behaviors available within a property.
      operationId: get-products
      summary: Akamai List Products
      tags:
      - Products
      externalDocs:
        description: See documentation for this operation in Akamai's Property Manager API
        url: https://techdocs.akamai.com/property-mgr/reference/get-products
      responses:
        '200':
          description: The response lists products available in a contract.
          content:
            application/json:
              example:
                accountId: act_A-CCT7890
                contractId: ctr_C-0N7RAC7
                products:
                  items:
                  - productId: prd_Alta
                    productName: Alta
              schema:
                $schema: http://json-schema.org/draft-04/schema#
                additionalProperties: false
                description: A common outer wrapping object structure. It provides additional contextual details for a set of requested data. The data itself is available under various inner members' `items` array.
                id: resource:/descriptors/papi/v1/schemas/GetProductResponse.json#
                type: object
                properties:
                  accountId:
                    description: Identifies the prevailing account under which you requested the data. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `act_` prefix.
                    type: string
                  contractId:
                    description: Identifies the prevailing contract under which you requested the data. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `ctr_` prefix.
                    type: string
                  products:
                    additionalProperties: false
                    description: The set of requested products, available within an `items` array.
                    type: object
                    properties:
                      items:
                        description: Encapsulates information on the product that determines a property's available range of features. Relevant response objects appear within the outer envelope's `products.items` array.
                        type: array
                        items:
                          additionalProperties: false
                          type: object
                          required:
                          - productId
                          - productName
                          properties:
                            productId:
                              description: Identifies each product. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `prd_` prefix.
                              type: string
                            productName:
                              description: A descriptive name for the product.
                              type: string
                x-akamai:
                  file-path: schemas/product-get-response.yaml
        '400':
          description: '[Bad request](https://techdocs.akamai.com/property-mgr/reference/400).'
          content:
            application/problem+json:
              example:
                detail: The system cannot understand your request.  Please check the syntax and correct any problems.
                instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
                status: 400
                title: Bad Request
                type: https://problems.luna.akamaiapis.net/papi/v0/http/bad-request
              schema:
                additionalProperties: false
                description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                type: object
                required:
                - type
                - title
                - status
                - detail
                - instance
                properties:
                  detail:
                    description: Diagnostic instructions to locate and fix the problem.
                    minLength: 1
                    type: string
                  errors:
                    description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
                    minItems: 0
                    type: array
                    uniqueItems: true
                    items:
                      additionalProperties: false
                      description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                      type: object
                      required:
                      - type
                      - title
                      - detail
                      properties:
                        detail:
                          description: Diagnostic instructions to locate and fix the problem.
                          minLength: 1
                          type: string
                        instance:
                          description: Unique value generated with each API call.
                          minLength: 1
                          type: string
                        status:
                          description: The HTTP status code that categorizes this error case.
                          maximum: 600
                          minimum: 100
                          type: integer
                        title:
                          description: A summary of each error case.
                          minLength: 1
                          type: string
                        type:
                          description: Identifies each error case.
                          format: uri
                          type: string
                      x-akamai:
                        file-path: schemas/problem-nested.yaml
                  instance:
                    description: Unique value generated with each API call.
                    minLength: 1
                    type: string
                  status:
                    description: The HTTP status code that categorizes this error case.
                    maximum: 600
                    minimum: 100
                    type: integer
                  title:
                    description: A summary of each error case.
                    minLength: 1
                    type: string
                  type:
                    description: Identifies each error case.
                    format: uri
                    type: string
                x-akamai:
                  file-path: schemas/problem.yaml
          x-akamai:
            file-path: errors/400.yaml
        '401':
          description: '[Unauthorized](https://techdocs.akamai.com/property-mgr/reference/401).'
          content:
            application/problem+json:
              example:
                detail: The request requires authentication.
                instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
                status: 401
                title: Unauthorized
                type: https://problems.luna.akamaiapis.net/papi/v0/http/unauthorized
              schema:
                additionalProperties: false
                description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                type: object
                required:
                - type
                - title
                - status
                - detail
                - instance
                properties:
                  detail:
                    description: Diagnostic instructions to locate and fix the problem.
                    minLength: 1
                    type: string
                  errors:
                    description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
                    minItems: 0
                    type: array
                    uniqueItems: true
                    items:
                      additionalProperties: false
                      description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                      type: object
                      required:
                      - type
                      - title
                      - detail
                      properties:
                        detail:
                          description: Diagnostic instructions to locate and fix the problem.
                          minLength: 1
                          type: string
                        instance:
                          description: Unique value generated with each API call.
                          minLength: 1
                          type: string
                        status:
                          description: The HTTP status code that categorizes this error case.
                          maximum: 600
                          minimum: 100
                          type: integer
                        title:
                          description: A summary of each error case.
                          minLength: 1
                          type: string
                        type:
                          description: Identifies each error case.
                          format: uri
                          type: string
                      x-akamai:
                        file-path: schemas/problem-nested.yaml
                  instance:
                    description: Unique value generated with each API call.
                    minLength: 1
                    type: string
                  status:
                    description: The HTTP status code that categorizes this error case.
                    maximum: 600
                    minimum: 100
                    type: integer
                  title:
                    description: A summary of each error case.
                    minLength: 1
                    type: string
                  type:
                    description: Identifies each error case.
                    format: uri
                    type: string
                x-akamai:
                  file-path: schemas/problem.yaml
          x-akamai:
            file-path: errors/401.yaml
        '403':
          description: '[Forbidden](https://techdocs.akamai.com/property-mgr/reference/403).'
          content:
            application/problem+json:
              example:
                detail: The authorization token you provided does not allow access to this resource.
                instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
                status: 403
                title: Forbidden
                type: https://problems.luna.akamaiapis.net/papi/v1/http/forbidden
              schema:
                additionalProperties: false
                description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                type: object
                required:
                - type
                - title
                - status
                - detail
                - instance
                properties:
                  detail:
                    description: Diagnostic instructions to locate and fix the problem.
                    minLength: 1
                    type: string
                  errors:
                    description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
                    minItems: 0
                    type: array
                    uniqueItems: true
                    items:
                      additionalProperties: false
                      description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                      type: object
                      required:
                      - type
                      - title
                      - detail
                      properties:
                        detail:
                          description: Diagnostic instructions to locate and fix the problem.
                          minLength: 1
                          type: string
                        instance:
                          description: Unique value generated with each API call.
                          minLength: 1
                          type: string
                        status:
                          description: The HTTP status code that categorizes this error case.
                          maximum: 600
                          minimum: 100
                          type: integer
                        title:
                          description: A summary of each error case.
                          minLength: 1
                          type: string
                        type:
                          description: Identifies each error case.
                          format: uri
                          type: string
                      x-akamai:
                        file-path: schemas/problem-nested.yaml
                  instance:
                    description: Unique value generated with each API call.
                    minLength: 1
                    type: string
                  status:
                    description: The HTTP status code that categorizes this error case.
                    maximum: 600
                    minimum: 100
                    type: integer
                  title:
                    description: A summary of each error case.
                    minLength: 1
                    type: string
                  type:
                    description: Identifies each error case.
                    format: uri
                    type: string
                x-akamai:
                  file-path: schemas/problem.yaml
          x-akamai:
            file-path: errors/403.yaml
        '404':
          description: '[Not found](https://techdocs.akamai.com/property-mgr/reference/404).'
          content:
            application/problem+json:
              example:
                detail: The system was unable to locate the requested resource.
                instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
                status: 404
                title: Not Found
                type: https://problems.luna.akamaiapis.net/papi/v1/http/not-found
              schema:
                additionalProperties: false
                description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                type: object
                required:
                - type
                - title
                - status
                - detail
                - instance
                properties:
                  detail:
                    description: Diagnostic instructions to locate and fix the problem.
                    minLength: 1
                    type: string
                  errors:
                    description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
                    minItems: 0
                    type: array
                    uniqueItems: true
                    items:
                      additionalProperties: false
                      description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                      type: object
                      required:
                      - type
                      - title
                      - detail
                      properties:
                        detail:
                          description: Diagnostic instructions to locate and fix the problem.
                          minLength: 1
                          type: string
                        instance:
                          description: Unique value generated with each API call.
                          minLength: 1
                          type: string
                        status:
                    

# --- truncated at 32 KB (85 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/akamai/refs/heads/main/openapi/akamai-products-api-openapi.yml