Akamai Active property hostnames API

openapi: 3.0.0
info:
  title: 'Akamai: API Endpoint Definition Access tokens Active property 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: Active property hostnames
paths:
  /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
    get:
      description: This operation lists active property hostnames assigned to a specific property. Use the optional query parameters to paginate, sort, and filter the results. You can nest and combine filters to obtain desired results. To view paginated results, use the response's `nextLink` and `previousLink`. You can call this operation by specifying any of the `propertyId` members from a [list of properties](https://techdocs.akamai.com/property-mgr/reference/get-properties), or by running a GET on the `propertyLink` response when [creating a new property](https://techdocs.akamai.com/property-mgr/reference/post-properties).
      operationId: get-property-hostnames
      summary: Akamai List Hostnames for a Property
      tags:
      - Active property hostnames
      externalDocs:
        description: See documentation for this operation in Akamai's Property Manager API
        url: https://techdocs.akamai.com/property-mgr/reference/get-property-hostnames
      responses:
        '200':
          description: The response lists active property hostnames for the requested property.
          content:
            application/json:
              example:
                accountId: act_A-CCT3456
                contractId: ctr_K-0N7RAK71
                currentSort: hostname:a
                defaultSort: hostname:a
                groupId: grp_15225
                propertyId: prp_175780
                availableSort:
                - hostname:a
                - hostname:d
                hostnames:
                  currentItemCount: 3
                  nextLink: /papi/v1/properties/prp_175780/hostnames?offset=1&groupId=grp_15225&contractId=ctr_C-0N7RAC7&limit=3
                  totalItems: 4
                  items:
                  - cnameFrom: example.com
                    cnameType: EDGE_HOSTNAME
                    productionCertType: DEFAULT
                    productionCnameTo: example.com.edgekey.net
                    productionEdgeHostnameId: ehn_895822
                  - cnameFrom: m-example.com
                    cnameType: EDGE_HOSTNAME
                    stagingCertType: DEFAULT
                    stagingCnameTo: m-example.com.edgekey.net
                    stagingEdgeHostnameId: ehn_293412
                  - cnameFrom: example2.com
                    cnameType: EDGE_HOSTNAME
                    stagingCertType: DEFAULT
                    stagingCnameTo: example2.com.edgekey.net
                    stagingEdgeHostnameId: ehn_895822
                    certStatus:
                      validationCname:
                        hostname: _acme-challenge.www.example.com
                        target: '{token}.www.example.com.akamai-domain.com'
                      production:
                      - status: PENDING
                      staging:
                      - status: PENDING
              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, even individual items. See [ID prefixes](#prefixes) for more information.
                id: resource:/descriptors/papi/v1/schemas/GetPropertyHostnamesResponse.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
                  availableSort:
                    description: 'Available sorting options: `hostname:a` for ascending, and `hostname:d` for descending.'
                    minItems: 1
                    type: array
                    items:
                      type: string
                      enum:
                      - hostname:a
                      - hostname:d
                  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
                  currentSort:
                    description: The sorting criteria applied to the response, either `hostname:a` for ascending, or `hostname:d` for descending.
                    type: string
                    enum:
                    - hostname:a
                    - hostname:d
                  defaultSort:
                    default: hostname:a
                    description: If no query parameters were specified in the request, this shows the default `hostname:a` sorting criteria.
                    type: string
                  groupId:
                    description: Identifies the 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
                    required:
                    - items
                    - totalItems
                    - currentItemCount
                    properties:
                      currentItemCount:
                        description: The total count of items present in the current response body for requested criteria.
                        type: integer
                      items:
                        description: Each entry specifies an active property hostname.
                        type: array
                        items:
                          allOf:
                          - additionalProperties: false
                            description: Specifies a property hostname that's applied to a property. 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: object
                            required:
                            - cnameFrom
                            properties:
                              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: 1
                                    type: array
                                    items:
                                      oneOf:
                                      - additionalProperties: false
                                        description: __Limited availability__ The certificate status for the hostname on the production network.
                                        title: Certificate status
                                        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
                                    x-akamai:
                                      status: LA
                                  staging:
                                    description: __Limited availability__ The certificate status for the hostname on the staging network.
                                    minItems: 1
                                    type: array
                                    items:
                                      oneOf:
                                      - additionalProperties: false
                                        description: __Limited availability__ The certificate status for the hostname on the staging network.
                                        title: Certificate status
                                        type: object
                                        properties:
                                          status:
                                            description: '__Limited availability__ The status of the certificate deployment on the staging 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
                                    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
                              cnameType:
                                description: Only one supported `EDGE_HOSTNAME` value.
                                type: string
                                enum:
                                - EDGE_HOSTNAME
                              productionCertType:
                                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://developer.akamai.com/api/core_features/certificate_provisioning_system/v2.html) (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
                              productionCnameTo:
                                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
                              productionEdgeHostnameId:
                                description: Identifies each edge hostname. See [ID prefixes](#prefixes) for details on how to omit the ID's `ehn_` prefix.
                                type: string
                              stagingCertType:
                                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://developer.akamai.com/api/core_features/certificate_provisioning_system/v2.html) (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
                              stagingCnameTo:
                                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
                              stagingEdgeHostnameId:
                                description: Identifies each edge hostname. See [ID prefixes](#prefixes) for details on how to omit the ID's `ehn_` prefix.
                                type: string
                      nextLink:
                        description: The link to next set of response items for paginated response.
                        type: string
                      previousLink:
                        description: The link to previous set of response items for paginated response.
                        type: string
                      totalItems:
                        description: The total count of items for requested criteria.
                        type: integer
                  propertyId:
                    description: Unique identifier for the property. 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
                x-akamai:
                  file-path: schemas/property-hostnames-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

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