Akamai Elements API

openapi: 3.0.0
info:
  title: 'Akamai: API Endpoint Definition Access tokens Elements 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: Elements
paths:
  /network-lists/{networkListId}/elements:
    parameters:
    - description: Unique identifier for each network list.
      example: '{{networkListId}}'
      in: path
      name: networkListId
      required: true
      schema:
        example: 12345_BLACKLISTEDGEOS
        type: string
      x-akamai:
        file-path: parameters/networkListId-path.yaml
    put:
      description: Adds the specified `element` to the list.  If the network list's `type` is `IP`, the value needs to be a URL-encoded IP address or CIDR block. If the type is `GEO`, it's a two-character country code. (See the [EdgeScape Documentation](https://control.akamai.com/apps/download-center/#/products/3;name=EdgeScape)) for more information. For a list of countries, go to __Data Codes__ ⇒ __Country Code__.)
      operationId: put-network-list-elements
      summary: Akamai Add an Element
      tags:
      - Elements
      externalDocs:
        description: See documentation for this operation in Akamai's Network Lists API
        url: https://techdocs.akamai.com/network-lists/reference/put-network-list-elements
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              example:
                contractId: K-0N7RAK71
                elementCount: 13
                groupId: 517014
                name: My Network List
                networkListType: networkListResponse
                readOnly: true
                shared: true
                syncPoint: 65
                type: IP
                uniqueId: 1024_NETWORKLIST
                list:
                - 192.0.2.228/24
                - 12.129.0.0/15
                - 12.211.0.0/15
                - 192.0.2.237/24
                - 192.0.2.214/24
                - 12.231.0.0/14
                - 12.235.0.0/14
                - 192.0.2.76/24
                - 192.0.2.47/24
                - 192.0.2.148/24
                - 192.0.2.169/24
                - 192.0.2.159/24
                - 192.0.2.80/24
                links:
                  activateInProduction:
                    href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/environments/PRODUCTION/activate
                    method: POST
                  activateInStaging:
                    href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/environments/STAGING/activate
                    method: POST
                  appendItems:
                    href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/append
                    method: POST
                  retrieve:
                    href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU
                  statusInProduction:
                    href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/environments/PRODUCTION/status
                  statusInStaging:
                    href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/environments/STAGING/status
                  update:
                    href: /network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU
                    method: PUT
              schema:
                additionalProperties: false
                description: Encapsulates information about each network list.
                type: object
                required:
                - name
                - syncPoint
                - type
                - uniqueId
                properties:
                  accessControlGroup:
                    description: Name of this network list's access control group (ACG).
                    type: string
                  contractId:
                    description: Identifies the contract where you want to create the list. You need to have write access to the contract you specify. If you include a `contractId`, you need to pair it with a `groupId`.
                    maxLength: 20
                    minLength: 5
                    type: string
                  createDate:
                    description: ISO 8601 timestamp indicating when the network list was first created. Available only when using the `extended` query parameter to retrieve network list data.
                    example: '2017-06-01T15:13:40.36Z'
                    format: date-time
                    type: string
                  createdBy:
                    description: Username of this list's creator. Available only when using the `extended` query parameter to retrieve network list data.
                    type: string
                  description:
                    description: Detailed description of the list.
                    maxLength: 255
                    minLength: 1
                    type: string
                  elementCount:
                    description: Reflects the number of elements in the `list` array, which may not necessarily appear in the object when retrieving the list with the `includeElements` query parameter set to `false`.
                    type: integer
                  expeditedProductionActivationStatus:
                    description: For clients with access to _expedited_ activations on select servers, provides the most recent activation status in the `PRODUCTION` environment. See [Activation States](https://techdocs.akamai.com/network-lists/reference/activation-states) for details on each activation state. Available only when using the `extended` query parameter to retrieve network list data.
                    example: INACTIVE
                    type: string
                    enum:
                    - INACTIVE
                    - ACTIVE
                    - MODIFIED
                    - PENDING_ACTIVATION
                    - FAILED
                    - PENDING_DEACTIVATION
                  expeditedStagingActivationStatus:
                    description: For clients with access to _expedited_ activations on select servers, provides the most recent activation status in the `STAGING` environment. See [Activation States](https://techdocs.akamai.com/network-lists/reference/activation-states) for details on each activation state. Available only when using the `extended` query parameter to retrieve network list data.
                    example: INACTIVE
                    type: string
                    enum:
                    - INACTIVE
                    - ACTIVE
                    - MODIFIED
                    - PENDING_ACTIVATION
                    - FAILED
                    - PENDING_DEACTIVATION
                  groupId:
                    description: Identifies the group where you want to create the list. You need to have write access to the group you specify. If you include a `groupId`, you need to pair it with a `contractId`.
                    type: number
                  links:
                    additionalProperties: false
                    description: Encapsulates the set of [API hypermedia](https://techdocs.akamai.com/network-lists/reference/api-hypermedia) to access a set of resources related to this network list. The object is arranged as a hash of keys, each of which represents a link relation.
                    type: object
                    properties:
                      activateInProduction:
                        additionalProperties: false
                        description: A link to [Activate a network list](https://techdocs.akamai.com/network-lists/reference/post-network-list-activate) in the `PRODUCTION` environment.
                        type: object
                        required:
                        - href
                        properties:
                          detail:
                            description: Any additional information about the target of the link.
                            type: string
                          href:
                            description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call.
                            type: string
                          method:
                            default: GET
                            description: The HTTP method with which to call the `href`, `GET` by default.
                            type: string
                        x-akamai:
                          file-path: schemas/link.yaml
                      activateInStaging:
                        additionalProperties: false
                        description: A link to [Activate a network list](https://techdocs.akamai.com/network-lists/reference/post-network-list-activate) in the `STAGING` environment.
                        type: object
                        required:
                        - href
                        properties:
                          detail:
                            description: Any additional information about the target of the link.
                            type: string
                          href:
                            description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call.
                            type: string
                          method:
                            default: GET
                            description: The HTTP method with which to call the `href`, `GET` by default.
                            type: string
                        x-akamai:
                          file-path: schemas/link.yaml
                      activationDetails:
                        additionalProperties: false
                        description: A link to [Get activation details](https://techdocs.akamai.com/network-lists/reference/get-activation).
                        type: object
                        required:
                        - href
                        properties:
                          detail:
                            description: Any additional information about the target of the link.
                            type: string
                          href:
                            description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call.
                            type: string
                          method:
                            default: GET
                            description: The HTTP method with which to call the `href`, `GET` by default.
                            type: string
                        x-akamai:
                          file-path: schemas/link.yaml
                      appendItems:
                        additionalProperties: false
                        description: A link to [Append elements to a network list](https://techdocs.akamai.com/network-lists/reference/post-network-list-append).
                        type: object
                        required:
                        - href
                        properties:
                          detail:
                            description: Any additional information about the target of the link.
                            type: string
                          href:
                            description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call.
                            type: string
                          method:
                            default: GET
                            description: The HTTP method with which to call the `href`, `GET` by default.
                            type: string
                        x-akamai:
                          file-path: schemas/link.yaml
                      retrieve:
                        additionalProperties: false
                        description: A link to [Get a network list](https://techdocs.akamai.com/network-lists/reference/get-network-list).
                        type: object
                        required:
                        - href
                        properties:
                          detail:
                            description: Any additional information about the target of the link.
                            type: string
                          href:
                            description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call.
                            type: string
                          method:
                            default: GET
                            description: The HTTP method with which to call the `href`, `GET` by default.
                            type: string
                        x-akamai:
                          file-path: schemas/link.yaml
                      statusInProduction:
                        additionalProperties: false
                        description: A link to [Get activation status](https://techdocs.akamai.com/network-lists/reference/get-network-list-status) for the `PRODUCTION` environment.
                        type: object
                        required:
                        - href
                        properties:
                          detail:
                            description: Any additional information about the target of the link.
                            type: string
                          href:
                            description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call.
                            type: string
                          method:
                            default: GET
                            description: The HTTP method with which to call the `href`, `GET` by default.
                            type: string
                        x-akamai:
                          file-path: schemas/link.yaml
                      statusInStaging:
                        additionalProperties: false
                        description: A link to [Get activation status](https://techdocs.akamai.com/network-lists/reference/get-network-list-status) for the `STAGING` environment.
                        type: object
                        required:
                        - href
                        properties:
                          detail:
                            description: Any additional information about the target of the link.
                            type: string
                          href:
                            description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call.
                            type: string
                          method:
                            default: GET
                            description: The HTTP method with which to call the `href`, `GET` by default.
                            type: string
                        x-akamai:
                          file-path: schemas/link.yaml
                      update:
                        additionalProperties: false
                        description: A link to [Update a network list](https://techdocs.akamai.com/network-lists/reference/put-network-list).
                        type: object
                        required:
                        - href
                        properties:
                          detail:
                            description: Any additional information about the target of the link.
                            type: string
                          href:
                            description: URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call.
                            type: string
                          method:
                            default: GET
                            description: The HTTP method with which to call the `href`, `GET` by default.
                            type: string
                        x-akamai:
                          file-path: schemas/link.yaml
                  list:
                    description: Defines the network list's set of elements. If the `type` is `IP`, values are any combination of IPv4 addresses, IPv6 addresses, or CIDR blocks. If the `type` is `GEO`, values are ISO 3166 two-character country codes. This array does not appear in the object if you get it with the `includeElements` query parameter set to `false`.
                    type: array
                    items:
                      example: FR
                      minLength: 0
                      type: string
                  name:
                    description: Display name of the network list.
                    maxLength: 100
                    minLength: 1
                    type: string
                  networkListType:
                    description: If set to `extendedNetworkListResponse`, indicates that the current data features members enabled with the `extended` query parameter. Otherwise a plain `networkListResponse` value indicates this additional data is absent.
                    example: extendedNetworkListResponse
                    type: string
                    enum:
                    - networkListResponse
                    - extendedNetworkListResponse
                  productionActivationStatus:
                    description: The most recent activation status of the current list in the `PRODUCTION` environment.  See [Activation States](https://techdocs.akamai.com/network-lists/reference/activation-states) for details on each activation state. Available only when using the `extended` query parameter to retrieve network list data.
                    example: INACTIVE
                    type: string
                    enum:
                    - INACTIVE
                    - ACTIVE
                    - MODIFIED
                    - PENDING_ACTIVATION
                    - FAILED
                    - PENDING_DEACTIVATION
                  readOnly:
                    default: false
                    description: If `true`, indicates that you don't have permission to modify the network list. This may indicate either a network list that Akamai manages, or insufficient permission for your API client's identity to modify a customer-managed list. The default value is `false`.
                    type: boolean
                  shared:
                    default: false
                    description: Indicates if this list has been shared with you by Akamai or some other account. Shared lists are always read-only.
                    type: boolean
                  stagingActivationStatus:
                    description: The most recent activation status of the current list in the `STAGING` environment. See [Activation States](https://techdocs.akamai.com/network-lists/reference/activation-states) for details on each activation state. Available only when using the `extended` query parameter to retrieve network list data.
                    example: INACTIVE
                    type: string
                    enum:
                    - INACTIVE
                    - ACTIVE
                    - MODIFIED
                    - PENDING_ACTIVATION
                    - FAILED
                    - PENDING_DEACTIVATION
                  syncPoint:
                    default: 0
                    description: Identifies each version of the network list, which increments each time it's modified. You need to include this value in any requests to modify the list. See [Concurrency control](https://techdocs.akamai.com/network-lists/reference/concurrency-control) for details.
                    minimum: 0
                    type: integer
                  type:
                    description: The network list type, either `IP` for IP addresses and CIDR blocks, or `GEO` for two-letter country codes.
                    type: string
                    enum:
                    - IP
                    - GEO
                  uniqueId:
                    description: A unique identifier for each network list, corresponding to the `networkListId` URL parameter.
                    minLength: 3
                    readOnly: true
                    type: string
                  updateDate:
                    description: ISO 8601 timestamp indicating when the network list was last modified. Available only when using the `extended` query parameter to retrieve network list data.
                    example: '2017-06-01T15:13:40.36Z'
                    format: date-time
                    type: string
                  updatedBy:
                    description: Username of this list's creator. Available only when using the `extended` query parameter to retrieve network list data.
                    type: string
                x-akamai:
                  file-path: schemas/retrieve.yaml
        '400':
          description: Incorrect client input. See the field errors provided in the response for more information.  This error may also be returned in place of a 404 if a URL parameter was provided in an incorrect format.
          content:
            application/problem+json:
              schema:
                additionalProperties: false
                type: object
                required:
                - type
                - status
                - title
                properties:
                  detail:
                    description: Detailed error message provided by the server.
                    type: string
                  errors:
                    type: array
                    items:
                      additionalProperties: false
                      type: object
                      required:
                      - type
                      - status
                      - title
                      properties:
                        detail:
                          description: Detailed error message provided by the server.
                          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
                          additionalProperties:
                            type: string
                        instance:
                          description: Referenceable URL for this error occurrence.
                          example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749
                          type: string
                        status:
                          description: HTTP status code.
                          example: 404
                          type: integer
                        title:
                          description: Title for the error.
                          example: Not Found
                          type: string
                        type:
                          description: URL for the error type.
                          example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND
                          type: string
                      x-akamai:
                        file-path: schemas/error-nested.yaml
                  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
                    additionalProperties:
                      type: string
                  instance:
                    description: Referenceable URL for this error occurrence.
                    example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749
                    type: string
                  status:
                    description: HTTP status code.
                    example: 404
                    type: integer
                  title:
                    description: Title for the error.
                    example: Not Found
                    type: string
                  type:
                    description: URL for the error type.
                    example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND
                    type: string
                x-akamai:
                  file-path: schemas/error.yaml
        '403':
          description: Forbidden. You don't have permission to perform that function on this network list. Check that your user has the required privileges.
          content:
            application/problem+json:
              schema:
                additionalProperties: false
                type: object
                required:
                - type
                - status
                - title
                properties:
                  detail:
                    description: Detailed error message provided by the server.
                    type: string
                  errors:
                    type: array
                    items:
                      additionalProperties: false
                      type: object
                      required:
                      - type
                      - status
                      - title
                      properties:
                        detail:
                          description: Detailed error message provided by the server.
                          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
                          additionalProperties:
                            type: string
                        instance:
                          description: Referenceable URL for this error occurrence.
                          example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749
                          type: string
                        status:
                          description: HTTP status code.
                          example: 404
                          type: integer
                        title:
                          description: Title for the error.
                          example: Not Found
                          type: string
                        type:
                          description: URL for the error type.
                          example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND
                          type: string
                      x-akamai:
                        file-path: schemas/error-nested.yaml
                  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
                    additionalProperties:
                      type: string
                  instance:
                    description: Referenceable URL for this error occurrence.
                    example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749
                    type: string
                  status:
                    description: HTTP status code.
                    example: 404
                    type: integer
                  title:
                    description: Title for the error.
                    example: Not Found
                    type: string
                  type:
                    description: URL for the error type.
                    example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND
                    type: string
                x-akamai:
                  file-path: schemas/error.yaml
        '404':
          description: Incorrect URL. Check that the network list ID and other URL parameters are valid.
          content:
            application/problem+json:
              schema:
                additionalProperties: false
                type: object
                required:
                - type
                - status
                - title
                properties:
                  detail:
                    description: Detailed error message provided by the server.
                    type: string
                  errors:
                    type: array
                    items:
                      additionalProperties: false
                      type: object
                      required:
                      - type
                      - status
                      - title
                      properties:
                        detail:
                          description: Detailed error message provided by the server.
                          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
                          additionalProperties:
                            type: string
                        instance:
                          description: Referenceable URL for this error occurrence.
                          example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749
                          type: string
                        status:
                          description: HTTP status code.
                          example: 404
                          type: integer
                        title:
                          description: Title for the error.
                          example: Not Found
                          type: string
                        type:
                          description: URL for the error type.
                          example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND
                          type: string
                      x-akamai:
                        file-path: schemas/error-nested.yaml
                  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
                    additionalProperties:
                      type: string
                  instance:
                    description: Referenceable URL for this error occurrence.
                    example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749
                    type: string
                  status:
                    description: HTTP status code.
                    example: 404
                    type: integer
                  title:
                    description: Title for the error.
                    example: Not Found
                    type: string
                  type:
                    description: URL for the error type.
                    example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND
                    type: string
                x-akamai:
                  file-path: schemas/error.yaml
        '500':
          description: We encountered an unexpected issue while processing your request. Please follow the advice provided in the message.
          content:
            application/problem+json:
              schema:
                additionalProperties: false
                type: object
                required:
                - type
                - status
                - title
                properties:
                  detail:
                    description: Detailed error message provided by the server.
                    type: string
                  err

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