Akamai Edge hostnames API

openapi: 3.0.0
info:
  title: 'Akamai: API Endpoint Definition Access tokens Edge 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: Edge hostnames
paths:
  /edgehostnames:
    x-akamai:
      file-path: paths/edge-hostnames.yaml
      path-for-file: /edgehostnames
    x-akamai-descriptor-tools:
      displayName: edgeHostnames
      group: EdgeHostnames
    post:
      description: "**Note:** You can skip this operation if you're using Secure by Default that automatically creates an edge hostname upon activation. \n\nThis POST operation creates a new edge hostname. As detailed in the sections below, you can use three approaches to secure new edge hostnames: Standard TLS, Enhanced TLS, or a Shared Certificate. You can [assign a use case](https://techdocs.akamai.com/property-mgr/reference/modify-property-hostnames) mapping profile to optimize the hostname to serve specific types of traffic. Once the edge hostname is active, you can [Update a property's hostnames](https://techdocs.akamai.com/property-mgr/reference/put-property-version-hostnames) to assign it to a hostname on a property. After you [activate a property](https://techdocs.akamai.com/property-mgr/reference/post-property-activations), modifying your DNS to map the property hostname to the edge hostname ultimately enables traffic on the property. For details, see [Enable traffic for a new hostname](https://techdocs.akamai.com/property-mgr/reference/modify-property-hostnames). Use the [Edge Hostname API](https://techdocs.akamai.com/edge-hostnames/reference/get-edge-hostname-certificate) (HAPI) to modify edge hostnames, or delete any that aren't currently assigned to an active property configuration."
      operationId: post-edgehostnames
      summary: Akamai Create a New Edge Hostname
      tags:
      - Edge hostnames
      externalDocs:
        description: See documentation for this operation in Akamai's Property Manager API
        url: https://techdocs.akamai.com/property-mgr/reference/post-edgehostnames
      requestBody:
        required: true
        content:
          application/json:
            example:
              domainPrefix: www.example.com
              domainSuffix: edgesuite.net
              ipVersionBehavior: IPV4
              productId: prd_Dynamic_Site_Del
              secureNetwork: STANDARD_TLS
              useCases:
              - option: BACKGROUND
                type: GLOBAL
                useCase: Download_Mode
            schema:
              $schema: http://json-schema.org/draft-04-schema#
              description: Specifies a set of available hostnames a property version may use. To POST a new edge hostname, specify a single object with `productId`, `domainPrefix`, and `domainSuffix` members, and optional `ipVersionBehavior` and `secure` members. Relevant response objects appear within the outer envelope's `edgehostnames.items` array.
              id: resource:/descriptors/papi/v1/schemas/CreateNewEdgeHostnameRequestV0.json#
              javaType: com.akamai.luna.papi.model.EdgeHostnameCreateRequest
              type: object
              required:
              - productId
              - domainPrefix
              - domainSuffix
              - ipVersionBehavior
              properties:
                certEnrollmentId:
                  description: When creating an Enhanced TLS edge hostname, this sets the certificate enrollment ID. Specify this on POST, with `secureNetwork` set to `ENHANCED_TLS`. To obtain a value programmatically, run the Certificate Provisioning System API's [List enrollments](https://techdocs.akamai.com/cps/reference/get-enrollments) operation. Choose the appropriate enrollment, strip the leading path expression from its `location` member, and use that value as the `certEnrollmentId`.
                  example: '{{certEnrollmentId}}'
                  minimum: 1
                  type: integer
                domainPrefix:
                  description: The origin domain portion of the edge hostname. An edge hostname consists of a customer-specific `namePrefix` such as `www.example.com` and an Akamai-specific `domainSuffix` such as `edgesuite.net`. The edge hostname's final DNS CNAME combines the two, for example, `www.example.com.edgesuite.net`.
                  example: '{{domainPrefix}}'
                  type: string
                domainSuffix:
                  description: The Akamai-specific portion of the edge hostname, for example, `edgesuite.net`.
                  example: '{{domainSuffix}}'
                  type: string
                ipVersionBehavior:
                  default: IPV4
                  description: 'Which version of the IP protocol to use: `IPV4` for version 4 only, or `IPV6_COMPLIANCE` for both 4 and 6. The default value for requests is `IPV4`.'
                  example: '{{ipVersionBehavior}}'
                  type: string
                  enum:
                  - IPV4
                  - IPV6_COMPLIANCE
                productId:
                  description: The product you created the edge hostname for. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `prd_` prefix.
                  example: '{{productId}}'
                  type: string
                secure:
                  default: false
                  description: Whether to use the edge hostname with SSL. Defaults to `false` for POST requests. Enabling this option for new edge hostnames isn't supported.
                  example: '{{secure}}'
                  type: boolean
                secureNetwork:
                  description: On POST, specifies the type of security for the new edge hostname. With `STANDARD_TLS` specified, specify a `domainSuffix` of `edgesuite.net`. With `SHARED_CERT` specified, specify a `domainSuffix` of `akamaized.net`. With `ENHANCED_TLS` specified, you need to specify a `certEnrollmentId` value along with a `domainSuffix` of `edgekey.net`.
                  example: '{{secureNetwork}}'
                  type: string
                  enum:
                  - ENHANCED_TLS
                  - STANDARD_TLS
                  - SHARED_CERT
                slotNumber:
                  description: On POST, sets the slot number for secure ESSL properties.
                  example: '{{slotNumber}}'
                  minimum: 1
                  type: integer
                useCases:
                  description: Optionally when configuring a new edge hostname, this assigns a preset _use case_ that characterizes the type of traffic served. Use cases optimize deployment over the Akamai edge network. To gather values to add to this object, run the [List use cases](https://techdocs.akamai.com/property-mgr/reference/get-product-mapping-use-cases) operation.
                  maxItems: 2
                  minItems: 0
                  type: array
                  items:
                    type: object
                    required:
                    - useCase
                    - option
                    - type
                    properties:
                      option:
                        description: Specifies one of the available `options` available in the response object.
                        type: string
                      type:
                        description: Identifies the type of network over which traffic deploys. The only value currently available is `GLOBAL`. Use this to specify the same member name available in the use case response object.
                        type: string
                        enum:
                        - GLOBAL
                      useCase:
                        description: Identifies each mapping use case scenario. Use this to specify the same member name available in the use case response object.
                        type: string
              x-akamai:
                file-path: schemas/edgehostname-create-request.yaml
      responses:
        '201':
          description: The response provides a URL link to the newly created edge hostname.
          content:
            application/json:
              example:
                edgeHostnameLink: /papi/v0/edgehostnames/ehn_1332?contractId=ctr_C-0N7RAC7&grp_15225
              schema:
                $schema: http://json-schema.org/draft-04-schema#
                additionalProperties: false
                description: Provides a hypermedia link to a newly created resource. The response's single member name indicates the type of resource.
                id: resource:/descriptors/papi/v1/schemas/PostEdgeHostnameResponse.json#
                type: object
                required:
                - edgeHostnameLink
                properties:
                  edgeHostnameLink:
                    description: Links the newly created edge hostname.
                    type: string
                x-akamai:
                  file-path: schemas/edgehostname-post-response.yaml
          headers:
            Location:
              description: Provides a URL path you can GET the newly created resource from.
              schema:
                type: string
              x-akamai:
                file-path: headers/Location.yaml
            X-Limit-Edgehostnames-Per-Contract-Limit:
              description: Maximum number of edge hostnames per contract.
              schema:
                type: string
              x-akamai:
                file-path: headers/X-Limit-Edgehostnames-Per-Contract-Limit.yaml
            X-Limit-Edgehostnames-Per-Contract-Remaining:
              description: Remaining number of edge hostnames per contract. 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-Edgehostnames-Per-Contract-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
        '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: Un

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