APIs.io Engineering Platform IP Address Management Prefixes 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 Prefixes API
  version: 4.0.0
tags:
- name: IP Address Management Prefixes
paths:
  /accounts/{account_id}/addressing/loa_documents:
    post:
      description: Submit LOA document (pdf format) under the account.
      operationId: ip-address-management-prefixes-upload-loa-document
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                loa_document:
                  description: LOA document to upload.
                  example: '@document.pdf'
                  type: string
              required:
              - loa_document
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/addressing_loa_upload_response'
                - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Upload LOA Document response failure
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_loa_upload_response'
          description: Upload LOA Document response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Upload LOA Document
      tags:
      - IP Address Management Prefixes
      x-api-token-group:
      - Magic Transit Prefix Write
  /accounts/{account_id}/addressing/loa_documents/{loa_document_id}/download:
    get:
      description: Download specified LOA document under the account.
      operationId: ip-address-management-prefixes-download-loa-document
      parameters:
      - in: path
        name: loa_document_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_loa_document_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_api-response-common-failure'
          description: Download LOA Document response failure
        '200':
          content:
            application/pdf:
              schema:
                format: binary
                type: string
          description: Download LOA Document response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Download LOA Document
      tags:
      - IP Address Management Prefixes
      x-api-token-group:
      - Magic Transit Prefix Read
      - Magic Transit Prefix Write
  /accounts/{account_id}/addressing/prefixes:
    get:
      description: List all prefixes owned by the account.
      operationId: ip-address-management-prefixes-list-prefixes
      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_response_collection'
                - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: List Prefixes response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_response_collection'
          description: List Prefixes response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Prefixes
      tags:
      - IP Address Management Prefixes
      x-api-token-group:
      - Magic Transit Prefix Read
      - Magic Transit Prefix Write
      - 'IP Prefixes: Write'
      - 'IP Prefixes: Read'
      - 'IP Prefixes: BGP On Demand Write'
      - 'IP Prefixes: BGP On Demand Read'
    post:
      description: Add a new prefix under the account.
      operationId: ip-address-management-prefixes-add-prefix
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                asn:
                  $ref: '#/components/schemas/addressing_asn'
                cidr:
                  $ref: '#/components/schemas/addressing_cidr'
                loa_document_id:
                  $ref: '#/components/schemas/addressing_loa_document_identifier'
              required:
              - cidr
              - loa_document_id
              - asn
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/addressing_single_response'
                - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Add Prefix response failure
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_single_response'
          description: Add Prefix response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Add Prefix
      tags:
      - IP Address Management Prefixes
  /accounts/{account_id}/addressing/prefixes/{prefix_id}:
    delete:
      description: Delete an unapproved prefix owned by the account.
      operationId: ip-address-management-prefixes-delete-prefix
      parameters:
      - in: path
        name: prefix_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 Prefix response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_api-response-collection'
          description: Delete Prefix response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete Prefix
      tags:
      - IP Address Management Prefixes
      x-api-token-group:
      - Magic Transit Prefix Write
    get:
      description: List a particular prefix owned by the account.
      operationId: ip-address-management-prefixes-prefix-details
      parameters:
      - in: path
        name: prefix_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_single_response'
                - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Prefix Details response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_single_response'
          description: Prefix Details response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Prefix Details
      tags:
      - IP Address Management Prefixes
      x-api-token-group:
      - Magic Transit Prefix Read
      - Magic Transit Prefix Write
      - 'IP Prefixes: Write'
      - 'IP Prefixes: Read'
      - 'IP Prefixes: BGP On Demand Write'
      - 'IP Prefixes: BGP On Demand Read'
    patch:
      description: Modify the description for a prefix owned by the account.
      operationId: ip-address-management-prefixes-update-prefix-description
      parameters:
      - in: path
        name: prefix_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:
                description:
                  $ref: '#/components/schemas/addressing_description'
              required:
              - description
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/addressing_single_response'
                - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Update Prefix Description response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_single_response'
          description: Update Prefix Description response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update Prefix Description
      tags:
      - IP Address Management Prefixes
      x-api-token-group:
      - Magic Transit Prefix Write
      - 'IP Prefixes: Write'
components:
  schemas:
    addressing_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    addressing_single_response:
      allOf:
      - $ref: '#/components/schemas/addressing_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/addressing_ipam-prefixes'
    addressing_timestamp:
      example: '2014-01-01T05:20:00.12345Z'
      format: date-time
      type: string
    addressing_description:
      description: Description of the prefix.
      example: Internal test prefix
      maxLength: 1000
      type: string
    addressing_loa_upload_response:
      allOf:
      - $ref: '#/components/schemas/addressing_api-response-single'
      - properties:
          result:
            properties:
              filename:
                description: Name of LOA document.
                example: document.pdf
                type: string
            type: object
    addressing_asn:
      description: Autonomous System Number (ASN) the prefix will be advertised under.
      example: 209242
      type:
      - integer
      - 'null'
    addressing_approved:
      description: Approval state of the prefix (P = pending, V = active).
      example: P
      type: string
    addressing_modified_at_nullable:
      description: Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.
      example: '2014-01-01T05:20:00.12345Z'
      format: date-time
      type:
      - string
      - 'null'
    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_cidr:
      description: IP Prefix in Classless Inter-Domain Routing format.
      example: 192.0.2.0/24
      type: string
    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_advertised:
      description: Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.
      example: true
      type:
      - boolean
      - 'null'
    addressing_on_demand_enabled:
      description: Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.
      example: true
      type: boolean
    addressing_ipam-prefixes:
      properties:
        account_id:
          $ref: '#/components/schemas/addressing_identifier'
        advertised:
          $ref: '#/components/schemas/addressing_advertised'
        advertised_modified_at:
          $ref: '#/components/schemas/addressing_modified_at_nullable'
        approved:
          $ref: '#/components/schemas/addressing_approved'
        asn:
          $ref: '#/components/schemas/addressing_asn'
        cidr:
          $ref: '#/components/schemas/addressing_cidr'
        created_at:
          $ref: '#/components/schemas/addressing_timestamp'
        description:
          $ref: '#/components/schemas/addressing_description'
        id:
          $ref: '#/components/schemas/addressing_identifier'
        loa_document_id:
          $ref: '#/components/schemas/addressing_loa_document_identifier'
        modified_at:
          $ref: '#/components/schemas/addressing_timestamp'
        on_demand_enabled:
          $ref: '#/components/schemas/addressing_on_demand_enabled'
        on_demand_locked:
          $ref: '#/components/schemas/addressing_on_demand_locked'
      type: object
    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_response_collection:
      allOf:
      - $ref: '#/components/schemas/addressing_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/addressing_ipam-prefixes'
            type: array
    addressing_on_demand_locked:
      description: Whether advertisement status of the prefix is locked, meaning it cannot be changed.
      example: false
      type: boolean
    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_loa_document_identifier:
      description: Identifier for the uploaded LOA document.
      example: d933b1530bc56c9953cf8ce166da8004
      maxLength: 32
      type:
      - string
      - '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