openapi: 3.0.0
info:
title: 'Akamai: API Endpoint Definition Access tokens Hostname buckets 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: Hostname buckets
paths:
/properties/{propertyId}/hostname-activations:
x-akamai:
file-path: paths/property-hostname-activations.yaml
path-for-file: /properties/{propertyId}/hostname-activations
x-akamai-descriptor-tools:
displayName: hostnameActivations
group: Hostname activations
parameters:
- description: Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `prp_` prefix.
example: '{{propertyId}}'
in: path
name: propertyId
required: true
schema:
example: prp_12345
type: string
x-akamai:
file-path: parameters/propertyId-path.yaml
get:
description: For a property with `useHostnameBucket` set to `true` at [creation](https://techdocs.akamai.com/property-mgr/reference/post-properties), this lists the activations for all hostnames in the property's hostname bucket, on both production and staging networks. To view paginated results, use the response's `nextLink` and `previousLink`.
operationId: get-property-hostname-activations
summary: Akamai List Property Hostname Activations
tags:
- Hostname buckets
externalDocs:
description: See documentation for this operation in Akamai's Property Manager API
url: https://techdocs.akamai.com/property-mgr/reference/get-property-hostname-activations
responses:
'200':
description: The response lists activations of all hostnames in the property's hostname bucket.
content:
application/json:
example:
accountId: act_A-CCT9012
contractId: ctr_K-0N7RAK71
currentItemCount: 2
groupId: grp_15225
nextLink: /papi/v1/properties/prp_173136/hostnames-activation?offset=2&groupId=grp_15225&contractId=ctr_C-0N7RAC7&limit=2
totalItems: 4
hostnameActivations:
items:
- activationType: ACTIVATE
hostnameActivationId: atv_1696985
network: STAGING
note: Sample activation
propertyId: prp_173136
propertyName: example.com
propertyVersion: 1
status: ACTIVE
submitDate: '2014-03-05T02:22:12Z'
updateDate: '2014-03-04T21:12:57Z'
notifyEmails:
- you@example.com
- them@example.com
- activationType: ACTIVATE
hostnameActivationId: atv_1696986
network: PRODUCTION
note: Sample activation
propertyId: prp_173136
propertyName: example.com
propertyVersion: 1
status: PENDING
submitDate: '2014-03-02T02:22:12Z'
updateDate: '2014-03-01T21:12:57Z'
notifyEmails:
- you@example.com
- them@example.com
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/GetHostnameActivationListResponse.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.
minLength: 1
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.
minLength: 1
type: string
currentItemCount:
description: The total count of items present in the current response body for requested criteria.
type: integer
groupId:
description: Identifies the prevailing group 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 `grp_` prefix.
minLength: 1
type: string
hostnameActivations:
additionalProperties: false
description: The set of requested property hostname activations, available within an `items` array.
type: object
properties:
currentItemCount:
description: The number of items present in the current response body view.
minimum: 0
type: integer
items:
description: Activated property hostnames on a specific network. Relevant response objects appear within the outer envelope's `activations.items` array.
type: array
items:
additionalProperties: false
required:
- hostnameActivationId
- activationType
- network
- note
- notifyEmails
- propertyId
- propertyName
- status
- submitDate
- updateDate
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
activationType:
default: ACTIVATE
description: Either `ACTIVATE` or `DEACTIVATE`. The default is `ACTIVATE`. Any new activation automatically deactivates the current activation. Note that if you were to POST a `DEACTIVATE` type on an active property hostname, it would no longer serve any traffic. You'd need to modify your DNS configuration and specify a different way to field the traffic.
type: string
enum:
- ACTIVATE
- DEACTIVATE
groupId:
description: Identifies the prevailing group 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 `grp_` prefix.
type: string
hostnameActivationId:
description: The property hostname activation's unique identifier. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `atv_` prefix.
type: string
network:
description: The network to activate on, either `STAGING` or `PRODUCTION`.
type: string
enum:
- STAGING
- PRODUCTION
note:
description: Assigns a log message to the activation request.
type: string
notifyEmails:
description: Email addresses to notify when the activation status changes.
minItems: 0
type: array
items:
type: string
propertyId:
description: Unique identifier for the property with the hostname bucket the activated property hostnames belong to. 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).
type: string
propertyName:
description: A descriptive name for the property with the hostname bucket the activated property hostnames belong to.
type: string
propertyVersion:
description: The version of the property to activate hostnames for.
minimum: 1
type: integer
status:
description: The activation's status. `ACTIVE` if currently serving traffic. `INACTIVE` if another activation has superseded this one. `PENDING` if not yet active. `ABORTED` if the client followed up with a [DELETE request](https://techdocs.akamai.com/property-mgr/reference/delete-property-hostname-activations) in time. `FAILED` if the activation causes a range of edge network errors that [may cause a fallback to the previous activation](https://techdocs.akamai.com/property-mgr/reference/property-activation-error-handling). `PENDING_DEACTIVATION` or `DEACTIVATED` when the `activationType` is `DEACTIVATE` to no longer serve traffic.
type: string
enum:
- ACTIVE
- INACTIVE
- PENDING
- ABORTED
- FAILED
- DEACTIVATED
- PENDING_DEACTIVATION
submitDate:
description: A date stamp marking when the activation initiated.
readOnly: true
type: string
updateDate:
description: A date stamp marking when the `status` last changed.
readOnly: true
type: string
nextLink:
description: For paginated responses, this links to the next set of response items.
type: string
previousLink:
description: For paginated responses, this links to the next set of response items.
type: string
totalItems:
description: The total count of items returned for the requested criteria.
minimum: 0
type: integer
nextLink:
description: The link to next set of response items for paginated response.
minLength: 1
type: string
prevLink:
description: The link to previous set of response items for paginated response.
minLength: 1
type: string
totalItems:
description: The total count of items for requested criteria.
type: integer
x-akamai:
file-path: schemas/property-hostnames-activation-list-response.yaml
'400':
description: '[Bad request](https://techdocs.akamai.com/property-mgr/reference/400).'
content:
application/problem+json:
example:
detail: The system cannot understand your request. Please check the syntax and correct any problems.
instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
status: 400
title: Bad Request
type: https://problems.luna.akamaiapis.net/papi/v0/http/bad-request
schema:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- status
- detail
- instance
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
errors:
description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
minItems: 0
type: array
uniqueItems: true
items:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- detail
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-nested.yaml
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem.yaml
x-akamai:
file-path: errors/400.yaml
'401':
description: '[Unauthorized](https://techdocs.akamai.com/property-mgr/reference/401).'
content:
application/problem+json:
example:
detail: The request requires authentication.
instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
status: 401
title: Unauthorized
type: https://problems.luna.akamaiapis.net/papi/v0/http/unauthorized
schema:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- status
- detail
- instance
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
errors:
description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
minItems: 0
type: array
uniqueItems: true
items:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- detail
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-nested.yaml
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem.yaml
x-akamai:
file-path: errors/401.yaml
'403':
description: '[Forbidden](https://techdocs.akamai.com/property-mgr/reference/403).'
content:
application/problem+json:
example:
detail: The authorization token you provided does not allow access to this resource.
instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
status: 403
title: Forbidden
type: https://problems.luna.akamaiapis.net/papi/v1/http/forbidden
schema:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- status
- detail
- instance
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
errors:
description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
minItems: 0
type: array
uniqueItems: true
items:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- detail
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-nested.yaml
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem.yaml
x-akamai:
file-path: errors/403.yaml
'404':
description: '[Not found](https://techdocs.akamai.com/property-mgr/reference/404).'
content:
application/problem+json:
example:
detail: The system was unable to locate the requested resource.
instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
status: 404
title: Not Found
type: https://problems.luna.akamaiapis.net/papi/v1/http/not-found
schema:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- status
- detail
- instance
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
errors:
description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
minItems: 0
type: array
uniqueItems: true
items:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- detail
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-nested.yaml
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem.yaml
x-akamai:
file-path: errors/404.yaml
'405':
description: '[Method not allowed](https://techdocs.akamai.com/property-mgr/reference/405).'
content:
application/problem+json:
example:
detail: The system does not support the method you provided for this resource.
instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
status: 405
title: Method not allowed
type: https://problems.luna.akamaiapis.net/papi/v1/http/method-not-allowed
schema:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- status
- detail
- instance
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
errors:
description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
minItems: 0
type: array
uniqueItems: true
items:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- detail
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-nested.yaml
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem.yaml
x-akamai:
file-path: errors/405.yaml
'406':
description: '[Not acceptable](https://techdocs.akamai.com/property-mgr/reference/406).'
content:
application/problem+json:
example:
detail: The system does not support the content-type restrictions provided by your 'Accept' header.
instance: papi/v1/build#abc12345abcc02a7
status: 406
title: Not Acceptable
type: https://problems.luna.akamaiapis.net/papi/v1/http/not-acceptable
schema:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- status
- detail
- instance
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
errors:
description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
minItems: 0
type: array
uniqueItems: true
items:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- detail
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-nested.yaml
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem.yaml
x-akamai:
file-path: errors/406.yaml
'429':
description: '[Too many requests](https://techdocs.akamai.com/property-mgr/reference/429).'
content:
application/problem+json:
example:
detail: Too many includes exist on contract ctr_1-12345. You must delete an include before continuing.
instance: /papi/v1/includes?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
instanceKey: 1-12345
limit: 500
limitKey: INCLUDES_PER_CONTRACT
remaining: 0
status: 429
title: Too many includes
type: https://problems.luna.akamaiapis.net/papi/v1/limit-exceeded
schema:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- status
- detail
- instance
- limitKey
- instanceKey
- limit
- remaining
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
errors:
description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
minItems: 0
type: array
uniqueItems: true
items:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- detail
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-nested.yaml
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
instanceKey:
description: Identifies the resource the limit is imposed on.
minLength: 1
type: string
limit:
description: The overall limit.
type: integer
limitKey:
description: The limit that got exceeded with the operation.
minLength: 1
type: string
remaining:
description: Number of items left to deploy.
type: integer
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-429.yaml
x-akamai:
file-path: errors/429.yaml
'500':
description: '[Internal server error](https://techdocs.akamai.com/property-mgr/reference/500).'
content:
application/problem+json:
example:
detail: Our system is experiencing errors. We''ll get this fixed as soon as possible.
instance: /papi/v1/properties/12345/activations#abc12345abcc02a7
status: 500
title: Internal Server Error
type: https://problems.luna.akamaiapis.net/papi/proxy/internal-server-error
schema:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- status
- detail
- instance
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
errors:
description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
minItems: 0
type: array
uniqueItems: true
items:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- detail
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-nested.yaml
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem.yaml
x-akamai:
file-path: errors/500.yaml
parameters:
- description: __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to `false` when exchanging PAPI data with other APIs.
example: '{{PAPI-Use-Prefixes}}'
in: header
name: PAPI-Use-Prefixes
required: true
schema:
example: 'false'
type: string
enum:
- 'true'
- 'false'
x-akamai:
file-path: parameters/PAPI-Use-Prefixes-header.yaml
- description: For paginated responses, specifies the page of results you want to navigate to, starting from `0`.
example: '{{offset}}'
in: query
name: offset
required: false
schema:
example: 10
minimum: 0
type: integer
x-akamai:
file-path: parameters/offset-query.yaml
- description: For paginated responses, specifies the number of `hostnames` objects to include on each page.
example: '{{limit}}'
in: query
name: limit
required: false
schema:
example: 50
minimum: 1
type: integer
x-akamai:
file-path: parameters/limit-optional.yaml
- description: Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it along with the `groupId`. In other operations that don't specify a `propertyId` URL parameter, this parameter is always required. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix.
example: '{{contractId}}'
in: query
name: contractId
required: false
schema:
example: ctr_1-1TJZFW
type: string
x-akamai:
file-path: parameters/contractId-optional.yaml
- description: Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along with the `contractId`. In other operations that don't specify a `propertyId` URL parameter, this parameter is always required. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix.
example: '{{groupId}}'
in: query
name: groupId
required: false
schema:
example: grp_15166
type: string
x-akamai:
file-path: parameters/groupId-optional.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
/properties/{propertyId}/hostname-activations/{hostnameActivationId}:
x-akamai:
file-path: paths/property-hostname-activation.yaml
path-for-file: /properties/{propertyId}/hostname-activations/{hostnameActivationId}
x-akamai-descriptor-tools:
displayName: hostnameActivation
group: Hostname activations
parameters:
- description: Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `prp_` prefix.
example: '{{propertyId}}'
in: path
name: propertyId
required: true
schema:
example: prp_12345
type: string
x-akamai:
file-path: parameters/propertyId-path.yaml
- description: Unique identifier for the hostname activation.
example: '{{hostnameActivationId}}'
in: path
name: hostnameActivationId
required: true
schema:
example: atv_1696985
type: string
x-akamai:
file-path: parameters/hostnameActivationId-path.yaml
get:
description: For a property with `useHostnameBucket` set to `true` at [creation](https://techdocs.akamai.com/property-mgr/reference/post-properties), this operation gets details about a specific property hostname activation. You typically get a single activation from an `activationLink` when [launching a new property hostname activation](https://techdocs.akamai.com/property-mgr/reference/patch-property-hostnames) and following up to poll its `status`. For property hostname activations whose `status` is `PENDING`, a `Retry-After` header provides an estimate for when it's likely to change.
operationId: get-property-hostname-activation
summary: Akamai Get a Property Hostname Activation
tags:
- Hostname buckets
externalDocs:
description: See documentation for this operation in Akamai's Property Manager API
url: https://techdocs.akamai.com/property-mgr/reference/get-property-hostname-activation
responses:
'200':
description: The response shows the property hostname activation details.
content:
application/json:
example:
accountId: act_A-CCT1234
contractId: ctr_C-0N7RAC71
groupId: grp_15225
activations:
items:
- activationId: atv_1696985
activationType: ACTIVATE
fmaActivationState: steady
network: STAGING
note: Sample activation
propertyId: prp_173136
propertyName: example.com
propertyVersion: 1
status: PENDING
submitDate: '2014-03-02T02:22:12Z'
updateDate: '2014-03-01T21:12:57Z'
notifyEmails:
- you@example.com
- them@example.com
fallbackInfo:
canFastFallback: true
fallbackVersion: 10
fastFallbackAttempted: false
fastFallbackExpirationTime: 1506451772
fastFallbackRecoveryState: null
steadyStateTime: 1506448172
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/GetHostnamesBucketActivationResponse.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.
minLength: 1
type: string
activations:
description: The set of activated hostnames.
type: object
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.
minLength: 1
type: string
groupId:
description: Identifies the prevailing group 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 `grp_` prefix.
minLength: 1
type: string
hostnameActivations:
additionalProperties: false
description: The set of requested property hostname activations, available within an `items` array.
type: object
properties:
currentItemCount:
description: The number of items present in the current response body view.
minimum: 0
type: integer
items:
description: Activated property hostnames on a specific network. Relevant response objects appear within the outer envelope's `activations.items` array.
type: array
items:
additionalProperties: false
type: object
required:
- activationType
- network
- note
- notifyEmails
- propertyId
- propertyName
- status
- submitDate
- updateDate
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
activationId:
description: The property hostname activation's unique identifier. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `atv_` prefix.
type: string
activationType:
default: ACTIVATE
description: Either `ACTIVATE` or `DEACTIVATE`. The default is `ACTIVATE`. Any new activation automatically deactivates the current activation. Note that if you were to POST a `DEACTIVATE` type on an active property hostname, it would no longer serve any traffic. You'd need to modify your DNS configuration and specify a different way to field the traffic.
type: string
enum:
- ACTIVATE
- DEACTIVATE
fallbackInfo:
additionalProperties: false
description: Encapsulates information about fast fallback. You can use it to fall back to a previous activation when POSTing an activation with `useFastFallback` enabled.
type: object
required:
- canFastFallback
- fallbackVersion
- fastFallbackAttempted
- fastFallbackExpirationTime
- fastFallbackRecoveryState
- steadyStateTime
properties:
canFastFallback:
description: Whether the current activation can fallback to a previous version. This is typically `false` for new properties, or for property versions whose set of hostnames has changed.
type: boolean
fallbackVersion:
description: Indicates the property version that activates when a fast fallback succeeds.
minimum: 1
type: integer
fastFallbackAttempted:
description: Whether a fast fallback has already been attempted on this activation.
type: boolean
fastFallbackExpirationTime:
description: Epoch second timestamp marking when fast fallback is no longer possible for this activation.
type: integer
fastFallbackRecoveryState:
description: Represents additional information available for any attempted fallback.
nullable: true
type:
- string
- 'null'
propertyVersion:
description: The version for which fast fallback may be available.
minimum: 1
type: integer
steadyStateTime:
description: Epoch second timestamp marking when the activation completed, signaled by an `fmaActivationState` of `steady`.
type: integer
fmaActivationState:
description: Indicates fast metadata activation state. A value of `steady` indicates the property is currently active or has been cancelled. Values of `received`, `lived`, and `deployed` represent progressive stages of activation, while `cancelling` happens either after failing a network safety check or in response to a [DELETE operation](https://techdocs.akamai.com/property-mgr/reference/delete-property-activation). Note that the `status` member indicates whether the activation is live.
type: string
enum:
- steady
- received
- lived
- deployed
- cancelling
groupId:
description: Identifies the prevailing group 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 `grp_` prefix.
type: string
hostnameActivationId:
description: The property hostname activation's unique identifier. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `atv_` prefix.
type: string
network:
description: The network to activate on, either `STAGING` or `PRODUCTION`.
type: string
enum:
- STAGING
- PRODUCTION
note:
description: Assigns a log message to the activation request.
type: string
notifyEmails:
description: Email addresses to notify when the activation status changes.
minItems: 0
type: array
items:
type: string
propertyId:
description: Unique identifier for the property with the hostname bucket the activated property hostnames belong to. 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).
type: string
propertyName:
description: A descriptive name for the property with the hostname bucket the activated property hostnames belong to.
type: string
propertyVersion:
description: The property version targeted with activation. Once activated, you can no longer modify that version of the property.
minimum: 1
type: integer
status:
description: The activation's status. `ACTIVE` if currently serving traffic. `INACTIVE` if another activation has superseded this one. `PENDING` if not yet active. `ABORTED` if the client followed up with a [DELETE request](https://techdocs.akamai.com/property-mgr/reference/delete-property-hostname-activations) in time. `FAILED` if the activation causes a range of edge network errors that [may cause a fallback to the previous activation](https://techdocs.akamai.com/property-mgr/reference/property-activation-error-handling). `PENDING_DEACTIVATION` or `DEACTIVATED` when the `activationType` is `DEACTIVATE` to no longer serve traffic.
type: string
enum:
- ACTIVE
- INACTIVE
- PENDING
- ABORTED
- FAILED
- DEACTIVATED
- PENDING_DEACTIVATION
submitDate:
description: A date stamp marking when the activation initiated.
readOnly: true
type: string
updateDate:
description: A date stamp marking when the `status` last changed.
readOnly: true
type: string
nextLink:
description: For paginated responses, this links to the next set of response items.
type: string
previousLink:
description: For paginated responses, this links to the next set of response items.
type: string
totalItems:
description: The total count of items returned for the requested criteria.
minimum: 0
type: integer
x-akamai:
file-path: schemas/property-hostnames-activation-get-response.yaml
headers:
Retry-After:
description: For activations whose `status` remains `PENDING`, this specifies the number of seconds it will likely take to go live.
schema:
type: string
x-akamai:
file-path: headers/Retry-After.yaml
'400':
description: '[Bad request](https://techdocs.akamai.com/property-mgr/reference/400).'
content:
application/problem+json:
example:
detail: The system cannot understand your request. Please check the syntax and correct any problems.
instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
status: 400
title: Bad Request
type: https://problems.luna.akamaiapis.net/papi/v0/http/bad-request
schema:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- status
- detail
- instance
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
errors:
description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
minItems: 0
type: array
uniqueItems: true
items:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- detail
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-nested.yaml
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem.yaml
x-akamai:
file-path: errors/400.yaml
'401':
description: '[Unauthorized](https://techdocs.akamai.com/property-mgr/reference/401).'
content:
application/problem+json:
example:
detail: The request requires authentication.
instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
status: 401
title: Unauthorized
type: https://problems.luna.akamaiapis.net/papi/v0/http/unauthorized
schema:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- status
- detail
- instance
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
errors:
description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
minItems: 0
type: array
uniqueItems: true
items:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- detail
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-nested.yaml
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem.yaml
x-akamai:
file-path: errors/401.yaml
'403':
description: '[Forbidden](https://techdocs.akamai.com/property-mgr/reference/403).'
content:
application/problem+json:
example:
detail: The authorization token you provided does not allow access to this resource.
instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
status: 403
title: Forbidden
type: https://problems.luna.akamaiapis.net/papi/v1/http/forbidden
schema:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- status
- detail
- instance
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
errors:
description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
minItems: 0
type: array
uniqueItems: true
items:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- detail
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-nested.yaml
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem.yaml
x-akamai:
file-path: errors/403.yaml
'404':
description: '[Not found](https://techdocs.akamai.com/property-mgr/reference/404).'
content:
application/problem+json:
example:
detail: The system was unable to locate the requested resource.
instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
status: 404
title: Not Found
type: https://problems.luna.akamaiapis.net/papi/v1/http/not-found
schema:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- status
- detail
- instance
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
errors:
description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
minItems: 0
type: array
uniqueItems: true
items:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- detail
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-nested.yaml
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem.yaml
x-akamai:
file-path: errors/404.yaml
'405':
description: '[Method not allowed](https://techdocs.akamai.com/property-mgr/reference/405).'
content:
application/problem+json:
example:
detail: The system does not support the method you provided for this resource.
instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
status: 405
title: Method not allowed
type: https://problems.luna.akamaiapis.net/papi/v1/http/method-not-allowed
schema:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- status
- detail
- instance
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
errors:
description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
minItems: 0
type: array
uniqueItems: true
items:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- detail
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-nested.yaml
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem.yaml
x-akamai:
file-path: errors/405.yaml
'406':
description: '[Not acceptable](https://techdocs.akamai.com/property-mgr/reference/406).'
content:
application/problem+json:
example:
detail: The system does not support the content-type restrictions provided by your 'Accept' header.
instance: papi/v1/build#abc12345abcc02a7
status: 406
title: Not Acceptable
type: https://problems.luna.akamaiapis.net/papi/v1/http/not-acceptable
schema:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- status
- detail
- instance
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
errors:
description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
minItems: 0
type: array
uniqueItems: true
items:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- detail
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-nested.yaml
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem.yaml
x-akamai:
file-path: errors/406.yaml
'429':
description: '[Too many requests](https://techdocs.akamai.com/property-mgr/reference/429).'
content:
application/problem+json:
example:
detail: Too many includes exist on contract ctr_1-12345. You must delete an include before continuing.
instance: /papi/v1/includes?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
instanceKey: 1-12345
limit: 500
limitKey: INCLUDES_PER_CONTRACT
remaining: 0
status: 429
title: Too many includes
type: https://problems.luna.akamaiapis.net/papi/v1/limit-exceeded
schema:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- status
- detail
- instance
- limitKey
- instanceKey
- limit
- remaining
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
errors:
description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
minItems: 0
type: array
uniqueItems: true
items:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- detail
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-nested.yaml
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
instanceKey:
description: Identifies the resource the limit is imposed on.
minLength: 1
type: string
limit:
description: The overall limit.
type: integer
limitKey:
description: The limit that got exceeded with the operation.
minLength: 1
type: string
remaining:
description: Number of items left to deploy.
type: integer
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-429.yaml
x-akamai:
file-path: errors/429.yaml
'500':
description: '[Internal server error](https://techdocs.akamai.com/property-mgr/reference/500).'
content:
application/problem+json:
example:
detail: Our system is experiencing errors. We''ll get this fixed as soon as possible.
instance: /papi/v1/properties/12345/activations#abc12345abcc02a7
status: 500
title: Internal Server Error
type: https://problems.luna.akamaiapis.net/papi/proxy/internal-server-error
schema:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- status
- detail
- instance
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
errors:
description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
minItems: 0
type: array
uniqueItems: true
items:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- detail
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-nested.yaml
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem.yaml
x-akamai:
file-path: errors/500.yaml
parameters:
- description: __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to `false` when exchanging PAPI data with other APIs.
example: '{{PAPI-Use-Prefixes}}'
in: header
name: PAPI-Use-Prefixes
required: true
schema:
example: 'false'
type: string
enum:
- 'true'
- 'false'
x-akamai:
file-path: parameters/PAPI-Use-Prefixes-header.yaml
- description: Whether the response should include the property hostnames associated with an activation and the related certificate status on staging and production networks.
example: '{{includeHostnames}}'
in: query
name: includeHostnames
required: false
schema:
default: false
example: false
type: boolean
x-akamai:
file-path: parameters/includeHostnames-query.yaml
- description: Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix.
example: '{{contractId}}'
in: query
name: contractId
required: true
schema:
example: ctr_1-1TJZFW
type: string
x-akamai:
file-path: parameters/contractId-required.yaml
- description: Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix.
example: '{{groupId}}'
in: query
name: groupId
required: true
schema:
example: grp_15166
type: string
x-akamai:
file-path: parameters/groupId-required.yaml
- description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).
example: '{{accountSwitchKey}}'
in: query
name: accountSwitchKey
required: false
schema:
example: 1-5C0YLB:1-8BYUX
type: string
delete:
description: For a property with `useHostnameBucket` set to `true` [when created](https://techdocs.akamai.com/property-mgr/reference/post-properties), if you detect a problem with a property hostname while its activation is still `PENDING`, use this operation to cancel it. Make a DELETE request on the `activationLink` you get from the [Add or remove hostnames for a property](https://techdocs.akamai.com/property-mgr/reference/patch-property-hostnames) operation's response. Once you DELETE the activation, it no longer appears in the [list of activations](https://techdocs.akamai.com/property-mgr/reference/get-property-hostname-activations), but you can still [access it individually](https://techdocs.akamai.com/property-mgr/reference/get-property-hostname-activation).
operationId: delete-property-hostname-activations
summary: Akamai Cancel a Pending Property Hostname Activation
tags:
- Hostname buckets
externalDocs:
description: See documentation for this operation in Akamai's Property Manager API
url: https://techdocs.akamai.com/property-mgr/reference/delete-property-hostname-activations
responses:
'200':
description: The response shows a status of the cancelled hostname activation for the specified property.
content:
application/json:
example:
hostnameActivations:
items:
- accountId: act_A-CCT7890
activationType: ACTIVATE
groupId: grp_15225
hostnameActivationId: atv_1696985
network: STAGING
note: Sample activation cancellation
propertyId: prp_173136
propertyName: example.com
propertyVersion: 1
status: ABORTED
submitDate: '2014-03-02T02:22:12Z'
updateDate: '2014-03-01T21:12:57Z'
notifyEmails:
- you@example.com
- them@example.com
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/GetHostnamesBucketActivationResponse.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.
minLength: 1
type: string
activations:
description: The set of activated hostnames.
type: object
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.
minLength: 1
type: string
groupId:
description: Identifies the prevailing group 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 `grp_` prefix.
minLength: 1
type: string
hostnameActivations:
additionalProperties: false
description: The set of requested property hostname activations, available within an `items` array.
type: object
properties:
currentItemCount:
description: The number of items present in the current response body view.
minimum: 0
type: integer
items:
description: Activated property hostnames on a specific network. Relevant response objects appear within the outer envelope's `activations.items` array.
type: array
items:
additionalProperties: false
type: object
required:
- activationType
- network
- note
- notifyEmails
- propertyId
- propertyName
- status
- submitDate
- updateDate
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
activationId:
description: The property hostname activation's unique identifier. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `atv_` prefix.
type: string
activationType:
default: ACTIVATE
description: Either `ACTIVATE` or `DEACTIVATE`. The default is `ACTIVATE`. Any new activation automatically deactivates the current activation. Note that if you were to POST a `DEACTIVATE` type on an active property hostname, it would no longer serve any traffic. You'd need to modify your DNS configuration and specify a different way to field the traffic.
type: string
enum:
- ACTIVATE
- DEACTIVATE
fallbackInfo:
additionalProperties: false
description: Encapsulates information about fast fallback. You can use it to fall back to a previous activation when POSTing an activation with `useFastFallback` enabled.
type: object
required:
- canFastFallback
- fallbackVersion
- fastFallbackAttempted
- fastFallbackExpirationTime
- fastFallbackRecoveryState
- steadyStateTime
properties:
canFastFallback:
description: Whether the current activation can fallback to a previous version. This is typically `false` for new properties, or for property versions whose set of hostnames has changed.
type: boolean
fallbackVersion:
description: Indicates the property version that activates when a fast fallback succeeds.
minimum: 1
type: integer
fastFallbackAttempted:
description: Whether a fast fallback has already been attempted on this activation.
type: boolean
fastFallbackExpirationTime:
description: Epoch second timestamp marking when fast fallback is no longer possible for this activation.
type: integer
fastFallbackRecoveryState:
description: Represents additional information available for any attempted fallback.
nullable: true
type:
- string
- 'null'
propertyVersion:
description: The version for which fast fallback may be available.
minimum: 1
type: integer
steadyStateTime:
description: Epoch second timestamp marking when the activation completed, signaled by an `fmaActivationState` of `steady`.
type: integer
fmaActivationState:
description: Indicates fast metadata activation state. A value of `steady` indicates the property is currently active or has been cancelled. Values of `received`, `lived`, and `deployed` represent progressive stages of activation, while `cancelling` happens either after failing a network safety check or in response to a [DELETE operation](https://techdocs.akamai.com/property-mgr/reference/delete-property-activation). Note that the `status` member indicates whether the activation is live.
type: string
enum:
- steady
- received
- lived
- deployed
- cancelling
groupId:
description: Identifies the prevailing group 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 `grp_` prefix.
type: string
hostnameActivationId:
description: The property hostname activation's unique identifier. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `atv_` prefix.
type: string
network:
description: The network to activate on, either `STAGING` or `PRODUCTION`.
type: string
enum:
- STAGING
- PRODUCTION
note:
description: Assigns a log message to the activation request.
type: string
notifyEmails:
description: Email addresses to notify when the activation status changes.
minItems: 0
type: array
items:
type: string
propertyId:
description: Unique identifier for the property with the hostname bucket the activated property hostnames belong to. 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).
type: string
propertyName:
description: A descriptive name for the property with the hostname bucket the activated property hostnames belong to.
type: string
propertyVersion:
description: The property version targeted with activation. Once activated, you can no longer modify that version of the property.
minimum: 1
type: integer
status:
description: The activation's status. `ACTIVE` if currently serving traffic. `INACTIVE` if another activation has superseded this one. `PENDING` if not yet active. `ABORTED` if the client followed up with a [DELETE request](https://techdocs.akamai.com/property-mgr/reference/delete-property-hostname-activations) in time. `FAILED` if the activation causes a range of edge network errors that [may cause a fallback to the previous activation](https://techdocs.akamai.com/property-mgr/reference/property-activation-error-handling). `PENDING_DEACTIVATION` or `DEACTIVATED` when the `activationType` is `DEACTIVATE` to no longer serve traffic.
type: string
enum:
- ACTIVE
- INACTIVE
- PENDING
- ABORTED
- FAILED
- DEACTIVATED
- PENDING_DEACTIVATION
submitDate:
description: A date stamp marking when the activation initiated.
readOnly: true
type: string
updateDate:
description: A date stamp marking when the `status` last changed.
readOnly: true
type: string
nextLink:
description: For paginated responses, this links to the next set of response items.
type: string
previousLink:
description: For paginated responses, this links to the next set of response items.
type: string
totalItems:
description: The total count of items returned for the requested criteria.
minimum: 0
type: integer
x-akamai:
file-path: schemas/property-hostnames-activation-get-response.yaml
'400':
description: '[Bad request](https://techdocs.akamai.com/property-mgr/reference/400).'
content:
application/problem+json:
example:
detail: The system cannot understand your request. Please check the syntax and correct any problems.
instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
status: 400
title: Bad Request
type: https://problems.luna.akamaiapis.net/papi/v0/http/bad-request
schema:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- status
- detail
- instance
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
errors:
description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
minItems: 0
type: array
uniqueItems: true
items:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- detail
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-nested.yaml
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem.yaml
x-akamai:
file-path: errors/400.yaml
'401':
description: '[Unauthorized](https://techdocs.akamai.com/property-mgr/reference/401).'
content:
application/problem+json:
example:
detail: The request requires authentication.
instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
status: 401
title: Unauthorized
type: https://problems.luna.akamaiapis.net/papi/v0/http/unauthorized
schema:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- status
- detail
- instance
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
errors:
description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
minItems: 0
type: array
uniqueItems: true
items:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- detail
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-nested.yaml
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem.yaml
x-akamai:
file-path: errors/401.yaml
'403':
description: '[Forbidden](https://techdocs.akamai.com/property-mgr/reference/403).'
content:
application/problem+json:
example:
detail: The authorization token you provided does not allow access to this resource.
instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
status: 403
title: Forbidden
type: https://problems.luna.akamaiapis.net/papi/v1/http/forbidden
schema:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- status
- detail
- instance
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
errors:
description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
minItems: 0
type: array
uniqueItems: true
items:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- detail
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-nested.yaml
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem.yaml
x-akamai:
file-path: errors/403.yaml
'404':
description: '[Not found](https://techdocs.akamai.com/property-mgr/reference/404).'
content:
application/problem+json:
example:
detail: The system was unable to locate the requested resource.
instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
status: 404
title: Not Found
type: https://problems.luna.akamaiapis.net/papi/v1/http/not-found
schema:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- status
- detail
- instance
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
errors:
description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
minItems: 0
type: array
uniqueItems: true
items:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- detail
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-nested.yaml
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem.yaml
x-akamai:
file-path: errors/404.yaml
'405':
description: '[Method not allowed](https://techdocs.akamai.com/property-mgr/reference/405).'
content:
application/problem+json:
example:
detail: The system does not support the method you provided for this resource.
instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
status: 405
title: Method not allowed
type: https://problems.luna.akamaiapis.net/papi/v1/http/method-not-allowed
schema:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- status
- detail
- instance
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
errors:
description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
minItems: 0
type: array
uniqueItems: true
items:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- detail
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-nested.yaml
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem.yaml
x-akamai:
file-path: errors/405.yaml
'406':
description: '[Not acceptable](https://techdocs.akamai.com/property-mgr/reference/406).'
content:
application/problem+json:
example:
detail: The system does not support the content-type restrictions provided by your 'Accept' header.
instance: papi/v1/build#abc12345abcc02a7
status: 406
title: Not Acceptable
type: https://problems.luna.akamaiapis.net/papi/v1/http/not-acceptable
schema:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- status
- detail
- instance
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
errors:
description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
minItems: 0
type: array
uniqueItems: true
items:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- detail
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-nested.yaml
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem.yaml
x-akamai:
file-path: errors/406.yaml
'409':
description: '[Conflict](https://techdocs.akamai.com/property-mgr/reference/409).'
content:
application/problem+json:
example:
detail: Another edit or activation request on same network in progress for this property version.
instance: papi/v1/properties/prp_123456/activations?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
status: 409
title: Operation failed
type: https://problems.luna.akamaiapis.net/papi/v1/resource-busy
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/409.yaml
'422':
description: '[Unprocessable content](https://techdocs.akamai.com/property-mgr/reference/422).'
content:
application/problem+json:
example:
instance: papi/v1/activations/#abc12345abcc02a7
messageId: property_activation_still_pending
result: ERROR
status: 422
title: Property Manager Exception
type: https://problems.luna.akamaiapis.net/papi/v1/property_activation_still_pending
params:
- Property 123456
- Version 1
details: {}
errors:
- detail: property_activation_still_pending
title: Property Manager Exception
type: papi/v1/property_activation_still_pending
schema:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- instance
- status
- errors
- details
- messageId
- params
- result
properties:
details:
description: Diagnostic instructions to locate and fix the problem.
type: object
errors:
description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
minItems: 0
type: array
uniqueItems: true
items:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- detail
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-nested.yaml
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
messageId:
description: Summarizes the cause of the problem.
minLength: 1
type: string
params:
description: Details of the property and version where the problem occured.
minItems: 0
type: array
items:
type: string
result:
description: Indicates the severity of the problem.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-422.yaml
x-akamai:
file-path: errors/422.yaml
'429':
description: '[Too many requests](https://techdocs.akamai.com/property-mgr/reference/429).'
content:
application/problem+json:
example:
detail: Too many includes exist on contract ctr_1-12345. You must delete an include before continuing.
instance: /papi/v1/includes?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
instanceKey: 1-12345
limit: 500
limitKey: INCLUDES_PER_CONTRACT
remaining: 0
status: 429
title: Too many includes
type: https://problems.luna.akamaiapis.net/papi/v1/limit-exceeded
schema:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- status
- detail
- instance
- limitKey
- instanceKey
- limit
- remaining
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
errors:
description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
minItems: 0
type: array
uniqueItems: true
items:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- detail
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-nested.yaml
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
instanceKey:
description: Identifies the resource the limit is imposed on.
minLength: 1
type: string
limit:
description: The overall limit.
type: integer
limitKey:
description: The limit that got exceeded with the operation.
minLength: 1
type: string
remaining:
description: Number of items left to deploy.
type: integer
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-429.yaml
x-akamai:
file-path: errors/429.yaml
'500':
description: '[Internal server error](https://techdocs.akamai.com/property-mgr/reference/500).'
content:
application/problem+json:
example:
detail: Our system is experiencing errors. We''ll get this fixed as soon as possible.
instance: /papi/v1/properties/12345/activations#abc12345abcc02a7
status: 500
title: Internal Server Error
type: https://problems.luna.akamaiapis.net/papi/proxy/internal-server-error
schema:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- status
- detail
- instance
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
errors:
description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
minItems: 0
type: array
uniqueItems: true
items:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- detail
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-nested.yaml
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem.yaml
x-akamai:
file-path: errors/500.yaml
parameters:
- description: __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to `false` when exchanging PAPI data with other APIs.
example: '{{PAPI-Use-Prefixes}}'
in: header
name: PAPI-Use-Prefixes
required: true
schema:
example: 'false'
type: string
enum:
- 'true'
- 'false'
x-akamai:
file-path: parameters/PAPI-Use-Prefixes-header.yaml
- description: Unique identifier for the contract. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix.
example: '{{contractId}}'
in: query
name: contractId
required: true
schema:
example: ctr_1-1TJZFW
type: string
x-akamai:
file-path: parameters/contractId-required.yaml
- description: Unique identifier for the group. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix.
example: '{{groupId}}'
in: query
name: groupId
required: true
schema:
example: grp_15166
type: string
x-akamai:
file-path: parameters/groupId-required.yaml
- description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).
example: '{{accountSwitchKey}}'
in: query
name: accountSwitchKey
required: false
schema:
example: 1-5C0YLB:1-8BYUX
type: string
/properties/{propertyId}/hostnames:
x-akamai:
file-path: paths/property-hostnames.yaml
path-for-file: /properties/{propertyId}/hostnames
x-akamai-descriptor-tools:
displayName: propertyHostnames
group: Property Hostnames
parameters:
- description: Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `prp_` prefix.
example: '{{propertyId}}'
in: path
name: propertyId
required: true
schema:
example: prp_12345
type: string
x-akamai:
file-path: parameters/propertyId-path.yaml
patch:
description: 'For a property with `useHostnameBucket` set to `true` [when created](https://techdocs.akamai.com/property-mgr/reference/post-properties), this operation adds or removes up to 1000 property hostnames without incrementing the property version. Changes automatically activate on the selected network. If a property doesn''t have hostname buckets enabled, this operation returns a [403](https://techdocs.akamai.com/property-mgr/reference/403) error. If another activation is in progress, whether it''s a hostname activation or a property version activation, the operation fails with a [409](https://techdocs.akamai.com/property-mgr/reference/409) error. Once you perform this operation, it blocks subsequent requests until all the property hostnames are active. Note that to build the request body, you need to first obtain the `edgeHostnameId` either from an existing edge hostname or a new one you create by running the [Create a new edge hostname](https://techdocs.akamai.com/property-mgr/reference/post-edgehostnames) operation.
**Note**: If you''re using a new account, first register it on the Akamai network by activating any property version on either staging or production. Otherwise, your attempts to create or specify certificates will fail with a [403](https://techdocs.akamai.com/property-mgr/reference/403) error.'
operationId: patch-property-hostnames
summary: Akamai Add or Remove Hostnames for a Property's Hostname Bucket
tags:
- Hostname buckets
externalDocs:
description: See documentation for this operation in Akamai's Property Manager API
url: https://techdocs.akamai.com/property-mgr/reference/patch-property-hostnames
requestBody:
required: true
content:
application/json:
example:
network: PRODUCTION
note: Sample hostname activation
notifyEmails:
- you@example.com
- them@example.com
remove:
- www.example.com
- m.example3.com
add:
- certProvisioningType: DEFAULT
cnameFrom: m.example.com
cnameType: EDGE_HOSTNAME
edgeHostnameId: ehn_895824
- certProvisioningType: CPS_MANAGED
cnameFrom: www.example3.com
cnameType: EDGE_HOSTNAME
edgeHostnameId: ehn_895824
schema:
$schema: http://json-schema.org/draft-04/schema#
description: Adds and removes up to 1000 property hostnames per single request without incrementing the property version. Changes are automatically activated on the selected network. You remove each hostname by specifying its custom domain name that your end users see as a string value. For additions, you need to specify a fuller object.
id: resource:/descriptors/papi/v1/schemas/CreateOrDeleteHostnameBucketV0.json#
javaType: com.akamai.luna.papi.model.AddRemoveHostnameBucketRequest
type: object
required:
- network
properties:
add:
description: The property hostnames you want to add to a hostname bucket. You can specify up to 1000 new property hostnames in a single request.
type: array
items:
type: object
required:
- cnameType
- edgeHostnameId
- cnameFrom
- certProvisioningType
properties:
certProvisioningType:
description: Indicates the type of the certificate used in the property hostname. Either the `CPS_MANAGED` for the custom certificates you create with the [Certificate Provisioning System API](https://techdocs.akamai.com/cps/reference) (CPS), or `DEFAULT` for certificates deployed automatically. Note that you can't specify the `DEFAULT` value if your account hostname uses the `akamaized.net` domain suffix.
type: string
enum:
- CPS_MANAGED
- DEFAULT
cnameFrom:
description: The hostname that your end users see, indicated by the `Host` header in end user requests.
type: string
cnameType:
description: Only one supported `EDGE_HOSTNAME` value.
type: string
enum:
- EDGE_HOSTNAME
edgeHostnameId:
description: Identifies the edge hostname you mapped your traffic to on the production network. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `ehn_` prefix.
type: string
network:
description: The network to activate on, either `STAGING` or `PRODUCTION`.
example: '{{network}}'
enum:
- STAGING
- PRODUCTION
note:
description: Assigns a log message to the request.
example: '{{note}}'
type: string
notifyEmails:
description: Email addresses to notify when the activation status changes.
minItems: 1
type: array
items:
type: string
remove:
description: The property hostnames you want to delete from the current set in the hostname bucket.
type: array
items:
type: string
x-akamai:
file-path: schemas/property-hostnames-bucket-add-remove-request.yaml
responses:
'201':
description: The response lists hostnames added or removed from the property.
content:
application/json:
example:
activationId: atv_67037
activationLink: /papi/v1/properties/prp_173136/hostname-activations/atv_67037?contractId=ctr_C-0N7RAC7&groupId=grp_15225
hostnames:
- certProvisioningType: DEFAULT
cnameFrom: example.com
cnameTo: example.com.edgekey.net
cnameType: EDGE_HOSTNAME
edgeHostnameId: ehn_895822
certStatus:
validationCname:
hostname: _acme-challenge.www.example.com
target: '{token}.www.example.com.akamai-domain.com'
production:
- status: PENDING
staging:
- status: PENDING
- certProvisioningType: CPS_MANAGED
cnameFrom: m.example.com
cnameTo: m.example.com.edgesuite.net
cnameType: EDGE_HOSTNAME
edgeHostnameId: ehn_895833
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/PostHostnameBucketResponse.json#
type: object
required:
- activationLink
- activationId
properties:
activationId:
description: Unique identifier for the hostname bucket activation. This is common for all property hostnames in a hostname bucket.
type: string
activationLink:
description: Links the newly created hostname bucket activation. This is common for all property hostnames in a hostname bucket.
type: string
hostnames:
description: Specifies property hostnames activated in a hostname bucket.
type: array
items:
additionalProperties: false
type: object
required:
- cnameFrom
- cnameType
- edgeHostnameId
- certProvisioningType
properties:
certProvisioningType:
description: Indicates the type of the certificate used in the property hostname. Either the `CPS_MANAGED` for the custom certificates you create with the [Certificate Provisioning System API](https://techdocs.akamai.com/cps/reference) (CPS), or `DEFAULT` for certificates deployed automatically. Note that you can't specify the `DEFAULT` value if your account hostname uses the `akamaized.net` domain suffix.
type: string
enum:
- CPS_MANAGED
- DEFAULT
certStatus:
additionalProperties: false
description: __Limited availability__ With the `includeCertStatus` parameter set to `true`, determines whether a hostname is capable of serving secure content over the staging or production network.
type: object
properties:
production:
description: __Limited availability__ The certificate status for the hostname on the production network.
minItems: 0
type: array
items:
additionalProperties: false
type: object
properties:
status:
description: '__Limited availability__ The status of the certificate deployment on the production network.
Expand for details on possible values.
DEPLOYING indicates the deployment is in progress.
PENDING indicates you need to add the validation challenge to your DNS and activate the property version on staging or production to deploy your certificate to that network. If you''ve done that already, run the operation again later to check if the deployment succeeded.
NEEDS_ACTIVATION indicates the validation is complete and the status on the `production` network is either `DEPLOYING` or `DEPLOYED`. You need to activate the property version on staging to deploy the certificate to that network.
DEPLOYED indicates the certificate is successfully validated on the network and ready to handle secure traffic.
STALLED indicates a problem with validation or deployment of your certificate. To try again, re-launch a certificate validation or contact Akamai Professional Services for help.
PROHIBITED_DOMAIN_FAILURE indicates the hostname isn''t in the Let''s Encrypt Certificate Authority domain allow list. Fix the underlying issue and re-launch a certificate validation, or contact Akamai Professional Services for help.
CAA_MISMATCH_RETRYING or CAA_MISMATCH_FAILURE indicate you need to configure your Certification Authority Authorization (CAA) policy to allow Let''s Encrypt. Fix the underlying issue and re-launch a certificate validation, or contact Akamai Professional Services for help.
EXPIRING_SOON_NEEDS_VALIDATION indicates your certificate is due to expire or already expired, and you need to add the _acme-challenge validation CNAME record in your DNS again.
CNAME_MISSING_FAILURE indicates you removed the validation record from your DNS. Add the CNAME record to your DNS again and re-launch a certificate validation, or contact Akamai Professional Services for help.
UNKNOWN_FAILURE To try again, re-launch a certificate validation or contact Akamai Professional Services for help.
'
type: string
enum:
- DEPLOYING
- PENDING
- NEEDS_ACTIVATION
- DEPLOYED
- STALLED
- PROHIBITED_DOMAIN_FAILURE
- CAA_MISMATCH_RETRYING
- CAA_MISMATCH_FAILURE
- EXPIRING_SOON_NEEDS_VALIDATION
- EXPIRED_NEEDS_VALIDATION
- CNAME_MISSING_FAILURE
- UNKNOWN_FAILURE
x-akamai:
status: LA
x-akamai:
status: LA
staging:
description: __Limited availability__ The certificate status for the hostname on the staging network.
minItems: 0
type: array
items:
additionalProperties: false
type: object
properties:
status:
description: '__Limited availability__ The status of the certificate deployment on the staging network.
Expand for details on possible values.
DEPLOYING indicates the deployment is in progress.
PENDING indicates you need to add the validation challenge to your DNS and activate the property version on staging or production to deploy your certificate to that network. If you''ve done that already, run the operation again later to check if the deployment succeeded.
NEEDS_ACTIVATION indicates the validation is complete and the status on the `production` network is either `DEPLOYING` or `DEPLOYED`. You need to activate the property version on staging to deploy the certificate to that network.
DEPLOYED indicates the certificate is successfully validated on the network and ready to handle secure traffic.
STALLED indicates a problem with validation or deployment of your certificate. To try again, re-launch a certificate validation or contact Akamai Professional Services for help.
PROHIBITED_DOMAIN_FAILURE indicates the hostname isn''t in the Let''s Encrypt Certificate Authority domain allow list. Fix the underlying issue and re-launch a certificate validation, or contact Akamai Professional Services for help.
CAA_MISMATCH_RETRYING or CAA_MISMATCH_FAILURE indicate you need to configure your Certification Authority Authorization (CAA) policy to allow Let''s Encrypt. Fix the underlying issue and re-launch a certificate validation, or contact Akamai Professional Services for help.
EXPIRING_SOON_NEEDS_VALIDATION indicates your certificate is due to expire or already expired, and you need to add the _acme-challenge validation CNAME record in your DNS again.
CNAME_MISSING_FAILURE indicates you removed the validation record from your DNS. Add the CNAME record to your DNS again and re-launch a certificate validation, or contact Akamai Professional Services for help.
UNKNOWN_FAILURE To try again, re-launch a certificate validation or contact Akamai Professional Services for help.
'
type: string
enum:
- DEPLOYING
- PENDING
- NEEDS_ACTIVATION
- DEPLOYED
- STALLED
- PROHIBITED_DOMAIN_FAILURE
- CAA_MISMATCH_RETRYING
- CAA_MISMATCH_FAILURE
- EXPIRING_SOON_NEEDS_VALIDATION
- EXPIRED_NEEDS_VALIDATION
- CNAME_MISSING_FAILURE
- UNKNOWN_FAILURE
x-akamai:
status: LA
x-akamai:
status: LA
validationCname:
additionalProperties: false
description: __Limited availability__ The CNAME record used to validate the certificate's domain.
type: object
required:
- hostname
- target
properties:
hostname:
description: __Limited availability__ The hostname part of the CNAME record used to validate the certificate's domain.
type: string
x-akamai:
status: LA
target:
description: __Limited availability__ The destination part of the CNAME record used to validate the certificate's domain.
type: string
x-akamai:
status: LA
x-akamai:
status: LA
x-akamai:
status: LA
cnameFrom:
description: The hostname that your end users see, indicated by the `Host` header in end user requests.
type: string
cnameTo:
description: The edge hostname you point the property hostname to so that you can start serving traffic through Akamai servers. This member corresponds to the edge hostname object's `edgeHostnameDomain` member.
type: string
cnameType:
description: Only one supported `EDGE_HOSTNAME` value.
type: string
enum:
- EDGE_HOSTNAME
edgeHostnameId:
description: Identifies the edge hostname you mapped your traffic to on the staging network. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `ehn_` prefix.
type: string
x-akamai:
file-path: schemas/property-hostnames-bucket-add-remove-response.yaml
headers:
X-Limit-Default-Certs-Per-Contract-Limit:
description: The total number of default certificates per contract. This header only appears if you have any hostnames with default certificates assigned to the property version.
schema:
type: string
x-akamai:
file-path: headers/X-Limit-Default-Certs-Per-Contract-Limit.yaml
X-Limit-Default-Certs-Per-Contract-Remaining:
description: The number of remaining default certificates per contract. This header only appears if you have any hostnames with default certificates assigned to the property version.
schema:
type: string
x-akamai:
file-path: headers/X-Limit-Default-Certs-Per-Contract-Remaining.yaml
X-Limit-Hosts-Per-Account-Limit:
description: Maximum number of hostnames you can assign to all properties under an account.
schema:
type: string
x-akamai:
file-path: headers/X-Limit-Hosts-Per-Account-Limit.yaml
X-Limit-Hosts-Per-Account-Remaining:
description: Remaining number of hostnames you can assign to all properties under an account. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.
schema:
type: string
x-akamai:
file-path: headers/X-Limit-Hosts-Per-Account-Remaining.yaml
X-Limit-Hosts-Per-Property-Limit:
description: Maximum number of hostnames you can assign to a property configuration.
schema:
type: string
x-akamai:
file-path: headers/X-Limit-Hosts-Per-Property-Limit.yaml
X-Limit-Hosts-Per-Property-Remaining:
description: Remaining number of hostnames you can assign to a property configuration. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.
schema:
type: string
x-akamai:
file-path: headers/X-Limit-Hosts-Per-Property-Remaining.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
'409':
description: '[Conflict](https://techdocs.akamai.com/property-mgr/reference/409).'
content:
application/problem+json:
example:
detail: Another edit or activation request on same network in progress for this property version.
instance: papi/v1/properties/prp_123456/activations?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
status: 409
title: Operation failed
type: https://problems.luna.akamaiapis.net/papi/v1/resource-busy
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/409.yaml
'413':
description: '[Request entity too large](https://techdocs.akamai.com/property-mgr/reference/413).'
content:
application/problem+json:
example:
detail: TBD
instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
status: 413
title: Request entity too large
type: https://problems.luna.akamaiapis.net/papi/v1/http/
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/413.yaml
'415':
description: '[Unsupported media type](https://techdocs.akamai.com/property-mgr/reference/415).'
content:
application/problem+json:
example:
detail: Our system does not support requests in the format you're sending.
instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
status: 415
title: Unsupported Media Type
type: https://problems.luna.akamaiapis.net/papi/v1/http/unsupported-media-type
schema:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- status
- detail
- instance
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
errors:
description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
minItems: 0
type: array
uniqueItems: true
items:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- detail
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-nested.yaml
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem.yaml
x-akamai:
file-path: errors/415.yaml
'422':
description: '[Unprocessable content](https://techdocs.akamai.com/property-mgr/reference/422).'
content:
application/problem+json:
example:
instance: papi/v1/activations/#abc12345abcc02a7
messageId: property_activation_still_pending
result: ERROR
status: 422
title: Property Manager Exception
type: https://problems.luna.akamaiapis.net/papi/v1/property_activation_still_pending
params:
- Property 123456
- Version 1
details: {}
errors:
- detail: property_activation_still_pending
title: Property Manager Exception
type: papi/v1/property_activation_still_pending
schema:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- instance
- status
- errors
- details
- messageId
- params
- result
properties:
details:
description: Diagnostic instructions to locate and fix the problem.
type: object
errors:
description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
minItems: 0
type: array
uniqueItems: true
items:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- detail
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-nested.yaml
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
messageId:
description: Summarizes the cause of the problem.
minLength: 1
type: string
params:
description: Details of the property and version where the problem occured.
minItems: 0
type: array
items:
type: string
result:
description: Indicates the severity of the problem.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-422.yaml
x-akamai:
file-path: errors/422.yaml
'429':
description: '[Too many requests](https://techdocs.akamai.com/property-mgr/reference/429).'
content:
application/problem+json:
example:
detail: Too many includes exist on contract ctr_1-12345. You must delete an include before continuing.
instance: /papi/v1/includes?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
instanceKey: 1-12345
limit: 500
limitKey: INCLUDES_PER_CONTRACT
remaining: 0
status: 429
title: Too many includes
type: https://problems.luna.akamaiapis.net/papi/v1/limit-exceeded
schema:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- status
- detail
- instance
- limitKey
- instanceKey
- limit
- remaining
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
errors:
description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
minItems: 0
type: array
uniqueItems: true
items:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- detail
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-nested.yaml
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
instanceKey:
description: Identifies the resource the limit is imposed on.
minLength: 1
type: string
limit:
description: The overall limit.
type: integer
limitKey:
description: The limit that got exceeded with the operation.
minLength: 1
type: string
remaining:
description: Number of items left to deploy.
type: integer
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-429.yaml
x-akamai:
file-path: errors/429.yaml
'500':
description: '[Internal server error](https://techdocs.akamai.com/property-mgr/reference/500).'
content:
application/problem+json:
example:
detail: Our system is experiencing errors. We''ll get this fixed as soon as possible.
instance: /papi/v1/properties/12345/activations#abc12345abcc02a7
status: 500
title: Internal Server Error
type: https://problems.luna.akamaiapis.net/papi/proxy/internal-server-error
schema:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- status
- detail
- instance
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
errors:
description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
minItems: 0
type: array
uniqueItems: true
items:
additionalProperties: false
description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
type: object
required:
- type
- title
- detail
properties:
detail:
description: Diagnostic instructions to locate and fix the problem.
minLength: 1
type: string
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem-nested.yaml
instance:
description: Unique value generated with each API call.
minLength: 1
type: string
status:
description: The HTTP status code that categorizes this error case.
maximum: 600
minimum: 100
type: integer
title:
description: A summary of each error case.
minLength: 1
type: string
type:
description: Identifies each error case.
format: uri
type: string
x-akamai:
file-path: schemas/problem.yaml
x-akamai:
file-path: errors/500.yaml
parameters:
- description: __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to `false` when exchanging PAPI data with other APIs.
example: '{{PAPI-Use-Prefixes}}'
in: header
name: PAPI-Use-Prefixes
required: true
schema:
example: 'false'
type: string
enum:
- 'true'
- 'false'
x-akamai:
file-path: parameters/PAPI-Use-Prefixes-header.yaml
- description: Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it along with the `groupId`. In other operations that don't specify a `propertyId` URL parameter, this parameter is always required. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix.
example: '{{contractId}}'
in: query
name: contractId
required: false
schema:
example: ctr_1-1TJZFW
type: string
x-akamai:
file-path: parameters/contractId-optional.yaml
- description: Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along with the `contractId`. In other operations that don't specify a `propertyId` URL parameter, this parameter is always required. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix.
example: '{{groupId}}'
in: query
name: groupId
required: false
schema:
example: grp_15166
type: string
x-akamai:
file-path: parameters/groupId-optional.yaml
- description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).
example: '{{accountSwitchKey}}'
in: query
name: accountSwitchKey
required: false
schema:
example: 1-5C0YLB:1-8BYUX
type: string
externalDocs:
description: See documentation for Akamai's API Endpoint Definition API
url: https://techdocs.akamai.com/api-definitions/reference
x-readme:
samples-languages:
- curl
- python
- node