APIs.io Engineering Platform Device DEX Tests 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 DEX Tests API
  version: 4.0.0
tags:
- name: Device DEX Tests
paths:
  /accounts/{account_id}/devices/dex_tests:
    get:
      description: Fetch all DEX tests.
      operationId: device-dex-test-details
      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_dex-single_response'
                - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Device DEX test response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_dex-response_collection'
          description: Device DEX test details response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Device DEX tests
      tags:
      - Device DEX Tests
      x-api-token-group:
      - Cloudflare DEX Write
      - Cloudflare DEX Read
      - Teams Report
      - Teams Read
    post:
      description: Create a DEX test.
      operationId: device-dex-test-create-device-dex-test
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/teams-devices_device-dex-test-schemas-http'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/teams-devices_dex-single_response'
                - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Update Dex test response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_dex-single_response'
          description: Update Dex test response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create Device DEX test
      tags:
      - Device DEX Tests
      x-api-token-group:
      - Cloudflare DEX Write
  /accounts/{account_id}/devices/dex_tests/{dex_test_id}:
    delete:
      description: Delete a Device DEX test. Returns the remaining device dex tests for the account.
      operationId: device-dex-test-delete-device-dex-test
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/teams-devices_identifier'
      - in: path
        name: dex_test_id
        required: true
        schema:
          $ref: '#/components/schemas/teams-devices_uuid'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/teams-devices_dex-response_collection'
                - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Delete DEX test response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_dex-response_collection'
          description: Delete Device DEX test response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete Device DEX test
      tags:
      - Device DEX Tests
      x-api-token-group:
      - Cloudflare DEX Write
    get:
      description: Fetch a single DEX test.
      operationId: device-dex-test-get-device-dex-test
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/teams-devices_identifier'
      - in: path
        name: dex_test_id
        required: true
        schema:
          $ref: '#/components/schemas/teams-devices_uuid'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/teams-devices_dex-single_response'
                - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Device DEX test response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_dex-single_response'
          description: Device DEX test details response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get Device DEX test
      tags:
      - Device DEX Tests
      x-api-token-group:
      - Cloudflare DEX Write
      - Cloudflare DEX Read
      - Teams Report
      - Teams Read
    put:
      description: Update a DEX test.
      operationId: device-dex-test-update-device-dex-test
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/teams-devices_identifier'
      - in: path
        name: dex_test_id
        required: true
        schema:
          $ref: '#/components/schemas/teams-devices_uuid'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/teams-devices_device-dex-test-schemas-http'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/teams-devices_dex-single_response'
                - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Update Dex test response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_dex-single_response'
          description: Update Dex test response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update Device DEX test
      tags:
      - Device DEX Tests
      x-api-token-group:
      - Cloudflare DEX Write
components:
  schemas:
    teams-devices_dex_target_policy:
      properties:
        default:
          description: Whether the profile is the account default
          type: boolean
        id:
          description: The id of the device settings profile
          type: string
        name:
          description: The name of the device settings profile
          type: string
      type: object
    teams-devices_dex-response_collection:
      allOf:
      - $ref: '#/components/schemas/teams-devices_api-response-collection-common'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/teams-devices_device-dex-test-schemas-http'
            type: array
    teams-devices_device-dex-test-schemas-http:
      properties:
        data:
          $ref: '#/components/schemas/teams-devices_device-dex-test-schemas-data'
        description:
          $ref: '#/components/schemas/teams-devices_device-dex-test-schemas-description'
        enabled:
          $ref: '#/components/schemas/teams-devices_device-dex-test-schemas-enabled'
        interval:
          $ref: '#/components/schemas/teams-devices_device-dex-test-schemas-interval'
        name:
          $ref: '#/components/schemas/teams-devices_device-dex-test-schemas-name'
        target_policies:
          $ref: '#/components/schemas/teams-devices_device-dex-test-target-policies'
        targeted:
          type: boolean
      required:
      - name
      - interval
      - enabled
      - data
      type: object
    teams-devices_api-response-collection-common:
      allOf:
      - $ref: '#/components/schemas/teams-devices_api-response-common'
      - properties:
          result:
            items: {}
            type:
            - array
            - 'null'
      type: object
    teams-devices_identifier:
      example: 699d98642c564d2e855e9661899b7252
    teams-devices_dex-single_response:
      allOf:
      - $ref: '#/components/schemas/teams-devices_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/teams-devices_device-dex-test-schemas-http'
    teams-devices_uuid:
      description: API UUID.
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      type: string
    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_device-dex-test-schemas-description:
      description: Additional details about the test.
      example: Checks the dash endpoint every 30 minutes
      type: string
    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_device-dex-test-schemas-data:
      description: The configuration object which contains the details for the WARP client to conduct the test.
      example:
        host: https://dash.cloudflare.com
        kind: http
        method: GET
      properties:
        host:
          description: The desired endpoint to test.
          example: https://dash.cloudflare.com
          type: string
        kind:
          description: The type of test.
          example: http
          type: string
        method:
          description: The HTTP request method type.
          example: GET
          type: string
      type: object
    teams-devices_device-dex-test-target-policies:
      description: Device settings profiles targeted by this test
      items:
        $ref: '#/components/schemas/teams-devices_dex_target_policy'
      type: array
    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_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_device-dex-test-schemas-name:
      description: The name of the DEX test. Must be unique.
      example: HTTP dash health check
      type: string
    teams-devices_device-dex-test-schemas-enabled:
      description: Determines whether or not the test is active.
      example: true
      type: boolean
    teams-devices_device-dex-test-schemas-interval:
      description: How often the test will run.
      example: 30m
      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