Akamai
Akamai Property version hostnames API

The Property version hostnames API from Akamai — 1 operation(s) for property version hostnames.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.0.0
info:
  title: 'Akamai: API Endpoint Definition Access tokens Property version hostnames 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: Property version hostnames
paths:
  /properties/{propertyId}/versions/{propertyVersion}/hostnames:
    x-akamai:
      file-path: paths/property-version-hostnames.yaml
      path-for-file: /properties/{propertyId}/versions/{propertyVersion}/hostnames
    x-akamai-descriptor-tools:
      displayName: propertyVersionHostnames
      group: Property version 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
    - description: Property's incremental version number.
      example: '{{propertyVersion}}'
      in: path
      name: propertyVersion
      required: true
      schema:
        example: 3
        type: integer
      x-akamai:
        file-path: parameters/propertyVersion-path.yaml
    get:
      description: List all hostnames whose requests are handled by the rules in this property version.
      operationId: get-property-version-hostnames
      summary: Akamai List Hostnames for a Property Version
      tags:
      - Property version hostnames
      externalDocs:
        description: See documentation for this operation in Akamai's Property Manager API
        url: https://techdocs.akamai.com/property-mgr/reference/get-property-version-hostnames
      responses:
        '200':
          description: The response lists hostnames for a specified property version.
          content:
            application/json:
              example:
                accountId: act_A-CCT9012
                contractId: ctr_K-0N7RAK7
                etag: 6aed418629b4e5c0
                groupId: grp_15225
                propertyId: prp_175780
                propertyVersion: 1
                hostnames:
                  items:
                  - 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: 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/GetHostnameResponse.json#
                type: object
                properties:
                  accountId:
                    description: Identifies the prevailing account under which you requested the data. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `act_` prefix.
                    type: string
                  contractId:
                    description: Identifies the prevailing contract under which you requested the data. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `ctr_` prefix.
                    type: string
                  etag:
                    description: A digest with which to check the data's integrity. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for guidance.
                    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.
                    type: string
                  hostnames:
                    additionalProperties: false
                    description: The set of requested property hostnames, available within an `items` array.
                    type: object
                    properties:
                      items:
                        description: Each entry specifies a property hostname that's assigned to the requested property version. Writing data to this resource requires that you PUT an array of _all_ the hostname objects, each containing `edgeHostnameId`, `cnameFrom`, and `cnameTo` members. This request array matches the `hostnames.items` in the response.
                        type: array
                        items:
                          additionalProperties: false
                          type: object
                          required:
                          - cnameFrom
                          - cnameType
                          - edgeHostnameId
                          - certProvisioningType
                          properties:
                            certProvisioningType:
                              description: Indicates the certificate's provisioning type. Either the `CPS_MANAGED` type for the custom certificates you create with the [Certificate Provisioning System API](https://techdocs.akamai.com/cps/reference) (CPS), or `DEFAULT` for certificates created automatically. Note that you can't specify the `DEFAULT` value if your property 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.

                                          <details>

                                          <summary>

                                          Expand for details on possible values.

                                          </summary>

                                          <ul>

                                          <li><code>DEPLOYING</code> indicates the deployment is in progress.

                                          <li><code>PENDING</code> 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.

                                          <li><code>NEEDS_ACTIVATION</code> 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.

                                          <li><code>DEPLOYED</code> indicates the certificate is successfully validated on the network and ready to handle secure traffic.

                                          <li><code>STALLED</code> indicates a problem with validation or deployment of your certificate. To try again, <a href="https://techdocs.akamai.com/property-mgr/reference/re-launch-default-certificate-validation">re-launch a certificate validation</a> or contact Akamai Professional Services for help.</code>

                                          <li><code>PROHIBITED_DOMAIN_FAILURE</code> indicates the hostname isn''t in the <code>Let''s Encrypt</code></code> Certificate Authority domain allow list. Fix the underlying issue and <a href="https://techdocs.akamai.com/property-mgr/reference/re-launch-default-certificate-validation">re-launch a certificate validation</a>, or contact Akamai Professional Services for help.</code>

                                          <li><code>CAA_MISMATCH_RETRYING</code> or <code>CAA_MISMATCH_FAILURE</code> indicate you need to configure your Certification Authority Authorization (CAA) policy to allow <code>Let''s Encrypt</code>. Fix the underlying issue and <a href="https://techdocs.akamai.com/property-mgr/reference/re-launch-default-certificate-validation">re-launch a certificate validation</a>, or contact Akamai Professional Services for help.</code>

                                          <li><code>EXPIRING_SOON_NEEDS_VALIDATION</code> indicates your certificate is due to expire or already expired, and you need to add the <code>_acme-challenge</code> validation CNAME record in your DNS again.

                                          <li><code>CNAME_MISSING_FAILURE</code> indicates you removed the validation record from your DNS. Add the CNAME record to your DNS again and <a href="https://techdocs.akamai.com/property-mgr/reference/re-launch-default-certificate-validation">re-launch a certificate validation</a>, or contact Akamai Professional Services for help.

                                          <li><code>UNKNOWN_FAILURE</code> To try again, <a href="https://techdocs.akamai.com/property-mgr/reference/re-launch-default-certificate-validation">re-launch a certificate validation</a> or contact Akamai Professional Services for help.<ul></details>'
                                        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.

                                          <details>

                                          <summary>

                                          Details on possible values.

                                          </summary>

                                          <ul>

                                          <li><code>DEPLOYING</code> indicates the deployment is in progress.

                                          <li><code>PENDING</code> 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.

                                          <li><code>NEEDS_ACTIVATION</code> 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.

                                          <li><code>DEPLOYED</code> indicates the certificate is successfully validated on the network and ready to handle secure traffic.

                                          <li><code>STALLED</code> indicates a problem with validation or deployment of your certificate. To try again, <a href="https://techdocs.akamai.com/property-mgr/reference/re-launch-default-certificate-validation">re-launch a certificate validation<> or contact Akamai Professional Services for help.</code>

                                          <li><code>PROHIBITED_DOMAIN_FAILURE</code> indicates the hostname isn''t in the <code>Let''s Encrypt</code></code> Certificate Authority domain allow list. Fix the underlying issue and <a href="https://techdocs.akamai.com/property-mgr/reference/re-launch-default-certificate-validation">re-launch a certificate validation</a>, or contact Akamai Professional Services for help.</code>

                                          <li><code>CAA_MISMATCH_RETRYING</code> or <code>CAA_MISMATCH_FAILURE</code> indicate you need to configure your Certification Authority Authorization (CAA) policy to allow <code>Let''s Encrypt</code>. Fix the underlying issue and <a href="https://techdocs.akamai.com/property-mgr/reference/re-launch-default-certificate-validation">re-launch a certificate validation</a>, or contact Akamai Professional Services for help.</code>

                                          <li><code>EXPIRING_SOON_NEEDS_VALIDATION</code> indicates your certificate is due to expire or already expired, and you need to add the <code>_acme-challenge</code> validation CNAME record in your DNS again.

                                          <li><code>CNAME_MISSING_FAILURE</code> indicates you removed the validation record from your DNS. Add the CNAME record to your DNS again and <a href="https://techdocs.akamai.com/property-mgr/reference/re-launch-default-certificate-validation">re-launch a certificate validation</a>, or contact Akamai Professional Services for help.

                                          <li><code>UNKNOWN_FAILURE</code> To try again, <a href="https://techdocs.akamai.com/property-mgr/reference/re-launch-default-certificate-validation">re-launch a certificate validation</a> or contact Akamai Professional Services for help.<ul></details>'
                                        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 each edge hostname. 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
                  propertyId:
                    description: Identifies the property this set of hostnames represents. 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
                  propertyVersion:
                    description: The version of the property this set of hostnames represents.
                    minimum: 1
                    type: integer
                x-akamai:
                  file-path: schemas/property-version-hostnames-get-response.yaml
          headers:
            ETag:
              description: Pass the `ETag` response header back as `If-Match` in write requests to ensure you don't overwrite edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for details.
              example: '"a9dfe78cf93090516bde891d009eaf57"'
              schema:
                type: string
              x-akamai:
                file-path: headers/Etag.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 reque

# --- truncated at 32 KB (185 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/akamai/refs/heads/main/openapi/akamai-property-version-hostnames-api-openapi.yml
Akamai Property version hostnames API

Documentation

Specifications

Schemas & Data

OpenAPI Specification
