Akamai Bulk activations API

openapi: 3.0.0
info:
  title: 'Akamai: API Endpoint Definition Access tokens Bulk activations API'
  version: '2'
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://{hostname}/api-definitions/v2
tags:
- name: Bulk activations
paths:
  /bulk/activations:
    x-akamai:
      file-path: paths/bulk-activations.yaml
      path-for-file: /bulk/activations
    x-akamai-descriptor-tools:
      displayName: bulkPropertyActivations
      group: Bulk property activations
    post:
      description: Bulk activate a set of property versions. Alternately, perform a bulk [fallback](https://techdocs.akamai.com/property-mgr/reference/property-activation-error-handling) to the previous activation within an hour of the previous bulk activation. Base the set of versions to activate on the results of a [bulk patch](https://techdocs.akamai.com/property-mgr/reference/get-bulk-patch) operation, which you use in this operation's request. This operation launches an asynchronous process to update properties. To check its progress, run the [List bulk-activated properties](https://techdocs.akamai.com/property-mgr/reference/get-bulk-activation) operation, whose link is available in the `Location` header or `bulkActivationLink` member of this operation's response. See [Bulk Search and Update](https://techdocs.akamai.com/property-mgr/reference/bulk-search-and-update) for overall guidance on this feature.
      operationId: post-bulk-activations
      summary: Akamai Bulk Activate a Set of Properties
      tags:
      - Bulk activations
      externalDocs:
        description: See documentation for this operation in Akamai's Property Manager API
        url: https://techdocs.akamai.com/property-mgr/reference/post-bulk-activations
      requestBody:
        required: true
        content:
          application/json:
            example:
              defaultActivationSettings:
                acknowledgeAllWarnings: true
                fastPush: true
                useFastFallback: false
                notifyEmails:
                - you@example.com
                - them@example.com
              activatePropertyVersions:
              - network: STAGING
                note: Some activation note
                propertyId: prp_1
                propertyVersion: 2
              - network: STAGING
                note: Sample activation
                propertyId: prp_15
                propertyVersion: 3
                notifyEmails:
                - someoneElse@somewhere.com
              - acknowledgeAllWarnings: false
                network: PRODUCTION
                note: created by xyz
                propertyId: prp_3
                propertyVersion: 11
                acknowledgeWarnings:
                - msg_123
                - msg_234
            schema:
              $schema: http://json-schema.org/draft-04/schema#
              description: Encapsulates each batch of bulk activations. While essentially a wrapper for an activation object array, this specifies additional settings to apply to all activations within the batch.
              id: resource:/descriptors/papi/v1/schemas/CreateNewBulkActivationOrDeactivationRequestV0.json#
              javaType: com.akamai.devops.model.BulkPropertyActivationCreateRequest
              type: object
              required:
              - activatePropertyVersions
              properties:
                activatePropertyVersions:
                  description: Specifies each property version to include in the bulk activation. Following bulk activation, this reflects the activation state for each property.
                  type: array
                  items:
                    type: object
                    required:
                    - propertyId
                    - propertyVersion
                    - network
                    properties:
                      acknowledgeWarnings:
                        description: Lists property warning `messageId` values to acknowledge, unnecessary when `acknowledgeAllWarnings` is enabled.
                        type: array
                        items:
                          type: string
                      network:
                        description: The network on which to activate this property, either `STAGING` or `PRODUCTION`.
                        type: string
                        enum:
                        - STAGING
                        - PRODUCTION
                      note:
                        description: An optional log message for this property's activation.
                        type: string
                      propertyId:
                        description: Identifies each property targeted for activation. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `prp_` prefix. Don't use this value if you want to exchange data with the Identity and Access Manager API. See [Manage properties and includes](https://techdocs.akamai.com/iam-api/reference/manage-access-to-properties-and-includes).
                        pattern: ^(prp_|PRP_)?[0-9]+$
                        type: string
                      propertyVersion:
                        description: The property version targeted for activation. Once activated, you can no longer modify that version of the property.
                        minimum: 1
                        type: integer
                defaultActivationSettings:
                  description: Specifies activation settings to apply to all properties.
                  type: object
                  properties:
                    acknowledgeAllWarnings:
                      description: For all activations, skip acknowledging any warnings for all properties within the bulk activation job. Unless this is enabled, you need to specify `acknowledgeWarnings` arrays with `messageId` warning values for each activation.
                      type: boolean
                    fastPush:
                      default: true
                      description: Enable fast metadata push when bulk activating properties, `true` by default.
                      type: boolean
                    notifyEmails:
                      description: Email addresses to notify when the activation status changes for any property within the bulk activation. Note that you can supplement additional email addresses for each property you activate.
                      minItems: 0
                      type: array
                      items:
                        type: string
                    useFastFallback:
                      description: When enabled, rolls back to the previous activation of each property included in the bulk activation job. If you [bulk activate a set of properties](https://techdocs.akamai.com/property-mgr/reference/post-bulk-activations), and then within one hour discover a serious problem you didn't previously detect, enabling this in a follow-up bulk activation request effectively cancels all the activations. See [Revert a property activation](https://techdocs.akamai.com/property-mgr/reference/property-activation-error-handling) for guidance. Note that while the fast fallback option ordinarily doesn't apply to activations that affect a different set of hostnames, this scenario is unlikely when bulk-modifying properties.
                      type: boolean
              x-akamai:
                file-path: schemas/bulk-property-activation-create-request.yaml
      responses:
        '202':
          description: The response links the bulk activation process.
          content:
            application/json:
              example:
                bulkActivationLink: /papi/v0/bulk/activations/311?contractId=ctr_C-0N7RAC7&groupId=grp_15225
              schema:
                $schema: http://json-schema.org/draft-04/schema#
                additionalProperties: false
                description: Provides a hypermedia link to a newly created resource. The response's single member name indicates the type of resource.
                id: resource:/descriptors/papi/v1/schemas/PostBulkActivationResponse.json#
                type: object
                required:
                - bulkActivationLink
                properties:
                  bulkActivationLink:
                    description: Links the newly created bulk activation process.
                    type: string
                x-akamai:
                  file-path: schemas/bulk-property-activation-post-response.yaml
          headers:
            Location:
              description: Provides a URL path you can GET the newly created resource from.
              schema:
                type: string
              x-akamai:
                file-path: headers/Location.yaml
        '400':
          description: '[Bad request](https://techdocs.akamai.com/property-mgr/reference/400).'
          content:
            application/problem+json:
              example:
                detail: The system cannot understand your request.  Please check the syntax and correct any problems.
                instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
                status: 400
                title: Bad Request
                type: https://problems.luna.akamaiapis.net/papi/v0/http/bad-request
              schema:
                additionalProperties: false
                description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                type: object
                required:
                - type
                - title
                - status
                - detail
                - instance
                properties:
                  detail:
                    description: Diagnostic instructions to locate and fix the problem.
                    minLength: 1
                    type: string
                  errors:
                    description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
                    minItems: 0
                    type: array
                    uniqueItems: true
                    items:
                      additionalProperties: false
                      description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                      type: object
                      required:
                      - type
                      - title
                      - detail
                      properties:
                        detail:
                          description: Diagnostic instructions to locate and fix the problem.
                          minLength: 1
                          type: string
                        instance:
                          description: Unique value generated with each API call.
                          minLength: 1
                          type: string
                        status:
                          description: The HTTP status code that categorizes this error case.
                          maximum: 600
                          minimum: 100
                          type: integer
                        title:
                          description: A summary of each error case.
                          minLength: 1
                          type: string
                        type:
                          description: Identifies each error case.
                          format: uri
                          type: string
                      x-akamai:
                        file-path: schemas/problem-nested.yaml
                  instance:
                    description: Unique value generated with each API call.
                    minLength: 1
                    type: string
                  status:
                    description: The HTTP status code that categorizes this error case.
                    maximum: 600
                    minimum: 100
                    type: integer
                  title:
                    description: A summary of each error case.
                    minLength: 1
                    type: string
                  type:
                    description: Identifies each error case.
                    format: uri
                    type: string
                x-akamai:
                  file-path: schemas/problem.yaml
          x-akamai:
            file-path: errors/400.yaml
        '401':
          description: '[Unauthorized](https://techdocs.akamai.com/property-mgr/reference/401).'
          content:
            application/problem+json:
              example:
                detail: The request requires authentication.
                instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
                status: 401
                title: Unauthorized
                type: https://problems.luna.akamaiapis.net/papi/v0/http/unauthorized
              schema:
                additionalProperties: false
                description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                type: object
                required:
                - type
                - title
                - status
                - detail
                - instance
                properties:
                  detail:
                    description: Diagnostic instructions to locate and fix the problem.
                    minLength: 1
                    type: string
                  errors:
                    description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
                    minItems: 0
                    type: array
                    uniqueItems: true
                    items:
                      additionalProperties: false
                      description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                      type: object
                      required:
                      - type
                      - title
                      - detail
                      properties:
                        detail:
                          description: Diagnostic instructions to locate and fix the problem.
                          minLength: 1
                          type: string
                        instance:
                          description: Unique value generated with each API call.
                          minLength: 1
                          type: string
                        status:
                          description: The HTTP status code that categorizes this error case.
                          maximum: 600
                          minimum: 100
                          type: integer
                        title:
                          description: A summary of each error case.
                          minLength: 1
                          type: string
                        type:
                          description: Identifies each error case.
                          format: uri
                          type: string
                      x-akamai:
                        file-path: schemas/problem-nested.yaml
                  instance:
                    description: Unique value generated with each API call.
                    minLength: 1
                    type: string
                  status:
                    description: The HTTP status code that categorizes this error case.
                    maximum: 600
                    minimum: 100
                    type: integer
                  title:
                    description: A summary of each error case.
                    minLength: 1
                    type: string
                  type:
                    description: Identifies each error case.
                    format: uri
                    type: string
                x-akamai:
                  file-path: schemas/problem.yaml
          x-akamai:
            file-path: errors/401.yaml
        '403':
          description: '[Forbidden](https://techdocs.akamai.com/property-mgr/reference/403).'
          content:
            application/problem+json:
              example:
                detail: The authorization token you provided does not allow access to this resource.
                instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
                status: 403
                title: Forbidden
                type: https://problems.luna.akamaiapis.net/papi/v1/http/forbidden
              schema:
                additionalProperties: false
                description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                type: object
                required:
                - type
                - title
                - status
                - detail
                - instance
                properties:
                  detail:
                    description: Diagnostic instructions to locate and fix the problem.
                    minLength: 1
                    type: string
                  errors:
                    description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
                    minItems: 0
                    type: array
                    uniqueItems: true
                    items:
                      additionalProperties: false
                      description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                      type: object
                      required:
                      - type
                      - title
                      - detail
                      properties:
                        detail:
                          description: Diagnostic instructions to locate and fix the problem.
                          minLength: 1
                          type: string
                        instance:
                          description: Unique value generated with each API call.
                          minLength: 1
                          type: string
                        status:
                          description: The HTTP status code that categorizes this error case.
                          maximum: 600
                          minimum: 100
                          type: integer
                        title:
                          description: A summary of each error case.
                          minLength: 1
                          type: string
                        type:
                          description: Identifies each error case.
                          format: uri
                          type: string
                      x-akamai:
                        file-path: schemas/problem-nested.yaml
                  instance:
                    description: Unique value generated with each API call.
                    minLength: 1
                    type: string
                  status:
                    description: The HTTP status code that categorizes this error case.
                    maximum: 600
                    minimum: 100
                    type: integer
                  title:
                    description: A summary of each error case.
                    minLength: 1
                    type: string
                  type:
                    description: Identifies each error case.
                    format: uri
                    type: string
                x-akamai:
                  file-path: schemas/problem.yaml
          x-akamai:
            file-path: errors/403.yaml
        '404':
          description: '[Not found](https://techdocs.akamai.com/property-mgr/reference/404).'
          content:
            application/problem+json:
              example:
                detail: The system was unable to locate the requested resource.
                instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
                status: 404
                title: Not Found
                type: https://problems.luna.akamaiapis.net/papi/v1/http/not-found
              schema:
                additionalProperties: false
                description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                type: object
                required:
                - type
                - title
                - status
                - detail
                - instance
                properties:
                  detail:
                    description: Diagnostic instructions to locate and fix the problem.
                    minLength: 1
                    type: string
                  errors:
                    description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
                    minItems: 0
                    type: array
                    uniqueItems: true
                    items:
                      additionalProperties: false
                      description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                      type: object
                      required:
                      - type
                      - title
                      - detail
                      properties:
                        detail:
                          description: Diagnostic instructions to locate and fix the problem.
                          minLength: 1
                          type: string
                        instance:
                          description: Unique value generated with each API call.
                          minLength: 1
                          type: string
                        status:
                          description: The HTTP status code that categorizes this error case.
                          maximum: 600
                          minimum: 100
                          type: integer
                        title:
                          description: A summary of each error case.
                          minLength: 1
                          type: string
                        type:
                          description: Identifies each error case.
                          format: uri
                          type: string
                      x-akamai:
                        file-path: schemas/problem-nested.yaml
                  instance:
                    description: Unique value generated with each API call.
                    minLength: 1
                    type: string
                  status:
                    description: The HTTP status code that categorizes this error case.
                    maximum: 600
                    minimum: 100
                    type: integer
                  title:
                    description: A summary of each error case.
                    minLength: 1
                    type: string
                  type:
                    description: Identifies each error case.
                    format: uri
                    type: string
                x-akamai:
                  file-path: schemas/problem.yaml
          x-akamai:
            file-path: errors/404.yaml
        '405':
          description: '[Method not allowed](https://techdocs.akamai.com/property-mgr/reference/405).'
          content:
            application/problem+json:
              example:
                detail: The system does not support the method you provided for this resource.
                instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
                status: 405
                title: Method not allowed
                type: https://problems.luna.akamaiapis.net/papi/v1/http/method-not-allowed
              schema:
                additionalProperties: false
                description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                type: object
                required:
                - type
                - title
                - status
                - detail
                - instance
                properties:
                  detail:
                    description: Diagnostic instructions to locate and fix the problem.
                    minLength: 1
                    type: string
                  errors:
                    description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
                    minItems: 0
                    type: array
                    uniqueItems: true
                    items:
                      additionalProperties: false
                      description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                      type: object
                      required:
                      - type
                      - title
                      - detail
                      properties:
                        detail:
                          description: Diagnostic instructions to locate and fix the problem.
                          minLength: 1
                          type: string
                        instance:
                          description: Unique value generated with each API call.
                          minLength: 1
                          type: string
                        status:
                          description: The HTTP status code that categorizes this error case.
                          maximum: 600
                          minimum: 100
                          type: integer
                        title:
                          description: A summary of each error case.
                          minLength: 1
                          type: string
                        type:
                          description: Identifies each error case.
                          format: uri
                          type: string
                      x-akamai:
                        file-path: schemas/problem-nested.yaml
                  instance:
                    description: Unique value generated with each API call.
                    minLength: 1
                    type: string
                  status:
                    description: The HTTP status code that categorizes this error case.
                    maximum: 600
                    minimum: 100
                    type: integer
                  title:
                    description: A summary of each error case.
                    minLength: 1
                    type: string
                  type:
                    description: Identifies each error case.
                    format: uri
                    type: string
                x-akamai:
                  file-path: schemas/problem.yaml
          x-akamai:
            file-path: errors/405.yaml
        '406':
          description: '[Not acceptable](https://techdocs.akamai.com/property-mgr/reference/406).'
          content:
            application/problem+json:
              example:
                detail: The system does not support the content-type restrictions provided by your 'Accept' header.
                instance: papi/v1/build#abc12345abcc02a7
                status: 406
                title: Not Acceptable
                type: https://problems.luna.akamaiapis.net/papi/v1/http/not-acceptable
              schema:
                additionalProperties: false
                description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                type: object
                required:
                - type
                - title
                - status
                - detail
                - instance
                properties:
                  detail:
                    description: Diagnostic instructions to locate and fix the problem.
                    minLength: 1
                    type: string
                  errors:
                    description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
                    minItems: 0
                    type: array
                    uniqueItems: true
                    items:
                      additionalProperties: false
                      description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                      type: object
                      required:
                      - type
                      - title
                      - detail
                      properties:
                        detail:
                          description: Diagnostic instructions to locate and fix the problem.
                          minLength: 1
                          type: string
                        instance:
                          description: Unique value generated with each API call.
                          minLength: 1
                          type: string
                        status:
                          description: The HTTP status code that categorizes this error case.
                          maximum: 600
                          minimum: 100
                          type: integer
                        title:
                          description: A summary of each error case.
                          minLength: 1
                          type: string
                        type:
                          description: Identifies each error case.
                          format: uri
                          type: string
                      x-akamai:
                        file-path: schemas/problem-nested.yaml
                  instance:
                    description: Unique value generated with each API call.
                    minLength: 1
                    type: string
                  status:
                    description: The HTTP status code that categorizes this error case.
                    maximum: 600
                    minimum: 100
                    type: integer
                  title:
                    description: A summary of each error case.
                    minLength: 1
                    type: string
                  type:
                    description: Identifies each error case.
                    format: uri
                    type: string
                x-akamai:
                  file-path: schemas/problem.yaml
          x-akamai:
            file-path: errors/406.yaml
        '415':
          description: '[Unsupported media type](https://techdocs.akamai.com/property-mgr/reference/415).'
          content:
            application/problem+json:
              example:
                detail: Our system does not support requests in the format you're sending.
                instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
                status: 415
                title: Unsupported Media Type
                type: https://problems.luna.akamaiapis.net/papi/v1/http/unsupported-media-type
              schema:
                additionalProperties: false
                description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                type: object
                required:
                - type
                - title
                - status
                - detail
                - instance
                properties:
                  detail:
                    description: Diagnostic instructions to locate and fix the problem.
                    minLength: 1
                    type: string
                  errors:
                    description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
                    minItems: 0
                    type: array
                    uniqueItems: true
                    items:
                      additionalProperties: false
                      description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                      type: object
     

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