APIs.io Engineering Platform Magic Static Routes 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 Static Routes API
  version: 4.0.0
tags:
- name: Magic Static Routes
paths:
  /accounts/{account_id}/magic/routes:
    delete:
      description: Delete multiple Magic static routes.
      operationId: magic-static-routes-delete-many-routes
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_route_delete_many_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/magic_multiple_route_delete_response'
                - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Delete Many Routes response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_multiple_route_delete_response'
          description: Delete Many Routes response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete Many Routes
      tags:
      - Magic Static Routes
      x-cfPermissionsRequired:
        enum:
        - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    get:
      description: List all Magic static routes.
      operationId: magic-static-routes-list-routes
      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_routes_collection_response'
                - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: List Routes response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_routes_collection_response'
          description: List Routes response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Routes
      tags:
      - Magic Static Routes
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    post:
      description: Creates a new Magic static route. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes.
      operationId: magic-static-routes-create-routes
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              required:
              - prefix
              - nexthop
              - priority
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/magic_routes_collection_response'
                - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Create Routes response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_routes_collection_response'
          description: Create Routes response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create Routes
      tags:
      - Magic Static Routes
      x-cfPermissionsRequired:
        enum:
        - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      description: Update multiple Magic static routes. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes. Only fields for a route that need to be changed need be provided.
      operationId: magic-static-routes-update-many-routes
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_route_update_many_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/magic_multiple_route_modified_response'
                - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Update Many Routes response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_multiple_route_modified_response'
          description: Update Many Routes response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update Many Routes
      tags:
      - Magic Static Routes
      x-cfPermissionsRequired:
        enum:
        - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/routes/{route_id}:
    delete:
      description: Disable and remove a specific Magic static route.
      operationId: magic-static-routes-delete-route
      parameters:
      - in: path
        name: route_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: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/magic_route_deleted_response'
                - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Delete Route response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_route_deleted_response'
          description: Delete Route response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete Route
      tags:
      - Magic Static Routes
      x-cfPermissionsRequired:
        enum:
        - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    get:
      description: Get a specific Magic static route.
      operationId: magic-static-routes-route-details
      parameters:
      - in: path
        name: route_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_route_single_response'
                - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Route Details response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_route_single_response'
          description: Route Details response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Route Details
      tags:
      - Magic Static Routes
      x-cfPermissionsRequired:
        enum:
        - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      description: Update a specific Magic static route. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes.
      operationId: magic-static-routes-update-route
      parameters:
      - in: path
        name: route_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_route_update_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/magic_route_modified_response'
                - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Update Route response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_route_modified_response'
          description: Update Route response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update Route
      tags:
      - Magic Static Routes
      x-cfPermissionsRequired:
        enum:
        - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
components:
  schemas:
    magic_route_update_request:
      allOf:
      - $ref: '#/components/schemas/magic_route_add_single_request'
    magic_colo_region:
      description: Scope colo region.
      example: APAC
      type: string
    magic_route_deleted_response:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-single'
      - properties:
          result:
            properties:
              deleted:
                example: true
                type: boolean
              deleted_route:
                $ref: '#/components/schemas/magic_route'
            type: object
    magic_scope:
      description: Used only for ECMP routes.
      properties:
        colo_names:
          $ref: '#/components/schemas/magic_colo_names'
        colo_regions:
          $ref: '#/components/schemas/magic_colo_regions'
      type: object
    magic_created_on:
      description: When the route was created.
      example: '2017-06-14T00:00:00Z'
      format: date-time
      readOnly: true
      type: string
    magic_route_single_response:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-single'
      - properties:
          result:
            properties:
              route:
                $ref: '#/components/schemas/magic_route'
            type: object
    magic_route_add_single_request:
      properties:
        description:
          $ref: '#/components/schemas/magic_description'
        nexthop:
          $ref: '#/components/schemas/magic_nexthop'
        prefix:
          $ref: '#/components/schemas/magic_prefix'
        priority:
          $ref: '#/components/schemas/magic_priority'
        scope:
          $ref: '#/components/schemas/magic_scope'
        weight:
          $ref: '#/components/schemas/magic_weight'
      required:
      - prefix
      - nexthop
      - priority
      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_routes_collection_response:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-single'
      - properties:
          result:
            properties:
              routes:
                items:
                  $ref: '#/components/schemas/magic_route'
                type: array
    magic_colo_regions:
      description: List of colo regions for the ECMP scope.
      items:
        $ref: '#/components/schemas/magic_colo_region'
      type: array
    magic_route_delete_many_request:
      properties:
        routes:
          items:
            $ref: '#/components/schemas/magic_route_delete_id'
          type: array
      required:
      - routes
      type: object
    magic_colo_names:
      description: List of colo names for the ECMP scope.
      items:
        $ref: '#/components/schemas/magic_colo_name'
      type: array
    magic_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    magic_route_delete_id:
      allOf:
      - properties:
          id:
            $ref: '#/components/schemas/magic_identifier'
        required:
        - id
    magic_nexthop:
      description: The next-hop IP Address for the static route.
      example: 203.0.113.1
      type: string
    magic_route:
      properties:
        created_on:
          $ref: '#/components/schemas/magic_created_on'
        description:
          $ref: '#/components/schemas/magic_description'
        id:
          $ref: '#/components/schemas/magic_identifier'
        modified_on:
          $ref: '#/components/schemas/magic_modified_on'
        nexthop:
          $ref: '#/components/schemas/magic_nexthop'
        prefix:
          $ref: '#/components/schemas/magic_prefix'
        priority:
          $ref: '#/components/schemas/magic_priority'
        scope:
          $ref: '#/components/schemas/magic_scope'
        weight:
          $ref: '#/components/schemas/magic_weight'
      required:
      - prefix
      - nexthop
      - priority
      type: object
    magic_route_update_single_request:
      allOf:
      - properties:
          id:
            $ref: '#/components/schemas/magic_identifier'
        required:
        - id
      - $ref: '#/components/schemas/magic_route_add_single_request'
    magic_description:
      description: An optional human provided description of the static route.
      example: New route for new prefix 203.0.113.1
      type: string
    magic_route_modified_response:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-single'
      - properties:
          result:
            properties:
              modified:
                example: true
                type: boolean
              modified_route:
                $ref: '#/components/schemas/magic_route'
            type: object
    magic_colo_name:
      description: Scope colo name.
      example: den01
      type: string
    magic_route_update_many_request:
      properties:
        routes:
          items:
            $ref: '#/components/schemas/magic_route_update_single_request'
          type: array
      required:
      - routes
      type: object
    magic_multiple_route_modified_response:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-single'
      - properties:
          result:
            properties:
              modified:
                example: true
                type: boolean
              modified_routes:
                items:
                  $ref: '#/components/schemas/magic_route'
                type: array
    magic_weight:
      description: Optional weight of the ECMP scope - if provided.
      type: integer
    magic_prefix:
      description: IP Prefix in Classless Inter-Domain Routing format.
      example: 192.0.2.0/24
      type: string
    magic_multiple_route_delete_response:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-single'
      - properties:
          result:
            properties:
              deleted:
                example: true
                type: boolean
              deleted_routes:
                items:
                  $ref: '#/components/schemas/magic_route'
                type: array
    magic_api-response-single:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-common'
      - properties:
          result:
            anyOf:
            - type:
              - object
              - 'null'
            - type:
              - string
              - 'null'
      type: object
    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_modified_on:
      description: When the route was last modified.
      example: '2017-06-14T05:20:00Z'
      format: date-time
      readOnly: true
      type: string
    magic_priority:
      description: Priority of the static route.
      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