APIs.io Engineering Platform Magic Interconnects 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 Magic Interconnects API
  version: 4.0.0
tags:
- name: Magic Interconnects
paths:
  /accounts/{account_id}/magic/cf_interconnects:
    get:
      description: Lists interconnects associated with an account.
      operationId: magic-interconnects-list-interconnects
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/magic_components-schemas-tunnels_collection_response'
                - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: List interconnects response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_components-schemas-tunnels_collection_response'
          description: List interconnects response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List interconnects
      tags:
      - Magic Interconnects
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      description: Updates multiple interconnects associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.
      operationId: magic-interconnects-update-multiple-interconnects
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              required:
              - id
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/magic_components-schemas-modified_tunnels_collection_response'
                - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Update multiple interconnects response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_components-schemas-modified_tunnels_collection_response'
          description: Update multiple interconnects response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update multiple interconnects
      tags:
      - Magic Interconnects
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/cf_interconnects/{cf_interconnect_id}:
    get:
      description: Lists details for a specific interconnect.
      operationId: magic-interconnects-list-interconnect-details
      parameters:
      - in: path
        name: cf_interconnect_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/magic_components-schemas-tunnel_single_response'
                - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: List interconnect Details response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_components-schemas-tunnel_single_response'
          description: List interconnect Details response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List interconnect Details
      tags:
      - Magic Interconnects
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      description: Updates a specific interconnect associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.
      operationId: magic-interconnects-update-interconnect
      parameters:
      - in: path
        name: cf_interconnect_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_components-schemas-tunnel_update_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/magic_components-schemas-tunnel_modified_response'
                - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Update interconnect response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_components-schemas-tunnel_modified_response'
          description: Update interconnect response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update interconnect
      tags:
      - Magic Interconnects
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
components:
  schemas:
    magic_schemas-created_on:
      description: The date and time the tunnel was created.
      example: '2017-06-14T00:00:00Z'
      format: date-time
      readOnly: true
      type: string
    magic_components-schemas-modified_tunnels_collection_response:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-single'
      - properties:
          result:
            properties:
              modified:
                example: true
                type: boolean
              modified_interconnects:
                items:
                  $ref: '#/components/schemas/magic_interconnect'
                type: array
    magic_schemas-health_check:
      properties:
        enabled:
          default: true
          description: Determines whether to run healthchecks for a tunnel.
          example: true
          type: boolean
        rate:
          default: mid
          description: How frequent the health check is run. The default value is `mid`.
          enum:
          - low
          - mid
          - high
          example: low
          type: string
        target:
          description: The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`.
          example: 203.0.113.1
          type: string
        type:
          default: reply
          description: The type of healthcheck to run, reply or request. The default value is `reply`.
          enum:
          - reply
          - request
          example: request
          type: string
      type: object
    magic_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/magic_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/magic_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
    magic_interconnect_components-schemas-description:
      description: An optional description of the interconnect.
      example: Tunnel for Interconnect to ORD
      type: string
    magic_components-schemas-tunnel_modified_response:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-single'
      - properties:
          result:
            properties:
              modified:
                example: true
                type: boolean
              modified_interconnect:
                $ref: '#/components/schemas/magic_interconnect'
            type: object
    magic_components-schemas-tunnels_collection_response:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-single'
      - properties:
          result:
            properties:
              interconnects:
                items:
                  $ref: '#/components/schemas/magic_interconnect'
                type: array
    magic_schemas-modified_on:
      description: The date and time the tunnel was last modified.
      example: '2017-06-14T05:20:00Z'
      format: date-time
      readOnly: true
      type: string
    magic_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    magic_components-schemas-tunnel_update_request:
      properties:
        description:
          $ref: '#/components/schemas/magic_interconnect_components-schemas-description'
        gre:
          $ref: '#/components/schemas/magic_gre'
        health_check:
          $ref: '#/components/schemas/magic_schemas-health_check'
        interface_address:
          $ref: '#/components/schemas/magic_interface_address'
        mtu:
          $ref: '#/components/schemas/magic_schemas-mtu'
      type: object
    magic_interface_address:
      description: 'A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side of the tunnel. Select the subnet from the following private IP space: 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.'
      example: 192.0.2.0/31
      type: string
    magic_components-schemas-tunnel_single_response:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-single'
      - properties:
          result:
            properties:
              interconnect:
                $ref: '#/components/schemas/magic_interconnect'
            type: object
    magic_interconnect:
      properties:
        colo_name:
          $ref: '#/components/schemas/magic_components-schemas-name'
        created_on:
          $ref: '#/components/schemas/magic_schemas-created_on'
        description:
          $ref: '#/components/schemas/magic_interconnect_components-schemas-description'
        gre:
          $ref: '#/components/schemas/magic_gre'
        health_check:
          $ref: '#/components/schemas/magic_schemas-health_check'
        id:
          $ref: '#/components/schemas/magic_schemas-identifier'
        interface_address:
          $ref: '#/components/schemas/magic_interface_address'
        modified_on:
          $ref: '#/components/schemas/magic_schemas-modified_on'
        mtu:
          $ref: '#/components/schemas/magic_schemas-mtu'
        name:
          $ref: '#/components/schemas/magic_components-schemas-name'
      type: object
    magic_gre:
      description: The configuration specific to GRE interconnects.
      properties:
        cloudflare_endpoint:
          description: The IP address assigned to the Cloudflare side of the GRE tunnel created as part of the Interconnect.
          example: 203.0.113.1
          type: string
      type: object
    magic_components-schemas-name:
      description: The name of the interconnect. The name cannot share a name with other tunnels.
      example: pni_ord
      type: string
    magic_api-response-single:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-common'
      - properties:
          result:
            anyOf:
            - type:
              - object
              - 'null'
            - type:
              - string
              - 'null'
      type: object
    magic_schemas-identifier:
      description: Tunnel identifier tag.
      example: c4a7362d577a6c3019a474fd6f485821
      maxLength: 32
      readOnly: true
      type: string
    magic_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/magic_messages'
        messages:
          $ref: '#/components/schemas/magic_messages'
        result:
          anyOf:
          - type: object
          - items: {}
            type: array
          - type: string
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    magic_schemas-mtu:
      default: 1476
      description: The Maximum Transmission Unit (MTU) in bytes for the interconnect. The minimum value is 576.
      type: integer
    magic_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
  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