APIs.io Engineering Platform Magic Account Apps 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 Account Apps API
  version: 4.0.0
tags:
- name: Magic Account Apps
paths:
  /accounts/{account_id}/magic/apps:
    get:
      description: Lists Apps associated with an account.
      operationId: magic-account-apps-list-apps
      parameters:
      - 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: List Apps response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_apps_collection_response'
          description: List Apps response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Apps
      tags:
      - Magic Account Apps
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    post:
      description: Creates a new App for an account
      operationId: magic-account-apps-add-app
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_app_add_single_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Create Account App response failure
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_app_single_response'
          description: Create Account App response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create a new App
      tags:
      - Magic Account Apps
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/apps/{account_app_id}:
    delete:
      description: Deletes specific Account App.
      operationId: magic-account-apps-delete-app
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      - in: path
        name: account_app_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Delete App response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_app_single_response'
          description: Delete App response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete Account App
      tags:
      - Magic Account Apps
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      description: Updates an Account App
      operationId: magic-account-apps-update-app
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      - in: path
        name: account_app_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_app_update_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Update App response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_app_single_response'
          description: Update App response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update an App
      tags:
      - Magic Account Apps
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
components:
  schemas:
    magic_app_update_request:
      anyOf:
      - required:
        - name
        title: Update App Name
      - required:
        - type
        title: Update App Type
      - required:
        - hostnames
        title: Update App Hostnames
      - required:
        - ip_subnets
        title: Update App Subnets
      properties:
        hostnames:
          $ref: '#/components/schemas/magic_app_hostnames'
        ip_subnets:
          $ref: '#/components/schemas/magic_app_subnets'
        name:
          $ref: '#/components/schemas/magic_app_name'
        type:
          $ref: '#/components/schemas/magic_app_type'
      type: object
    magic_app_single_response:
      allOf:
      - $ref: '#/components/schemas/magic_apps-response-object'
      - properties:
          result:
            $ref: '#/components/schemas/magic_account_app'
    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_apps-response-object:
      properties:
        errors:
          $ref: '#/components/schemas/magic_messages'
        messages:
          $ref: '#/components/schemas/magic_messages'
        result:
          type:
          - object
          - 'null'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    magic_account_app:
      description: Custom app defined for an account.
      properties:
        account_app_id:
          $ref: '#/components/schemas/magic_account_app_id'
        hostnames:
          $ref: '#/components/schemas/magic_app_hostnames'
        ip_subnets:
          $ref: '#/components/schemas/magic_app_subnets'
        name:
          $ref: '#/components/schemas/magic_app_name'
        type:
          $ref: '#/components/schemas/magic_app_type'
      required:
      - account_app_id
      title: Account App
      type: object
    magic_managed_app:
      description: Managed app defined by Cloudflare.
      properties:
        hostnames:
          $ref: '#/components/schemas/magic_app_hostnames'
        ip_subnets:
          $ref: '#/components/schemas/magic_app_subnets'
        managed_app_id:
          $ref: '#/components/schemas/magic_managed_app_id'
        name:
          $ref: '#/components/schemas/magic_app_name'
        type:
          $ref: '#/components/schemas/magic_app_type'
      required:
      - managed_app_id
      title: Managed App
      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_app_hostnames:
      description: FQDNs to associate with traffic decisions.
      items:
        example: auth.cloudflare.com
        type: string
      type: array
    magic_account_app_id:
      description: Magic account app ID.
      example: ac60d3d0435248289d446cedd870bcf4
      type: string
    magic_managed_app_id:
      description: Managed app ID.
      example: cloudflare
      type: string
    magic_app_add_single_request:
      anyOf:
      - required:
        - hostnames
        title: Hostnames
      - required:
        - ip_subnets
        title: Subnets
      properties:
        hostnames:
          $ref: '#/components/schemas/magic_app_hostnames'
        ip_subnets:
          $ref: '#/components/schemas/magic_app_subnets'
        name:
          $ref: '#/components/schemas/magic_app_name'
        type:
          $ref: '#/components/schemas/magic_app_type'
      required:
      - name
      - type
      type: object
    magic_app_type:
      description: Category of the app.
      example: Development
      type: string
    magic_app_name:
      description: Display name for the app.
      example: Cloudflare Dashboard
      type: string
    magic_app_subnets:
      description: CIDRs to associate with traffic decisions.
      items:
        allOf:
        - $ref: '#/components/schemas/magic_cidr'
        - example: 1.1.1.1/32
      type: array
    magic_cidr:
      description: A valid CIDR notation representing an IP range.
      example: 192.0.2.0/24
      type: string
    magic_apps-response-array:
      properties:
        errors:
          $ref: '#/components/schemas/magic_messages'
        messages:
          $ref: '#/components/schemas/magic_messages'
        result:
          items: {}
          type:
          - array
          - 'null'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    magic_app:
      description: Collection of Hostnames and/or IP Subnets to associate with traffic decisions.
      oneOf:
      - $ref: '#/components/schemas/magic_account_app'
      - $ref: '#/components/schemas/magic_managed_app'
      type: object
    magic_apps_collection_response:
      allOf:
      - $ref: '#/components/schemas/magic_apps-response-array'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/magic_app'
            type: array
    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