Akamai
Akamai Hostname coverage API

Get the list of hostnames in an account with their current protections, activation statuses, and other summary information.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.0.0
info:
  title: 'Akamai: API Endpoint Definition Access tokens Hostname coverage API'
  version: '2'
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  description: 'Get the list of hostnames in an account with their current

    protections, activation statuses, and other summary information.'
servers:
- url: https://{hostname}/api-definitions/v2
tags:
- description: 'Get the list of hostnames in an account with their current

    protections, activation statuses, and other summary information.'
  name: Hostname coverage
paths:
  /hostname-coverage:
    x-akamai:
      file-path: paths/hostname-coverage.yaml
      path-info: /hostname-coverage
    get:
      description: __Kona Site Defender__, __App & API Protector with the Advanced Security module__ Get the list of hostnames in the account with their current protections, activation statuses, and other summary information.
      externalDocs:
        description: See documentation for this operation in Akamai's Application Security API
        url: https://techdocs.akamai.com/application-security/reference/get-hostname-coverage
      operationId: get-hostname-coverage
      parameters:
      - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).
        in: query
        name: accountSwitchKey
        required: false
        schema:
          example: 1-5C0YLB:1-8BYUX
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                hostnameCoverage:
                - configuration:
                    id: 57415
                    name: Main Street Corporation  Mexico
                    version: 37
                  hasMatchTarget: true
                  hostname: hola.example.com.mx
                  policyNames:
                  - Main Street Corporation  Mexico
                  status: covered
                - configuration:
                    id: 55851
                    name: WFSLTD and API gateway portal
                    version: 2
                  hasMatchTarget: true
                  hostname: apiwork.example.com
                  policyNames:
                  - AAG Sites
                  status: covered
                - configuration:
                    id: 74656
                    name: Main Street Corporation  Canada
                    version: 53
                  hasMatchTarget: true
                  hostname: www.example.com
                  policyNames:
                  - Main Street Corporation  Canada
                  status: covered
              schema:
                additionalProperties: false
                description: Describes the coverage status for hostnames.
                properties:
                  hostnameCoverage:
                    description: The coverage details for the hostname.
                    items:
                      additionalProperties: false
                      properties:
                        configuration:
                          additionalProperties: false
                          description: The configuration details for hostname coverage.
                          properties:
                            id:
                              description: The configuration ID.
                              type: integer
                            name:
                              description: The name of the configuration.
                              type: string
                            version:
                              description: The configuration version number.
                              type: integer
                          required:
                          - id
                          - name
                          - version
                          type: object
                          x-akamai:
                            file-path: schemas/hostname-coverage-config.yaml
                        hasMatchTarget:
                          description: Whether this hostname has a match target. Hostnames need at least one match target to be protected.
                          type: boolean
                        hostname:
                          description: The hostname.
                          type: string
                        policyNames:
                          description: The policies associated with this hostname.
                          items:
                            description: The policy name.
                            type: string
                          type: array
                        status:
                          description: If `covered`, the hostname is protected by your security configuration. If `not_covered`, your hostname is not protected by your security configuration.
                          enum:
                          - covered
                          - not_covered
                          type: string
                      type: object
                    type: array
                required:
                - hostnameCoverage
                type: object
                x-akamai:
                  file-path: schemas/hostname-coverage-get-200.yaml
          description: Successfully retrieved the Hostname Coverage.
        '400':
          content:
            application/json:
              example:
                detail: The request could not be understood by the server due to malformed syntax.
                instance: https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749
                status: 400
                title: Bad Request
                type: https://problems.luna.akamaiapis.net/appsec/error-types/BAD-REQUEST
              schema:
                additionalProperties: true
                description: Details the errors you can receive.
                properties:
                  detail:
                    description: The detailed error message.
                    type: string
                  fieldErrors:
                    description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field.
                    type: object
                  instance:
                    description: The non-referenceable URI that indicates the error instance.
                    example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749
                    type: string
                  status:
                    description: The HTTP status code.
                    example: 404
                    type: integer
                  title:
                    description: The error title.
                    example: Not Found
                    type: string
                  type:
                    description: The URL for the error type.
                    example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND
                    type: string
                required:
                - title
                - type
                - detail
                - instance
                - status
                type: object
                x-akamai:
                  file-path: schemas/problem-details.yaml
          description: '[Invalid](https://techdocs.akamai.com/application-security/reference/400). Client error, such as invalid or malformed input.'
          x-akamai:
            file-path: errors/400-client-read-errors.yaml
        '404':
          content:
            application/problem+json:
              example:
                detail: The requested resource is not found
                instance: https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749
                status: 404
                title: Not Found
                type: https://problems.luna.akamaiapis.net/appsec/error-types/NOT-FOUND
              schema:
                additionalProperties: true
                description: Details the errors you can receive.
                properties:
                  detail:
                    description: The detailed error message.
                    type: string
                  fieldErrors:
                    description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field.
                    type: object
                  instance:
                    description: The non-referenceable URI that indicates the error instance.
                    example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749
                    type: string
                  status:
                    description: The HTTP status code.
                    example: 404
                    type: integer
                  title:
                    description: The error title.
                    example: Not Found
                    type: string
                  type:
                    description: The URL for the error type.
                    example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND
                    type: string
                required:
                - title
                - type
                - detail
                - instance
                - status
                type: object
                x-akamai:
                  file-path: schemas/problem-details.yaml
          description: '[Not found](https://techdocs.akamai.com/application-security/reference/404). The security policy doesn''t exist, doesn''t carry application layer controls, or no rule with this ID is available for use in this policy.'
          x-akamai:
            file-path: errors/404-client-read-errors.yaml
        '500':
          content:
            application/problem+json:
              example:
                detail: Internal Server Error
                instance: 12ab3c45-789d-01ef-2gh3-ijk4l56m78no
                status: 500
                title: Internal Server Error
                type: internal_server_error
              schema:
                additionalProperties: true
                description: Details the errors you can receive.
                properties:
                  detail:
                    description: The detailed error message.
                    type: string
                  fieldErrors:
                    description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field.
                    type: object
                  instance:
                    description: The non-referenceable URI that indicates the error instance.
                    example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749
                    type: string
                  status:
                    description: The HTTP status code.
                    example: 404
                    type: integer
                  title:
                    description: The error title.
                    example: Not Found
                    type: string
                  type:
                    description: The URL for the error type.
                    example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND
                    type: string
                required:
                - title
                - type
                - detail
                - instance
                - status
                type: object
                x-akamai:
                  file-path: schemas/problem-details.yaml
          description: '[Internal server error](https://techdocs.akamai.com/application-security/reference/500). Something went wrong on our side. Try again in a few minutes or contact support if the error persists.'
          x-akamai:
            file-path: errors/500-server-errors.yaml
      summary: Get hostname coverage
      tags:
      - Hostname coverage
      x-akamai:
        labels:
        - Kona Site Defender
        - App & API Protector with the Advanced Security module
externalDocs:
  description: See documentation for Akamai's API Endpoint Definition API
  url: https://techdocs.akamai.com/api-definitions/reference
x-readme:
  samples-languages:
  - curl
  - python
  - node
Akamai Hostname coverage API

Documentation

Specifications

Schemas & Data

OpenAPI Specification
