APIs.io Engineering Platform IP Address Management BGP 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 BGP Prefixes API
  version: 4.0.0
tags:
- name: IP Address Management BGP Prefixes
paths:
  /accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes:
    get:
      description: List all BGP Prefixes within the specified IP Prefix. BGP Prefixes are used to control which specific subnets are advertised to the Internet. It is possible to advertise subnets more specific than an IP Prefix by creating more specific BGP Prefixes.
      operationId: ip-address-management-prefixes-list-bgp-prefixes
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      - in: path
        name: prefix_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/addressing_response_collection_bgp'
                - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: List BGP Prefixes response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_response_collection_bgp'
          description: List BGP Prefixes response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List BGP Prefixes
      tags:
      - IP Address Management BGP 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'
  /accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes/{bgp_prefix_id}:
    get:
      description: Retrieve a single BGP Prefix according to its identifier
      operationId: ip-address-management-prefixes-fetch-bgp-prefix
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      - in: path
        name: prefix_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      - in: path
        name: bgp_prefix_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/addressing_single_response_bgp'
                - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Fetch BGP Prefix response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_single_response_bgp'
          description: Fetch BGP Prefix response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Fetch BGP Prefix
      tags:
      - IP Address Management BGP 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: Update the properties of a BGP Prefix, such as the on demand advertisement status (advertised or withdrawn).
      operationId: ip-address-management-prefixes-update-bgp-prefix
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      - in: path
        name: prefix_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      - in: path
        name: bgp_prefix_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/addressing_bgp_prefix_update_advertisement'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/addressing_single_response_bgp'
                - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Update BGP Prefix response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_single_response_bgp'
          description: Update BGP Prefix response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update BGP Prefix
      tags:
      - IP Address Management BGP Prefixes
      x-api-token-group:
      - Magic Transit Prefix Write
      - 'IP Prefixes: Write'
      - 'IP Prefixes: BGP On Demand Write'
components:
  schemas:
    addressing_response_collection_bgp:
      allOf:
      - $ref: '#/components/schemas/addressing_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/addressing_ipam-bgp-prefixes'
            type: array
    addressing_bgp_signaling_enabled:
      description: Whether control of advertisement of the prefix to the Internet is enabled to be performed via BGP signal
      example: false
      type: boolean
    addressing_ipam-bgp-prefixes:
      properties:
        asn:
          $ref: '#/components/schemas/addressing_asn'
        bgp_signal_opts:
          $ref: '#/components/schemas/addressing_bgp_signal_opts'
        cidr:
          $ref: '#/components/schemas/addressing_cidr'
        created_at:
          $ref: '#/components/schemas/addressing_timestamp'
        id:
          $ref: '#/components/schemas/addressing_identifier'
        modified_at:
          $ref: '#/components/schemas/addressing_timestamp'
        on_demand:
          $ref: '#/components/schemas/addressing_bgp_on_demand'
      type: object
    addressing_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    addressing_timestamp:
      example: '2014-01-01T05:20:00.12345Z'
      format: date-time
      type: string
    addressing_bgp_signal_opts:
      properties:
        enabled:
          $ref: '#/components/schemas/addressing_bgp_signaling_enabled'
        modified_at:
          $ref: '#/components/schemas/addressing_bgp_signaling_modified_at'
      type: object
    addressing_asn:
      description: Autonomous System Number (ASN) the prefix will be advertised under.
      example: 209242
      type:
      - integer
      - 'null'
    addressing_bgp_on_demand:
      properties:
        advertised:
          $ref: '#/components/schemas/addressing_advertised'
        advertised_modified_at:
          $ref: '#/components/schemas/addressing_modified_at_nullable'
        on_demand_enabled:
          $ref: '#/components/schemas/addressing_on_demand_enabled'
        on_demand_locked:
          $ref: '#/components/schemas/addressing_on_demand_locked'
      type: object
    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_bgp_signaling_modified_at:
      description: Last time BGP signaling control was toggled. This field is null if BGP signaling has never been enabled.
      example: '2014-01-01T05:20:00.12345Z'
      format: date-time
      type:
      - string
      - 'null'
    addressing_bgp_prefix_update_advertisement:
      properties:
        on_demand:
          properties:
            advertised:
              type: boolean
          type: object
      type: object
    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_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_single_response_bgp:
      allOf:
      - $ref: '#/components/schemas/addressing_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/addressing_ipam-bgp-prefixes'
    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
  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