APIs.io Engineering Platform Device Managed Networks 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 Device Managed Networks API
  version: 4.0.0
tags:
- name: Device Managed Networks
paths:
  /accounts/{account_id}/devices/networks:
    get:
      description: Fetches a list of managed networks for an account.
      operationId: device-managed-networks-list-device-managed-networks
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/teams-devices_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/teams-devices_components-schemas-response_collection'
                - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: List your device managed networks response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_components-schemas-response_collection'
          description: List your device managed networks response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List your device managed networks
      tags:
      - Device Managed Networks
      x-api-token-group:
      - Teams Read
      - Teams Write
    post:
      description: Creates a new device managed network.
      operationId: device-managed-networks-create-device-managed-network
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                config:
                  $ref: '#/components/schemas/teams-devices_schemas-config_request'
                name:
                  $ref: '#/components/schemas/teams-devices_device-managed-networks_components-schemas-name'
                type:
                  $ref: '#/components/schemas/teams-devices_components-schemas-type'
              required:
              - name
              - type
              - config
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/teams-devices_components-schemas-single_response'
                - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Create a device managed networks response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_components-schemas-single_response'
          description: Create a device managed networks response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create a device managed network
      tags:
      - Device Managed Networks
      x-api-token-group:
      - Teams Write
  /accounts/{account_id}/devices/networks/{network_id}:
    delete:
      description: Deletes a device managed network and fetches a list of the remaining device managed networks for an account.
      operationId: device-managed-networks-delete-device-managed-network
      parameters:
      - in: path
        name: network_id
        required: true
        schema:
          $ref: '#/components/schemas/teams-devices_uuid'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/teams-devices_components-schemas-response_collection'
                - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Delete a device managed network response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_components-schemas-response_collection'
          description: Delete a device managed network response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete a device managed network
      tags:
      - Device Managed Networks
      x-api-token-group:
      - Teams Write
    get:
      description: Fetches details for a single managed network.
      operationId: device-managed-networks-device-managed-network-details
      parameters:
      - in: path
        name: network_id
        required: true
        schema:
          $ref: '#/components/schemas/teams-devices_uuid'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/teams-devices_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/teams-devices_components-schemas-single_response'
                - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Get device managed network details response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_components-schemas-single_response'
          description: Get device managed network details response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get device managed network details
      tags:
      - Device Managed Networks
      x-api-token-group:
      - Teams Read
      - Teams Write
    put:
      description: Updates a configured device managed network.
      operationId: device-managed-networks-update-device-managed-network
      parameters:
      - in: path
        name: network_id
        required: true
        schema:
          $ref: '#/components/schemas/teams-devices_uuid'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                config:
                  $ref: '#/components/schemas/teams-devices_schemas-config_request'
                name:
                  $ref: '#/components/schemas/teams-devices_device-managed-networks_components-schemas-name'
                type:
                  $ref: '#/components/schemas/teams-devices_components-schemas-type'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/teams-devices_components-schemas-single_response'
                - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Update a device managed network response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_components-schemas-single_response'
          description: Update a device managed network response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update a device managed network
      tags:
      - Device Managed Networks
      x-api-token-group:
      - Teams Write
components:
  schemas:
    teams-devices_identifier:
      example: 699d98642c564d2e855e9661899b7252
    teams-devices_device-managed-networks_components-schemas-name:
      description: The name of the device managed network. This name must be unique.
      example: managed-network-1
      type: string
    teams-devices_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/teams-devices_api-response-common'
      - properties:
          result:
            items: {}
            type:
            - array
            - 'null'
          result_info:
            $ref: '#/components/schemas/teams-devices_result_info'
      type: object
    teams-devices_uuid:
      description: API UUID.
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      type: string
    teams-devices_components-schemas-type:
      description: The type of device managed network.
      enum:
      - tls
      example: tls
      type: string
    teams-devices_api-response-single:
      allOf:
      - $ref: '#/components/schemas/teams-devices_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
            - type: string
            type:
            - object
            - 'null'
      type: object
    teams-devices_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    teams-devices_tls_config_request:
      properties:
        sha256:
          description: The SHA-256 hash of the TLS certificate presented by the host found at tls_sockaddr. If absent, regular certificate verification (trusted roots, valid timestamp, etc) will be used to validate the certificate.
          example: b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
          type: string
        tls_sockaddr:
          description: A network address of the form "host:port" that the WARP client will use to detect the presence of a TLS host.
          example: foobar:1234
          type: string
      required:
      - tls_sockaddr
      type: object
    teams-devices_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    teams-devices_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/teams-devices_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/teams-devices_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
    teams-devices_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/teams-devices_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/teams-devices_device-managed-networks'
            type: array
    teams-devices_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/teams-devices_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/teams-devices_device-managed-networks'
    teams-devices_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/teams-devices_messages'
        messages:
          $ref: '#/components/schemas/teams-devices_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
    teams-devices_schemas-config_request:
      description: The configuration object containing information for the WARP client to detect the managed network.
      example:
        sha256: b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
        tls_sockaddr: foo.bar:1234
      oneOf:
      - $ref: '#/components/schemas/teams-devices_tls_config_request'
      type: object
    teams-devices_device-managed-networks:
      properties:
        config:
          $ref: '#/components/schemas/teams-devices_schemas-config_response'
        name:
          $ref: '#/components/schemas/teams-devices_device-managed-networks_components-schemas-name'
        network_id:
          $ref: '#/components/schemas/teams-devices_uuid'
        type:
          $ref: '#/components/schemas/teams-devices_components-schemas-type'
      type: object
    teams-devices_schemas-config_response:
      description: The configuration object containing information for the WARP client to detect the managed network.
      example:
        sha256: b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
        tls_sockaddr: foo.bar:1234
      oneOf:
      - $ref: '#/components/schemas/teams-devices_tls_config_response'
      type: object
    teams-devices_tls_config_response:
      description: The Managed Network TLS Config Response.
      properties:
        sha256:
          description: The SHA-256 hash of the TLS certificate presented by the host found at tls_sockaddr. If absent, regular certificate verification (trusted roots, valid timestamp, etc) will be used to validate the certificate.
          example: b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
          type: string
        tls_sockaddr:
          description: A network address of the form "host:port" that the WARP client will use to detect the presence of a TLS host.
          example: foobar:1234
          type: string
      required:
      - tls_sockaddr
      type: object
  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