APIs.io Engineering Platform IP Address Management Address Maps API

openapi: 3.2.0
info:
  description: 'To get started using Cloudflare''s products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources.


    Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions.


    To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to

    our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/).


    Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/).'
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  title: APIs.io Engineering Platform Cloudflare IP Address Management Address Maps API
  version: 4.0.0
tags:
- name: IP Address Management Address Maps
paths:
  /accounts/{account_id}/addressing/address_maps:
    get:
      description: List all address maps owned by the account.
      operationId: ip-address-management-address-maps-list-address-maps
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/addressing_components-schemas-response_collection'
                - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: List Address Maps response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_components-schemas-response_collection'
          description: List Address Maps response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Address Maps
      tags:
      - IP Address Management Address Maps
      x-api-token-group:
      - Address Maps Write
      - Address Maps Read
    post:
      description: Create a new address map under the account.
      operationId: ip-address-management-address-maps-create-address-map
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                description:
                  $ref: '#/components/schemas/addressing_schemas-description'
                enabled:
                  $ref: '#/components/schemas/addressing_enabled'
                ips:
                  items:
                    $ref: '#/components/schemas/addressing_ip_address'
                  type: array
                memberships:
                  $ref: '#/components/schemas/addressing_memberships'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/addressing_full_response'
                - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Create Address Map response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_full_response'
          description: Create Address Map response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create Address Map
      tags:
      - IP Address Management Address Maps
      x-api-token-group:
      - Address Maps Write
  /accounts/{account_id}/addressing/address_maps/{address_map_id}:
    delete:
      description: Delete a particular address map owned by the account. An Address Map must be disabled before it can be deleted.
      operationId: ip-address-management-address-maps-delete-address-map
      parameters:
      - in: path
        name: address_map_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/addressing_api-response-collection'
                - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Delete Address Map response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_api-response-collection'
          description: Delete Address Map response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete Address Map
      tags:
      - IP Address Management Address Maps
      x-api-token-group:
      - Address Maps Write
    get:
      description: Show a particular address map owned by the account.
      operationId: ip-address-management-address-maps-address-map-details
      parameters:
      - in: path
        name: address_map_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/addressing_full_response'
                - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Address Map Details response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_full_response'
          description: Address Map Details response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Address Map Details
      tags:
      - IP Address Management Address Maps
      x-api-token-group:
      - Address Maps Write
      - Address Maps Read
    patch:
      description: Modify properties of an address map owned by the account.
      operationId: ip-address-management-address-maps-update-address-map
      parameters:
      - in: path
        name: address_map_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                default_sni:
                  $ref: '#/components/schemas/addressing_default_sni'
                description:
                  $ref: '#/components/schemas/addressing_schemas-description'
                enabled:
                  $ref: '#/components/schemas/addressing_enabled'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/addressing_components-schemas-single_response'
                - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Update Address Map response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_components-schemas-single_response'
          description: Update Address Map response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update Address Map
      tags:
      - IP Address Management Address Maps
      x-api-token-group:
      - Address Maps Write
  /accounts/{account_id}/addressing/address_maps/{address_map_id}/accounts/{account_id}:
    delete:
      description: Remove an account as a member of a particular address map.
      operationId: ip-address-management-address-maps-remove-an-account-membership-from-an-address-map
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      - in: path
        name: address_map_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/addressing_api-response-collection'
                - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Remove an account membership from an Address Map response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_api-response-collection'
          description: Remove an account membership from an Address Map response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Remove an account membership from an Address Map
      tags:
      - IP Address Management Address Maps
    put:
      description: Add an account as a member of a particular address map.
      operationId: ip-address-management-address-maps-add-an-account-membership-to-an-address-map
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      - in: path
        name: address_map_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/addressing_api-response-collection'
                - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Add an account membership to an Address Map response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_api-response-collection'
          description: Add an account membership to an Address Map response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Add an account membership to an Address Map
      tags:
      - IP Address Management Address Maps
  /accounts/{account_id}/addressing/address_maps/{address_map_id}/ips/{ip_address}:
    delete:
      description: Remove an IP from a particular address map.
      operationId: ip-address-management-address-maps-remove-an-ip-from-an-address-map
      parameters:
      - in: path
        name: ip_address
        required: true
        schema:
          $ref: '#/components/schemas/addressing_ip_address'
      - in: path
        name: address_map_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/addressing_api-response-collection'
                - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Remove an IP from an Address Map response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_api-response-collection'
          description: Remove an IP from an Address Map response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Remove an IP from an Address Map
      tags:
      - IP Address Management Address Maps
      x-api-token-group:
      - Address Maps Write
    put:
      description: Add an IP from a prefix owned by the account to a particular address map.
      operationId: ip-address-management-address-maps-add-an-ip-to-an-address-map
      parameters:
      - in: path
        name: ip_address
        required: true
        schema:
          $ref: '#/components/schemas/addressing_ip_address'
      - in: path
        name: address_map_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/addressing_api-response-collection'
                - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Add an IP to an Address Map response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_api-response-collection'
          description: Add an IP to an Address Map response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Add an IP to an Address Map
      tags:
      - IP Address Management Address Maps
      x-api-token-group:
      - Address Maps Write
  /accounts/{account_id}/addressing/address_maps/{address_map_id}/zones/{zone_id}:
    delete:
      description: Remove a zone as a member of a particular address map.
      operationId: ip-address-management-address-maps-remove-a-zone-membership-from-an-address-map
      parameters:
      - in: path
        name: zone_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      - in: path
        name: address_map_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/addressing_api-response-collection'
                - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Remove a zone membership from an Address Map response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_api-response-collection'
          description: Remove a zone membership from an Address Map response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Remove a zone membership from an Address Map
      tags:
      - IP Address Management Address Maps
    put:
      description: Add a zone as a member of a particular address map.
      operationId: ip-address-management-address-maps-add-a-zone-membership-to-an-address-map
      parameters:
      - in: path
        name: zone_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      - in: path
        name: address_map_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/addressing_api-response-collection'
                - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Add a zone membership to an Address Map response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_api-response-collection'
          description: Add a zone membership to an Address Map response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Add a zone membership to an Address Map
      tags:
      - IP Address Management Address Maps
