APIs.io Engineering Platform Magic Site LANs 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 Site LANs API
  version: 4.0.0
tags:
- name: Magic Site LANs
paths:
  /accounts/{account_id}/magic/sites/{site_id}/lans:
    get:
      description: Lists Site LANs associated with an account.
      operationId: magic-site-lans-list-lans
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      - in: path
        name: site_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: List Site LANs response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_lans_collection_response'
          description: List Site LANs response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Site LANs
      tags:
      - Magic Site LANs
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    post:
      description: Creates a new Site LAN. If the site is in high availability mode, static_addressing is required along with secondary and virtual address.
      operationId: magic-site-lans-create-lan
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      - in: path
        name: site_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_lans_add_single_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Create Site LAN response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_lans_collection_response'
          description: Create Site LAN response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create a new Site LAN
      tags:
      - Magic Site LANs
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/sites/{site_id}/lans/{lan_id}:
    delete:
      description: Remove a specific Site LAN.
      operationId: magic-site-lans-delete-lan
      parameters:
      - in: path
        name: site_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      - in: path
        name: lan_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Delete Site LAN response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_lan_deleted_response'
          description: Delete Site LAN response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete Site LAN
      tags:
      - Magic Site LANs
      x-cfPermissionsRequired:
        enum:
        - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    get:
      description: Get a specific Site LAN.
      operationId: magic-site-lans-lan-details
      parameters:
      - in: path
        name: site_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      - in: path
        name: lan_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Site LAN Details response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_lan_single_response'
          description: Site LAN Details response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Site LAN Details
      tags:
      - Magic Site LANs
      x-cfPermissionsRequired:
        enum:
        - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    patch:
      description: Patch a specific Site LAN.
      operationId: magic-site-lans-patch-lan
      parameters:
      - in: path
        name: site_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      - in: path
        name: lan_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_lan_update_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Patch Site LAN response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_lan_modified_response'
          description: Patch Site LAN response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Patch Site LAN
      tags:
      - Magic Site LANs
      x-cfPermissionsRequired:
        enum:
        - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      description: Update a specific Site LAN.
      operationId: magic-site-lans-update-lan
      parameters:
      - in: path
        name: site_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      - in: path
        name: lan_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_lan_update_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Update Site LAN response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_lan_modified_response'
          description: Update Site LAN response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update Site LAN
      tags:
      - Magic Site LANs
      x-cfPermissionsRequired:
        enum:
        - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
components:
  schemas:
    magic_lan_dhcp_relay:
      properties:
        server_addresses:
          description: List of DHCP server IPs.
          items:
            $ref: '#/components/schemas/magic_ip-address'
          type: array
      type: object
    magic_lan_deleted_response:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/magic_lan'
    magic_lans_collection_response:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-single'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/magic_lan'
            type: array
    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_port:
      example: 1
      type: integer
    magic_lan:
      properties:
        ha_link:
          description: mark true to use this LAN for HA probing. only works for site with HA turned on. only one LAN can be set as the ha_link.
          type: boolean
        id:
          $ref: '#/components/schemas/magic_identifier'
        name:
          type: string
        nat:
          $ref: '#/components/schemas/magic_nat'
        physport:
          $ref: '#/components/schemas/magic_port'
        routed_subnets:
          items:
            $ref: '#/components/schemas/magic_routed_subnet'
          type: array
        site_id:
          $ref: '#/components/schemas/magic_identifier'
        static_addressing:
          $ref: '#/components/schemas/magic_lan_static_addressing'
        vlan_tag:
          $ref: '#/components/schemas/magic_vlan_tag'
      type: object
    magic_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    magic_ip-address:
      description: A valid IPv4 address.
      example: 192.0.2.1
      type: string
    magic_lan_static_addressing:
      description: If the site is not configured in high availability mode, this configuration is optional (if omitted, use DHCP). However, if in high availability mode, static_address is required along with secondary and virtual address.
      properties:
        address:
          $ref: '#/components/schemas/magic_cidr'
        dhcp_relay:
          $ref: '#/components/schemas/magic_lan_dhcp_relay'
        dhcp_server:
          $ref: '#/components/schemas/magic_lan_dhcp_server'
        secondary_address:
          $ref: '#/components/schemas/magic_cidr'
        virtual_address:
          $ref: '#/components/schemas/magic_cidr'
      required:
      - address
      type: object
    magic_vlan_tag:
      description: VLAN port number.
      example: 0
      type: integer
    magic_lan_update_request:
      properties:
        name:
          type: string
        nat:
          $ref: '#/components/schemas/magic_nat'
        physport:
          $ref: '#/components/schemas/magic_port'
        routed_subnets:
          items:
            $ref: '#/components/schemas/magic_routed_subnet'
          type: array
        static_addressing:
          $ref: '#/components/schemas/magic_lan_static_addressing'
        vlan_tag:
          $ref: '#/components/schemas/magic_vlan_tag'
      type: object
    magic_routed_subnet:
      properties:
        nat:
          $ref: '#/components/schemas/magic_nat'
        next_hop:
          $ref: '#/components/schemas/magic_ip-address'
        prefix:
          $ref: '#/components/schemas/magic_cidr'
      required:
      - prefix
      - next_hop
      type: object
    magic_lans_add_single_request:
      properties:
        ha_link:
          description: mark true to use this LAN for HA probing. only works for site with HA turned on. only one LAN can be set as the ha_link.
          type: boolean
        name:
          type: string
        nat:
          $ref: '#/components/schemas/magic_nat'
        physport:
          $ref: '#/components/schemas/magic_port'
        routed_subnets:
          items:
            $ref: '#/components/schemas/magic_routed_subnet'
          type: array
        static_addressing:
          $ref: '#/components/schemas/magic_lan_static_addressing'
        vlan_tag:
          $ref: '#/components/schemas/magic_vlan_tag'
      required:
      - physport
      - vlan_tag
      type: object
    magic_cidr:
      description: A valid CIDR notation representing an IP range.
      example: 192.0.2.0/24
      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_lan_modified_response:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/magic_lan'
    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_lan_dhcp_server:
      properties:
        dhcp_pool_end:
          $ref: '#/components/schemas/magic_ip-address'
        dhcp_pool_start:
          $ref: '#/components/schemas/magic_ip-address'
        dns_server:
          $ref: '#/components/schemas/magic_ip-address'
        reservations:
          additionalProperties:
            description: IP address associated with the MAC address
            type: string
          description: Mapping of MAC addresses to IP addresses
          example:
            00:11:22:33:44:55: 192.0.2.100
            AA:BB:CC:DD:EE:FF: 192.168.1.101
          type: object
      type: object
    magic_lan_single_response:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/magic_lan'
    magic_nat:
      properties:
        static_prefix:
          $ref: '#/components/schemas/magic_cidr'
      type: object
    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