APIs.io Engineering Platform Magic Sites 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 Sites API
  version: 4.0.0
tags:
- name: Magic Sites
paths:
  /accounts/{account_id}/magic/sites:
    get:
      description: Lists Sites associated with an account. Use connector_identifier query param to return sites where connector_identifier matches either site.ConnectorID or site.SecondaryConnectorID.
      operationId: magic-sites-list-sites
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      - in: query
        name: connector_identifier
        schema:
          $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: List Sites response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_sites_collection_response'
          description: List Sites response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Sites
      tags:
      - Magic Sites
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    post:
      description: Creates a new Site
      operationId: magic-sites-create-site
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_sites_add_single_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Create Site response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_site_single_response'
          description: Create Site response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create a new Site
      tags:
      - Magic Sites
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/sites/{site_id}:
    delete:
      description: Remove a specific Site.
      operationId: magic-sites-delete-site
      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'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Delete Site response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_site_deleted_response'
          description: Delete Site response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete Site
      tags:
      - Magic Sites
      x-cfPermissionsRequired:
        enum:
        - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    get:
      description: Get a specific Site.
      operationId: magic-sites-site-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'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Site Details response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_site_single_response'
          description: Site Details response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Site Details
      tags:
      - Magic Sites
      x-cfPermissionsRequired:
        enum:
        - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    patch:
      description: Patch a specific Site.
      operationId: magic-sites-patch-site
      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'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_site_update_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Patch Site response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_site_modified_response'
          description: Patch Site response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Patch Site
      tags:
      - Magic Sites
      x-cfPermissionsRequired:
        enum:
        - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      description: Update a specific Site.
      operationId: magic-sites-update-site
      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'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_site_update_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Update Site response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_site_modified_response'
          description: Update Site response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update Site
      tags:
      - Magic Sites
      x-cfPermissionsRequired:
        enum:
        - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
components:
  schemas:
    magic_connector-id:
      description: Magic Connector identifier tag.
      example: ac60d3d0435248289d446cedd870bcf4
      type: string
    magic_sites_add_single_request:
      properties:
        connector_id:
          $ref: '#/components/schemas/magic_connector-id'
        description:
          type: string
        ha_mode:
          description: Site high availability mode. If set to true, the site can have two connectors and runs in high availability mode.
          example: true
          type: boolean
        location:
          $ref: '#/components/schemas/magic_site-location'
        name:
          $ref: '#/components/schemas/magic_site-name'
        secondary_connector_id:
          $ref: '#/components/schemas/magic_secondary-connector-id'
      required:
      - name
      type: object
    magic_site_single_response:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/magic_site'
    magic_site_update_request:
      properties:
        connector_id:
          $ref: '#/components/schemas/magic_connector-id'
        description:
          type: string
        location:
          $ref: '#/components/schemas/magic_site-location'
        name:
          $ref: '#/components/schemas/magic_site-name'
        secondary_connector_id:
          $ref: '#/components/schemas/magic_secondary-connector-id'
      type: object
    magic_api-response-single:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-common'
      - properties:
          result:
            anyOf:
            - type:
              - object
              - 'null'
            - type:
              - string
              - 'null'
      type: object
    magic_site-name:
      description: The name of the site.
      example: site_1
      type: string
    magic_site-location:
      description: Location of site in latitude and longitude.
      properties:
        lat:
          description: Latitude
          example: 37.6192
          type: string
        lon:
          description: Longitude
          example: 122.3816
          type: string
      type: object
    magic_secondary-connector-id:
      description: Magic Connector identifier tag. Used when high availability mode is on.
      example: 8d67040d3835dbcf46ce29da440dc482
      type: string
    magic_site_modified_response:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/magic_site'
    magic_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    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_site_deleted_response:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/magic_site'
    magic_site:
      properties:
        connector_id:
          $ref: '#/components/schemas/magic_connector-id'
        description:
          type: string
        ha_mode:
          description: Site high availability mode. If set to true, the site can have two connectors and runs in high availability mode.
          example: true
          type: boolean
        id:
          $ref: '#/components/schemas/magic_identifier'
        location:
          $ref: '#/components/schemas/magic_site-location'
        name:
          $ref: '#/components/schemas/magic_site-name'
        secondary_connector_id:
          $ref: '#/components/schemas/magic_secondary-connector-id'
      type: object
    magic_sites_collection_response:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-single'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/magic_site'
            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_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