components:
  schemas:
    addressing_schemas-identifier:
      description: The identifier for the membership (eg. a zone or account tag).
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    addressing_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    addressing_can_delete:
      description: If set to false, then the Address Map cannot be deleted via API. This is true for Cloudflare-managed maps.
      example: true
      readOnly: true
      type: boolean
    addressing_default_sni:
      description: If you have legacy TLS clients which do not send the TLS server name indicator, then you can specify one default SNI on the map. If Cloudflare receives a TLS handshake from a client without an SNI, it will respond with the default SNI on those IPs. The default SNI can be any valid zone or subdomain owned by the account.
      example: '*.example.com'
      type:
      - string
      - 'null'
    addressing_timestamp:
      example: '2014-01-01T05:20:00.12345Z'
      format: date-time
      type: string
    addressing_schemas-can_delete:
      description: Controls whether the membership can be deleted via the API or not.
      example: true
      readOnly: true
      type: boolean
    addressing_address-maps:
      properties:
        can_delete:
          $ref: '#/components/schemas/addressing_can_delete'
        can_modify_ips:
          $ref: '#/components/schemas/addressing_can_modify_ips'
        created_at:
          $ref: '#/components/schemas/addressing_timestamp'
        default_sni:
          $ref: '#/components/schemas/addressing_default_sni'
        description:
          $ref: '#/components/schemas/addressing_schemas-description'
        enabled:
          $ref: '#/components/schemas/addressing_enabled'
        id:
          $ref: '#/components/schemas/addressing_identifier'
        modified_at:
          $ref: '#/components/schemas/addressing_timestamp'
      type: object
    addressing_address-maps-ip:
      properties:
        created_at:
          $ref: '#/components/schemas/addressing_timestamp'
        ip:
          $ref: '#/components/schemas/addressing_ip'
      type: object
    addressing_address-maps-membership:
      properties:
        can_delete:
          $ref: '#/components/schemas/addressing_schemas-can_delete'
        created_at:
          $ref: '#/components/schemas/addressing_timestamp'
        identifier:
          $ref: '#/components/schemas/addressing_schemas-identifier'
        kind:
          $ref: '#/components/schemas/addressing_kind'
      type: object
    addressing_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/addressing_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/addressing_address-maps'
    addressing_ip:
      description: An IPv4 or IPv6 address.
      example: 192.0.2.1
      type: string
    addressing_full_response:
      allOf:
      - $ref: '#/components/schemas/addressing_api-response-single'
      - properties:
          result:
            allOf:
            - $ref: '#/components/schemas/addressing_address-maps'
            - properties:
                ips:
                  $ref: '#/components/schemas/addressing_schemas-ips'
                memberships:
                  $ref: '#/components/schemas/addressing_memberships'
              type: object
        type: object
    addressing_kind:
      description: The type of the membership.
      enum:
      - zone
      - account
      example: zone
      type: string
    addressing_schemas-ips:
      description: The set of IPs on the Address Map.
      items:
        $ref: '#/components/schemas/addressing_address-maps-ip'
      type: array
    addressing_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/addressing_messages'
        messages:
          $ref: '#/components/schemas/addressing_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    addressing_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/addressing_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/addressing_address-maps'
            type: array
    addressing_can_modify_ips:
      description: If set to false, then the IPs on the Address Map cannot be modified via the API. This is true for Cloudflare-managed maps.
      example: true
      readOnly: true
      type: boolean
    addressing_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/addressing_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/addressing_messages'
          example: []
        result:
          enum:
          - null
          type:
          - object
          - 'null'
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    addressing_schemas-description:
      description: An optional description field which may be used to describe the types of IPs or zones on the map.
      example: My Ecommerce zones
      type:
      - string
      - 'null'
    addressing_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    addressing_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/addressing_api-response-common'
      - properties:
          result_info:
            $ref: '#/components/schemas/addressing_result_info'
      type: object
    addressing_memberships:
      description: Zones and Accounts which will be assigned IPs on this Address Map. A zone membership will take priority over an account membership.
      items:
        $ref: '#/components/schemas/addressing_address-maps-membership'
      type: array
    addressing_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    addressing_api-response-single:
      allOf:
      - $ref: '#/components/schemas/addressing_api-response-common'
      type: object
    addressing_ip_address:
      description: An IPv4 or IPv6 address.
      example: 192.0.2.1
      type: string
    addressing_enabled:
      default: false
      description: Whether the Address Map is enabled or not. Cloudflare's DNS will not respond with IP addresses on an Address Map until the map is enabled.
      example: true
      type:
      - boolean
      - 'null'
  securitySchemes:
    api_email:
      in: header
      name: X-Auth-Email
      type: apiKey
    api_key:
      in: header
      name: X-Auth-Key
      type: apiKey
    api_token:
      scheme: bearer
      type: http
    user_service_key:
      in: header
      name: X-Auth-User-Service-Key
      type: apiKey