Akamai Maps API

openapi: 3.0.0
info:
  title: 'Akamai: API Endpoint Definition Access tokens Maps API'
  version: '2'
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  description: Manage your Site Shield maps.
servers:
- url: https://{hostname}/api-definitions/v2
tags:
- description: Manage your Site Shield maps.
  name: Maps
paths:
  /maps:
    x-akamai:
      file-path: paths/maps.yaml
      path-info: /maps
    get:
      description: Returns a list of all Site Shield maps that belong to your account.
      externalDocs:
        description: See documentation for this operation in Akamai's Site Shield API
        url: https://techdocs.akamai.com/site-shield/reference/get-maps
      operationId: get-maps
      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:
                siteShieldMaps:
                - acknowledgeRequiredBy: 1679661685000
                  acknowledged: true
                  acknowledgedBy: jsmith
                  acknowledgedOn: 1649661984000
                  contacts:
                  - jsmith@example.com
                  currentCidrs:
                  - 192.0.2.29/24
                  - 192.0.2.71/24
                  - 192.0.2.0/24
                  - 192.0.2.140/24
                  - 192.0.2.212/24
                  id: 123456789
                  latestTicketId: 2456
                  mapAlias: ABC Company
                  mcmMapRuleId: 12345
                  proposedCidrs:
                  - 192.0.2.232/24
                  - 192.0.2.228/24
                  - 192.0.2.115/24
                  - 192.0.2.16/24
                  - 192.0.2.154/24
                  ruleName: ss.akamai.net
                  service: S
                  shared: false
                  sureRouteName: route.name.example.com
                  type: Production
                - acknowledgeRequiredBy: 1569661685000
                  acknowledged: true
                  acknowledgedBy: adevi
                  acknowledgedOn: 1569661984000
                  contacts:
                  - luna@akamai.com
                  - new@email.com
                  currentCidrs:
                  - 192.0.2.51/24
                  - 192.0.2.16/24
                  - 192.0.2.76/24
                  - 192.0.2.70/24
                  - 192.0.2.251/24
                  - 192.0.2.57/24
                  - 192.0.2.153/24
                  - 192.0.2.40/24
                  - 192.0.2.49/24
                  id: 7964
                  latestTicketId: 5884
                  mapAlias: Capybara Corp
                  mcmMapRuleId: 957
                  proposedCidrs: []
                  ruleName: e;s9.akamaiedge.net
                  service: S
                  shared: false
                  type: Production
                - acknowledgeRequiredBy: 1684661685000
                  acknowledged: true
                  acknowledgedBy: afero
                  acknowledgedOn: 1647261984000
                  contacts:
                  - pulse@akamai.com
                  currentCidrs: []
                  id: 65
                  latestTicketId: 883
                  mapAlias: Kookaburra Inc secure
                  mcmMapRuleId: 4255
                  proposedCidrs:
                  - 192.0.2.205/24
                  - 192.0.2.226/24
                  - 192.0.2.228/24
                  - 192.0.2.191/24
                  - 192.0.2.157/24
                  - 192.0.2.33/24
                  - 192.0.2.25/24
                  - 192.0.2.41/24
                  - 192.0.2.146/24
                  - 192.0.2.174/24
                  - 192.0.2.25/24
                  - 192.0.2.239/24
                  - 192.0.2.186/24
                  - 192.0.2.115/24
                  - 192.0.2.207/24
                  - 192.0.2.132/24
                  - 192.0.2.117/24
                  - 192.0.2.231/24
                  - 192.0.2.166/24
                  - 192.0.2.22/24
                  - 192.0.2.121/24
                  - 192.0.2.160/24
                  - 192.0.2.174/24
                  - 192.0.2.58/24
                  ruleName: e;s1.akamaiedge.net
                  service: S
                  shared: false
                  sureRouteName: route.name.example.com
                  type: Production
              schema:
                additionalProperties: false
                description: Collects data for Site Shield maps.
                properties:
                  siteShieldMaps:
                    description: A list of Site Shield maps.
                    items:
                      additionalProperties: false
                      description: Collects data for a single Site Shield request map.
                      properties:
                        acknowledgeRequiredBy:
                          description: Specifies the due date and time for when the proposed firewall addresses should be acknowledged.
                          type: integer
                        acknowledged:
                          description: Whether the given set of proposed firewall addresses are acknowledged.
                          type: boolean
                        acknowledgedBy:
                          description: Specifies the email of the user who acknowledged the previous proposed firewall addresses.
                          type: string
                        acknowledgedOn:
                          description: Specifies the date and time when proposed CIDR blocks were acknowledged.
                          type: integer
                        contacts:
                          description: A list of subscribed user email addresses.
                          items:
                            description: An email address of a subscribed user.
                            type: string
                          type: array
                        currentCidrs:
                          description: A list of current CIDR blocks of firewall addresses.
                          items:
                            description: A current CIDR block of firewall addresses.
                            type: string
                          type: array
                        id:
                          description: Identifies the request map.
                          type: integer
                        latestTicketId:
                          description: Identifies the most recent map request ticket.
                          type: integer
                        mapAlias:
                          description: A unique, recognizable name for the map.
                          type: string
                        mcmMapRuleId:
                          description: Identifies the Map Configuration Management (MCM) map rule.
                          type: integer
                        proposedCidrs:
                          description: CIDR blocks containing the Akamai-proposed firewall addresses.
                          items:
                            description: A CIDR block of the Akamai-proposed firewall addresses.
                            type: string
                          type: array
                        ruleName:
                          description: Identifies the hostname for the Site Shield map, available from your Akamai representative. Use the `ruleName` to configure the [Site Shield behavior in PAPI](https://techdocs.akamai.com/property-mgr/reference/latest-site-shield).
                          type: string
                        service:
                          description: Indicates the network, either `C` for `script`, `S` for `ESSL`, or `W` for `FreeFlow`.
                          enum:
                          - C
                          - S
                          - W
                          type: string
                        shared:
                          description: Indicates whether the map is active in shared.
                          type: boolean
                        sureRouteName:
                          description: The name of the SureRoute map.
                          type: string
                        type:
                          description: Specifies the map type.
                          type: string
                      type: object
                      x-akamai:
                        file-path: schemas/site-shield-map.yaml
                    type: array
                type: object
                x-akamai:
                  file-path: schemas/site-shield-maps.yaml
          description: Successful response.
        '400':
          content:
            application/problem+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: Collects data for errors.
                properties:
                  detail:
                    description: Detail error message.
                    type: string
                  errors:
                    description: A nested problem object.
                    items:
                      description: A nested problem object.
                      type: object
                      x-akamai:
                        file-path: schemas/http-problem-details-nested.yaml
                    type: array
                  instance:
                    description: The non-referencable URI that indicates the error instance.
                    type: string
                  status:
                    description: The HTTP status code.
                    example: 404
                    type: integer
                  title:
                    description: The name of the error.
                    example: Not found.
                    type: string
                  type:
                    description: The URL for the error type.
                    type: string
                required:
                - type
                - title
                type: object
                x-akamai:
                  file-path: schemas/http-problem-details.yaml
          description: '[Bad request](https://techdocs.akamai.com/site-shield/reference/400).'
          x-akamai:
            file-path: errors/400.yaml
        '403':
          content:
            application/problem+json:
              example:
                detail: You do not have the necessary access to perform this operation or the requested resource cannot be modified
                instance: https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749
                status: 403
                title: Forbidden
                type: https://problems.luna.akamaiapis.net/appsec-resource/error-types/ACCESS-DENIED
              schema:
                additionalProperties: true
                description: Collects data for errors.
                properties:
                  detail:
                    description: Detail error message.
                    type: string
                  errors:
                    description: A nested problem object.
                    items:
                      description: A nested problem object.
                      type: object
                      x-akamai:
                        file-path: schemas/http-problem-details-nested.yaml
                    type: array
                  instance:
                    description: The non-referencable URI that indicates the error instance.
                    type: string
                  status:
                    description: The HTTP status code.
                    example: 404
                    type: integer
                  title:
                    description: The name of the error.
                    example: Not found.
                    type: string
                  type:
                    description: The URL for the error type.
                    type: string
                required:
                - type
                - title
                type: object
                x-akamai:
                  file-path: schemas/http-problem-details.yaml
          description: '[Forbidden](https://techdocs.akamai.com/site-shield/reference/403). You don''t have permission to access the resource.'
          x-akamai:
            file-path: errors/403.yaml
        '404':
          content:
            application/problem+json:
              example:
                detail: 'Invalid map: 12345677'
                instance: https://problems.luna.akamaiapis.net/siteshield/error-instances/666929c8-c53f-4ac6-88ad-a157310eef79
                problemId: 95bfad29-c2aa-4531-b324-d33806665ba0
                status: 404
                title: Invalid map id
                type: https://problems.luna.akamaiapis.net/siteshield/not-found
              schema:
                additionalProperties: true
                description: Collects data for errors.
                properties:
                  detail:
                    description: Detail error message.
                    type: string
                  errors:
                    description: A nested problem object.
                    items:
                      description: A nested problem object.
                      type: object
                      x-akamai:
                        file-path: schemas/http-problem-details-nested.yaml
                    type: array
                  instance:
                    description: The non-referencable URI that indicates the error instance.
                    type: string
                  status:
                    description: The HTTP status code.
                    example: 404
                    type: integer
                  title:
                    description: The name of the error.
                    example: Not found.
                    type: string
                  type:
                    description: The URL for the error type.
                    type: string
                required:
                - type
                - title
                type: object
                x-akamai:
                  file-path: schemas/http-problem-details.yaml
          description: '[Not found](https://techdocs.akamai.com/site-shield/reference/404).'
          x-akamai:
            file-path: errors/404.yaml
      summary: List maps
      tags:
      - Maps
  /maps/{id}:
    parameters:
    - description: A unique identifier for a map.
      in: path
      name: id
      required: true
      schema:
        example: 1
        type: integer
      x-akamai:
        file-path: parameters/id-path.yaml
    x-akamai:
      file-path: paths/id.yaml
      path-info: /maps/{id}
    get:
      description: Returns information about the specified map, such as the map name, firewall addresses, and when the map was last updated.
      externalDocs:
        description: See documentation for this operation in Akamai's Site Shield API
        url: https://techdocs.akamai.com/site-shield/reference/get-map
      operationId: get-map
      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:
                acknowledgeRequiredBy: 1679661685000
                acknowledged: true
                acknowledgedBy: jsmith
                acknowledgedOn: 1649661984000
                contacts:
                - example@example.com
                currentCidrs:
                - 192.0.2.114/24
                - 192.0.2.82/24
                - 192.0.2.99/24
                - 192.0.2.247/24
                - 192.0.2.182/24
                id: 123456789
                latestTicketId: 2456
                mapAlias: example
                mcmMapRuleId: 12345
                proposedCidrs:
                - 192.0.2.103/24
                - 192.0.2.110/24
                - 192.0.2.161/24
                - 192.0.2.16/24
                - 192.0.2.25/24
                ruleName: ss.akamai.net
                service: S
                shared: false
                sureRouteName: route.name.example.com
                type: Production
              schema:
                additionalProperties: false
                description: Collects data for a single Site Shield request map.
                properties:
                  acknowledgeRequiredBy:
                    description: Specifies the due date and time for when the proposed firewall addresses should be acknowledged.
                    type: integer
                  acknowledged:
                    description: Whether the given set of proposed firewall addresses are acknowledged.
                    type: boolean
                  acknowledgedBy:
                    description: Specifies the email of the user who acknowledged the previous proposed firewall addresses.
                    type: string
                  acknowledgedOn:
                    description: Specifies the date and time when proposed CIDR blocks were acknowledged.
                    type: integer
                  contacts:
                    description: A list of subscribed user email addresses.
                    items:
                      description: An email address of a subscribed user.
                      type: string
                    type: array
                  currentCidrs:
                    description: A list of current CIDR blocks of firewall addresses.
                    items:
                      description: A current CIDR block of firewall addresses.
                      type: string
                    type: array
                  id:
                    description: Identifies the request map.
                    type: integer
                  latestTicketId:
                    description: Identifies the most recent map request ticket.
                    type: integer
                  mapAlias:
                    description: A unique, recognizable name for the map.
                    type: string
                  mcmMapRuleId:
                    description: Identifies the Map Configuration Management (MCM) map rule.
                    type: integer
                  proposedCidrs:
                    description: CIDR blocks containing the Akamai-proposed firewall addresses.
                    items:
                      description: A CIDR block of the Akamai-proposed firewall addresses.
                      type: string
                    type: array
                  ruleName:
                    description: Identifies the hostname for the Site Shield map, available from your Akamai representative. Use the `ruleName` to configure the [Site Shield behavior in PAPI](https://techdocs.akamai.com/property-mgr/reference/latest-site-shield).
                    type: string
                  service:
                    description: Indicates the network, either `C` for `script`, `S` for `ESSL`, or `W` for `FreeFlow`.
                    enum:
                    - C
                    - S
                    - W
                    type: string
                  shared:
                    description: Indicates whether the map is active in shared.
                    type: boolean
                  sureRouteName:
                    description: The name of the SureRoute map.
                    type: string
                  type:
                    description: Specifies the map type.
                    type: string
                type: object
                x-akamai:
                  file-path: schemas/site-shield-map.yaml
          description: Successful response.
        '403':
          content:
            application/problem+json:
              example:
                detail: You do not have the necessary access to perform this operation or the requested resource cannot be modified
                instance: https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749
                status: 403
                title: Forbidden
                type: https://problems.luna.akamaiapis.net/appsec-resource/error-types/ACCESS-DENIED
              schema:
                additionalProperties: true
                description: Collects data for errors.
                properties:
                  detail:
                    description: Detail error message.
                    type: string
                  errors:
                    description: A nested problem object.
                    items:
                      description: A nested problem object.
                      type: object
                      x-akamai:
                        file-path: schemas/http-problem-details-nested.yaml
                    type: array
                  instance:
                    description: The non-referencable URI that indicates the error instance.
                    type: string
                  status:
                    description: The HTTP status code.
                    example: 404
                    type: integer
                  title:
                    description: The name of the error.
                    example: Not found.
                    type: string
                  type:
                    description: The URL for the error type.
                    type: string
                required:
                - type
                - title
                type: object
                x-akamai:
                  file-path: schemas/http-problem-details.yaml
          description: '[Forbidden](https://techdocs.akamai.com/site-shield/reference/403). You don''t have permission to access the resource.'
          x-akamai:
            file-path: errors/403.yaml
        '404':
          content:
            application/problem+json:
              example:
                detail: 'Invalid map: 12345677'
                instance: https://problems.luna.akamaiapis.net/siteshield/error-instances/666929c8-c53f-4ac6-88ad-a157310eef79
                problemId: 95bfad29-c2aa-4531-b324-d33806665ba0
                status: 404
                title: Invalid map id
                type: https://problems.luna.akamaiapis.net/siteshield/not-found
              schema:
                additionalProperties: true
                description: Collects data for errors.
                properties:
                  detail:
                    description: Detail error message.
                    type: string
                  errors:
                    description: A nested problem object.
                    items:
                      description: A nested problem object.
                      type: object
                      x-akamai:
                        file-path: schemas/http-problem-details-nested.yaml
                    type: array
                  instance:
                    description: The non-referencable URI that indicates the error instance.
                    type: string
                  status:
                    description: The HTTP status code.
                    example: 404
                    type: integer
                  title:
                    description: The name of the error.
                    example: Not found.
                    type: string
                  type:
                    description: The URL for the error type.
                    type: string
                required:
                - type
                - title
                type: object
                x-akamai:
                  file-path: schemas/http-problem-details.yaml
          description: '[Not found](https://techdocs.akamai.com/site-shield/reference/404).'
          x-akamai:
            file-path: errors/404.yaml
      summary: Get a map
      tags:
      - Maps
  /maps/{id}/acknowledge:
    parameters:
    - description: A unique identifier for a map.
      in: path
      name: id
      required: true
      schema:
        example: 1
        type: integer
      x-akamai:
        file-path: parameters/id-path.yaml
    x-akamai:
      file-path: paths/acknowledge.yaml
      path-info: /maps/{id}/acknowledge
    post:
      description: Acknowledges the proposed firewall update for the specified map. When necessary, the Site Shield Management application issues an update to the IP address list and sends a notification to you to update your firewall. See [Firewall updates and address change acknowledgment](https://techdocs.akamai.com/site-shield/docs/updating-your-firewall-and-acknowledging-address-changes) for more details.
      externalDocs:
        description: See documentation for this operation in Akamai's Site Shield API
        url: https://techdocs.akamai.com/site-shield/reference/post-map-acknowledge
      operationId: post-map-acknowledge
      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:
                acknowledgeRequiredBy: 1679661685000
                acknowledged: true
                acknowledgedBy: jsmith
                acknowledgedOn: 1649661984000
                contacts:
                - example@example.com
                currentCidrs:
                - 192.0.2.114/24
                - 192.0.2.82/24
                - 192.0.2.99/24
                - 192.0.2.247/24
                - 192.0.2.182/24
                id: 123456789
                latestTicketId: 2456
                mapAlias: example
                mcmMapRuleId: 12345
                proposedCidrs:
                - 192.0.2.103/24
                - 192.0.2.110/24
                - 192.0.2.161/24
                - 192.0.2.16/24
                - 192.0.2.25/24
                ruleName: ss.akamai.net
                service: S
                shared: false
                sureRouteName: route.name.example.com
                type: Production
              schema:
                additionalProperties: false
                description: Collects data for a single Site Shield request map.
                properties:
                  acknowledgeRequiredBy:
                    description: Specifies the due date and time for when the proposed firewall addresses should be acknowledged.
                    type: integer
                  acknowledged:
                    description: Whether the given set of proposed firewall addresses are acknowledged.
                    type: boolean
                  acknowledgedBy:
                    description: Specifies the email of the user who acknowledged the previous proposed firewall addresses.
                    type: string
                  acknowledgedOn:
                    description: Specifies the date and time when proposed CIDR blocks were acknowledged.
                    type: integer
                  contacts:
                    description: A list of subscribed user email addresses.
                    items:
                      description: An email address of a subscribed user.
                      type: string
                    type: array
                  currentCidrs:
                    description: A list of current CIDR blocks of firewall addresses.
                    items:
                      description: A current CIDR block of firewall addresses.
                      type: string
                    type: array
                  id:
                    description: Identifies the request map.
                    type: integer
                  latestTicketId:
                    description: Identifies the most recent map request ticket.
                    type: integer
                  mapAlias:
                    description: A unique, recognizable name for the map.
                    type: string
                  mcmMapRuleId:
                    description: Identifies the Map Configuration Management (MCM) map rule.
                    type: integer
                  proposedCidrs:
                    description: CIDR blocks containing the Akamai-proposed firewall addresses.
                    items:
                      description: A CIDR block of the Akamai-proposed firewall addresses.
                      type: string
                    type: array
                  ruleName:
                    description: Identifies the hostname for the Site Shield map, available from your Akamai representative. Use the `ruleName` to configure the [Site Shield behavior in PAPI](https://techdocs.akamai.com/property-mgr/reference/latest-site-shield).
                    type: string
                  service:
                    description: Indicates the network, either `C` for `script`, `S` for `ESSL`, or `W` for `FreeFlow`.
                    enum:
                    - C
                    - S
                    - W
                    type: string
                  shared:
                    description: Indicates whether the map is active in shared.
                    type: boolean
                  sureRouteName:
                    description: The name of the SureRoute map.
                    type: string
                  type:
                    description: Specifies the map type.
                    type: string
                type: object
                x-akamai:
                  file-path: schemas/site-shield-map.yaml
          description: Successfully acknowledged.
        '403':
          content:
            application/problem+json:
              example:
                detail: You do not have the necessary access to perform this operation or the requested resource cannot be modified
                instance: https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749
                status: 403
                title: Forbidden
                type: https://problems.luna.akamaiapis.net/appsec-resource/error-types/ACCESS-DENIED
              schema:
                additionalProperties: true
                description: Collects data for errors.
                properties:
                  detail:
                    description: Detail error message.
                    type: string
                  errors:
                    description: A nested problem object.
                    items:
                      description: A nested problem object.
                      type: object
                      x-akamai:
                        file-path: schemas/http-problem-details-nested.yaml
                    type: array
                  instance:
                    description: The non-referencable URI that indicates the error instance.
                    type: string
                  status:
                    description: The HTTP status code.
                    example: 404
                    type: integer
                  title:
                    description: Th

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