APIs.io Engineering Platform Magic Network Monitoring Configuration 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 Network Monitoring Configuration API
  version: 4.0.0
tags:
- name: Magic Network Monitoring Configuration
paths:
  /accounts/{account_id}/mnm/config:
    delete:
      description: Delete an existing network monitoring configuration.
      operationId: magic-network-monitoring-configuration-delete-account-configuration
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic-visibility_account_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
                - $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
          description: Delete account configuration response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
          description: Delete account configuration response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete account configuration
      tags:
      - Magic Network Monitoring Configuration
      x-api-token-group:
      - Magic Network Monitoring Admin
    get:
      description: Lists default sampling, router IPs and warp devices for account.
      operationId: magic-network-monitoring-configuration-list-account-configuration
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic-visibility_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
                - $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
          description: List account configuration response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
          description: List account configuration response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List account configuration
      tags:
      - Magic Network Monitoring Configuration
      x-api-token-group:
      - Magic Network Monitoring Admin
      - Magic Network Monitoring Config Write
      - Magic Network Monitoring Config Read
    patch:
      description: Update fields in an existing network monitoring configuration.
      operationId: magic-network-monitoring-configuration-update-account-configuration-fields
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic-visibility_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                default_sampling:
                  $ref: '#/components/schemas/magic-visibility_mnm_config_default_sampling'
                name:
                  $ref: '#/components/schemas/magic-visibility_mnm_config_name'
                router_ips:
                  $ref: '#/components/schemas/magic-visibility_mnm_config_router_ips'
                warp_devices:
                  $ref: '#/components/schemas/magic-visibility_mnm_config_warp_devices'
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
                - $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
          description: Update account configuration fields response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
          description: Update account configuration fields response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update account configuration fields
      tags:
      - Magic Network Monitoring Configuration
      x-api-token-group:
      - Magic Network Monitoring Admin
      - Magic Network Monitoring Config Write
    post:
      description: Create a new network monitoring configuration.
      operationId: magic-network-monitoring-configuration-create-account-configuration
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic-visibility_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                default_sampling:
                  $ref: '#/components/schemas/magic-visibility_mnm_config_default_sampling'
                name:
                  $ref: '#/components/schemas/magic-visibility_mnm_config_name'
                router_ips:
                  $ref: '#/components/schemas/magic-visibility_mnm_config_router_ips'
                warp_devices:
                  $ref: '#/components/schemas/magic-visibility_mnm_config_warp_devices'
              required:
              - name
              - default_sampling
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
                - $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
          description: Create account configuration response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
          description: Create account configuration response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create account configuration
      tags:
      - Magic Network Monitoring Configuration
      x-api-token-group:
      - Magic Network Monitoring Admin
    put:
      description: Update an existing network monitoring configuration, requires the entire configuration to be updated at once.
      operationId: magic-network-monitoring-configuration-update-an-entire-account-configuration
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic-visibility_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                default_sampling:
                  $ref: '#/components/schemas/magic-visibility_mnm_config_default_sampling'
                name:
                  $ref: '#/components/schemas/magic-visibility_mnm_config_name'
                router_ips:
                  $ref: '#/components/schemas/magic-visibility_mnm_config_router_ips'
                warp_devices:
                  $ref: '#/components/schemas/magic-visibility_mnm_config_warp_devices'
              required:
              - name
              - default_sampling
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
                - $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
          description: Update an entire account configuration response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
          description: Update an entire account configuration response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update an entire account configuration
      tags:
      - Magic Network Monitoring Configuration
      x-api-token-group:
      - Magic Network Monitoring Admin
      - Magic Network Monitoring Config Write
  /accounts/{account_id}/mnm/config/full:
    get:
      description: Lists default sampling, router IPs, warp devices, and rules for account.
      operationId: magic-network-monitoring-configuration-list-rules-and-account-configuration
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic-visibility_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
                - $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
          description: List rules and account configuration response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
          description: List rules and account configuration response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List rules and account configuration
      tags:
      - Magic Network Monitoring Configuration
      x-api-token-group:
      - Magic Network Monitoring Admin
      - Magic Network Monitoring Config Write
      - Magic Network Monitoring Config Read
components:
  schemas:
    magic-visibility_mnm_config_warp_device:
      description: Object representing a warp device with an ID and name.
      properties:
        id:
          description: Unique identifier for the warp device.
          example: 5360368d-b351-4791-abe1-93550dabd351
          type: string
        name:
          description: Name of the warp device.
          example: My warp device
          type: string
        router_ip:
          description: IPv4 CIDR of the router sourcing flow data associated with this warp device. Only /32 addresses are currently supported.
          example: 203.0.113.1
          type: string
      required:
      - id
      - name
      - router_ip
      type: object
    magic-visibility_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/magic-visibility_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/magic-visibility_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-visibility_api-response-single:
      allOf:
      - $ref: '#/components/schemas/magic-visibility_api-response-common'
      - properties:
          result:
            anyOf:
            - type:
              - object
              - 'null'
            - type:
              - string
              - 'null'
      type: object
    magic-visibility_account_identifier:
      example: 6f91088a406011ed95aed352566e8d4c
      type: string
    magic-visibility_mnm_config_router_ips:
      items:
        $ref: '#/components/schemas/magic-visibility_mnm_config_router_ip'
      type: array
    magic-visibility_mnm_config_default_sampling:
      default: 1
      description: Fallback sampling rate of flow messages being sent in packets per second. This should match the packet sampling rate configured on the router.
      minimum: 1
      type: number
    magic-visibility_mnm_config_single_response:
      allOf:
      - $ref: '#/components/schemas/magic-visibility_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/magic-visibility_mnm_config'
        type: object
    magic-visibility_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/magic-visibility_messages'
        messages:
          $ref: '#/components/schemas/magic-visibility_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-visibility_mnm_config_router_ip:
      description: IPv4 CIDR of the router sourcing flow data. Only /32 addresses are currently supported.
      example: 203.0.113.1
      type: string
    magic-visibility_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    magic-visibility_mnm_config_warp_devices:
      items:
        $ref: '#/components/schemas/magic-visibility_mnm_config_warp_device'
      type: array
    magic-visibility_mnm_config:
      properties:
        default_sampling:
          $ref: '#/components/schemas/magic-visibility_mnm_config_default_sampling'
        name:
          $ref: '#/components/schemas/magic-visibility_mnm_config_name'
        router_ips:
          $ref: '#/components/schemas/magic-visibility_mnm_config_router_ips'
        warp_devices:
          $ref: '#/components/schemas/magic-visibility_mnm_config_warp_devices'
      required:
      - name
      - default_sampling
      - router_ips
      - warp_devices
      type: object
    magic-visibility_mnm_config_name:
      description: The account name.
      example: cloudflare user's account
      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