ThousandEyes Endpoint Tests API

openapi: 3.0.1
security:
- BearerAuth: []
servers:
- description: ThousandEyes API production URL
  url: https://api.thousandeyes.com/v7
info:
  title: Endpoint Tests API
  version: 7.0.100
  description: 'Manage endpoint agent dynamic and scheduled tests using the Endpoint Tests API.

    '
  x-provenance:
    method: harvested
    authored_by: Cisco ThousandEyes
    harvested_by: API Evangelist
    harvested_on: '2026-08-19'
    first_party: true
    provider_published: true
    source_host: pubhub.devnetcloud.com
    note: 27 OpenAPI 3.0 documents (26 per-area plus a unified 326-operation document) served anonymously from Cisco's DevNet
      CDN. api.thousandeyes.com itself 401s every path, so the contract is public while the API host is gated.
  x-evidence:
  - type: source
    url: https://pubhub.devnetcloud.com/media/000-v7-apis/docs/reference/
  - type: source
    url: https://developer.cisco.com/docs/thousandeyes/
externalDocs:
  description: Find out more about Endpoint Agent Scheduled Tests
  url: https://docs.thousandeyes.com/product-documentation/end-user-monitoring/scheduled-tests
tags:
- name: Endpoint Scheduled Tests
- name: Agent to Server Endpoint Scheduled Tests
- name: HTTP Server Endpoint Scheduled Tests
- name: Agent To Server Endpoint Dynamic Tests
- name: Endpoint Real User Tests
paths:
  /endpoint/tests/scheduled-tests:
    get:
      tags:
      - Endpoint Scheduled Tests
      summary: List endpoint scheduled tests
      operationId: getEndpointScheduledTests
      description: 'Returns a list of all endpoint scheduled tests configured in ThousandEyes. This list does not contain
        saved events.


        **Note**: **Saved Events** are now called **Private Snapshots** in the user interface. This change does not affect
        API.

        '
      parameters:
      - $ref: '#/components/parameters/AccountGroupId'
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/EndpointTests'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        default:
          $ref: '#/components/responses/GeneralError'
  /endpoint/tests/real-user-tests:
    get:
      tags:
      - Endpoint Real User Tests
      summary: List endpoint real user tests
      operationId: getEndpointRealUserTests
      description: Returns real user test domain monitoring profiles for endpoint agents.
      parameters:
      - $ref: '#/components/parameters/AccountGroupId'
      responses:
        '200':
          description: Real user test domain monitoring profiles.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointRealUserTestsResponse'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/GeneralError'
  /endpoint/tests/scheduled-tests/agent-to-server:
    get:
      tags:
      - Agent to Server Endpoint Scheduled Tests
      summary: List agent to server endpoint scheduled tests
      operationId: getAgentToServerEndpointScheduledTests
      description: 'Returns a list of all agent to server endpoint scheduled tests configured in ThousandEyes. This list does
        not contain saved events.


        **Note**: **Saved Events** are now called **Private Snapshots** in the user interface. This change does not affect
        API.

        '
      parameters:
      - $ref: '#/components/parameters/AccountGroupId'
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/EndpointAgentToServerTests'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        default:
          $ref: '#/components/responses/GeneralError'
    post:
      tags:
      - Agent to Server Endpoint Scheduled Tests
      summary: Creates agent to server endpoint scheduled test
      operationId: createAgentToServerEndpointScheduledTest
      description: 'Creates a new endpoint test in ThousandEyes using properties specified in the POST data.

        Please note that only Account Admins have the authorization to create new tests; regular users are restricted from
        using POST-based methods.

        '
      parameters:
      - $ref: '#/components/parameters/AccountGroupId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EndpointAgentToServerTestRequest'
      responses:
        '201':
          description: Created
          headers:
            Location:
              $ref: '#/components/headers/Location'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/EndpointAgentToServerTest'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        default:
          $ref: '#/components/responses/GeneralError'
  /endpoint/tests/scheduled-tests/agent-to-server/{testId}:
    get:
      tags:
      - Agent to Server Endpoint Scheduled Tests
      summary: Retrieve agent to server endpoint scheduled test
      operationId: getAgentToServerEndpointScheduledTest
      description: Retrieves details of an agent to server endpoint scheduled test.
      parameters:
      - $ref: '#/components/parameters/TestId'
      - $ref: '#/components/parameters/AccountGroupId'
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/EndpointAgentToServerTest'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        default:
          $ref: '#/components/responses/GeneralError'
    patch:
      tags:
      - Agent to Server Endpoint Scheduled Tests
      summary: Update agent to server endpoint scheduled test
      operationId: updateAgentToServerEndpointScheduledTest
      description: "Updates an agent to server scheduled test. Includes support for \nenabling and disabling the test."
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EndpointNetworkTestUpdate'
      parameters:
      - $ref: '#/components/parameters/TestId'
      - $ref: '#/components/parameters/AccountGroupId'
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/EndpointAgentToServerTest'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        default:
          $ref: '#/components/responses/GeneralError'
    delete:
      tags:
      - Agent to Server Endpoint Scheduled Tests
      summary: Delete agent to server scheduled test
      operationId: deleteAgentToServerEndpointScheduledTest
      description: Deletes an agent to server endpoint scheduled test.
      parameters:
      - $ref: '#/components/parameters/TestId'
      - $ref: '#/components/parameters/AccountGroupId'
      responses:
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        default:
          $ref: '#/components/responses/GeneralError'
  /endpoint/tests/scheduled-tests/http-server:
    get:
      tags:
      - HTTP Server Endpoint Scheduled Tests
      summary: List HTTP server endpoint scheduled tests
      operationId: getHttpServerEndpointScheduledTests
      description: 'Returns a list of agent to server endpoint scheduled tests configured in ThousandEyes. This list does
        not contain saved events.


        **Note**: **Saved Events** are now called **Private Snapshots** in the user interface. This change does not affect
        API.

        '
      parameters:
      - $ref: '#/components/parameters/AccountGroupId'
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/EndpointHttpServerTests'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        default:
          $ref: '#/components/responses/GeneralError'
    post:
      tags:
      - HTTP Server Endpoint Scheduled Tests
      summary: Create HTTP server endpoint scheduled test
      operationId: createHttpServerEndpointScheduledTest
      description: 'Creates a new HTTP server endpoint test in ThousandEyes, using properties specified in the POST data.

        Please note that only users with Account Admin privileges have the authorization to create new tests; regular users
        are restricted from using POST-based methods.

        '
      parameters:
      - $ref: '#/components/parameters/AccountGroupId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EndpointHttpServerTestRequest'
      responses:
        '201':
          description: Created
          headers:
            Location:
              $ref: '#/components/headers/Location'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/EndpointHttpServerTest'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        default:
          $ref: '#/components/responses/GeneralError'
  /endpoint/tests/scheduled-tests/http-server/{testId}:
    get:
      tags:
      - HTTP Server Endpoint Scheduled Tests
      summary: Retrieves HTTP server endpoint scheduled test
      operationId: getHttpServerEndpointScheduledTest
      description: Retrieves details of an HTTP Server endpoint scheduled test.
      parameters:
      - $ref: '#/components/parameters/TestId'
      - $ref: '#/components/parameters/AccountGroupId'
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/EndpointHttpServerTest'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        default:
          $ref: '#/components/responses/GeneralError'
    patch:
      tags:
      - HTTP Server Endpoint Scheduled Tests
      summary: Update HTTP server endpoint scheduled test
      operationId: updateHttpServerEndpointScheduledTest
      description: "Updates an HTTP server scheduled test. Includes support for \nenabling and disabling the test."
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EndpointHttpTestUpdate'
      parameters:
      - $ref: '#/components/parameters/TestId'
      - $ref: '#/components/parameters/AccountGroupId'
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/EndpointHttpServerTest'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        default:
          $ref: '#/components/responses/GeneralError'
    delete:
      tags:
      - HTTP Server Endpoint Scheduled Tests
      summary: Delete HTTP server scheduled test
      operationId: deleteHttpServerEndpointScheduledTest
      description: Deletes an HTTP server endpoint scheduled test.
      parameters:
      - $ref: '#/components/parameters/TestId'
      - $ref: '#/components/parameters/AccountGroupId'
      responses:
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        default:
          $ref: '#/components/responses/GeneralError'
  /endpoint/tests/dynamic-tests/agent-to-server:
    get:
      tags:
      - Agent To Server Endpoint Dynamic Tests
      summary: List endpoint dynamic tests
      operationId: getAgentToServerEndpointDynamicTests
      description: 'Returns a list of all endpoint dynamic tests configured in ThousandEyes. This list does not contain saved
        events.


        **Note**: **Saved Events** are now called **Private Snapshots** in the user interface. This change does not affect
        API.

        '
      parameters:
      - $ref: '#/components/parameters/AccountGroupId'
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/DynamicTests'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        default:
          $ref: '#/components/responses/GeneralError'
    post:
      tags:
      - Agent To Server Endpoint Dynamic Tests
      summary: Create endpoint dynamic test
      operationId: createAgentToServerEndpointDynamicTest
      description: 'Create a new endpoint dynamic test in ThousandEyes using properties specified in the POST data.

        Please note that only Account Admins have the authorization to create new tests; regular users are restricted from
        using POST-based methods.

        '
      parameters:
      - $ref: '#/components/parameters/AccountGroupId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DynamicTestRequest'
      responses:
        '201':
          description: Created
          headers:
            Location:
              $ref: '#/components/headers/Location'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/DynamicTest'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        default:
          $ref: '#/components/responses/GeneralError'
  /endpoint/tests/dynamic-tests/agent-to-server/{testId}:
    get:
      tags:
      - Agent To Server Endpoint Dynamic Tests
      summary: Retrieve endpoint dynamic test
      operationId: getAgentToServerEndpointDynamicTest
      description: Returns details of an endpoint dynamic test, including test type, name, intervals, targets.
      parameters:
      - $ref: '#/components/parameters/TestId'
      - $ref: '#/components/parameters/AccountGroupId'
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/DynamicTest'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        default:
          $ref: '#/components/responses/GeneralError'
    patch:
      tags:
      - Agent To Server Endpoint Dynamic Tests
      summary: Update agent to server dynamic test
      operationId: updateAgentToServerEndpointDynamicTest
      description: "Updates an agent to server endpoint dynamic test. Includes support for \nenabling and disabling the test."
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EndpointDynamicTestUpdate'
      parameters:
      - $ref: '#/components/parameters/TestId'
      - $ref: '#/components/parameters/AccountGroupId'
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/DynamicTest'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        default:
          $ref: '#/components/responses/GeneralError'
    delete:
      tags:
      - Agent To Server Endpoint Dynamic Tests
      summary: Delete agent to server dynamic test
      operationId: deleteAgentToServerEndpointDynamicTest
      description: Deletes an agent to server endpoint dynamic test.
      parameters:
      - $ref: '#/components/parameters/TestId'
      - $ref: '#/components/parameters/AccountGroupId'
      responses:
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        default:
          $ref: '#/components/responses/GeneralError'
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Bearer authentication token
  parameters:
    TestId:
      name: testId
      in: path
      description: Unique ID of endpoint test.
      example: '584739201'
      required: true
      schema:
        type: string
    AccountGroupId:
      name: aid
      in: query
      description: A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the
        `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter
        without being assigned to the target account group will result in an error response.
      required: false
      schema:
        type: string
        example: '1234'
  schemas:
    EndpointRealUserTestsResponse:
      type: object
      required:
      - realUserTests
      properties:
        realUserTests:
          type: array
          description: Real user test domain monitoring profiles.
          items:
            $ref: '#/components/schemas/EndpointRealUserTest'
    EndpointRealUserTest:
      type: object
      required:
      - profileId
      - aid
      - name
      - includedDomains
      - excludedDomains
      - monitoringSettings
      properties:
        profileId:
          type: string
          description: Unique ID of the monitoring profile.
          example: '73421'
          readOnly: true
        aid:
          $ref: '#/components/schemas/AccountGroupId'
        name:
          type: string
          description: Monitoring profile name.
          example: Corporate domains
          readOnly: true
        includedDomains:
          type: array
          description: Domains included in real user monitoring.
          items:
            type: string
            example: example.com
            readOnly: true
        excludedDomains:
          type: array
          description: Domains excluded from real user monitoring.
          items:
            type: string
            example: static.example.com
            readOnly: true
        monitoringSettings:
          $ref: '#/components/schemas/EndpointMonitoringSettings'
    EndpointMonitoringSettings:
      type: object
      required:
      - monitoringSettingsType
      example:
        monitoringSettingsId: 1f5c1b5d-8a0d-4d6b-a3be-56b060f7f2c9
        monitoringSettingsType: agent-tags
        tagIds:
        - 49d9e7d2-7df5-43df-9b37-aa596b929062
        labelIds:
        - '567'
      properties:
        monitoringSettingsId:
          type: string
          nullable: true
          description: Unique ID of the monitoring settings.
          example: 1f5c1b5d-8a0d-4d6b-a3be-56b060f7f2c9
          readOnly: true
        monitoringSettingsType:
          $ref: '#/components/schemas/EndpointMonitoringSettingsType'
        agentIds:
          type: array
          nullable: true
          description: Endpoint Agent IDs selected by the monitoring settings.
          items:
            $ref: '#/components/schemas/EndpointAgentId'
        tagIds:
          type: array
          nullable: true
          description: Endpoint Agent tag IDs selected by the monitoring settings.
          example:
          - 49d9e7d2-7df5-43df-9b37-aa596b929062
          items:
            type: string
            format: uuid
        labelIds:
          type: array
          nullable: true
          description: Legacy Endpoint Agent label IDs selected by the monitoring settings.
          example:
          - '567'
          items:
            type: string
            example: '567'
            readOnly: true
    EndpointMonitoringSettingsType:
      type: string
      description: Endpoint Agent selector type used by the monitoring settings.
      enum:
      - all-agents
      - specific-agents
      - agent-labels
      - agent-tags
      example: agent-tags
      readOnly: true
    DynamicTests:
      type: object
      properties:
        tests:
          type: array
          items:
            $ref: '#/components/schemas/DynamicTest'
        _links:
          $ref: '#/components/schemas/SelfLinks'
    EndpointTests:
      type: object
      properties:
        tests:
          type: array
          items:
            $ref: '#/components/schemas/EndpointTest'
        _links:
          $ref: '#/components/schemas/SelfLinks'
    EndpointAgentToServerTests:
      type: object
      properties:
        tests:
          type: array
          items:
            $ref: '#/components/schemas/EndpointAgentToServerTest'
        _links:
          $ref: '#/components/schemas/SelfLinks'
    EndpointHttpServerTests:
      type: object
      properties:
        tests:
          type: array
          items:
            $ref: '#/components/schemas/EndpointHttpServerTest'
        _links:
          $ref: '#/components/schemas/SelfLinks'
    EndpointHttpTestUpdate:
      allOf:
      - $ref: '#/components/schemas/TestUpdate'
      - type: object
        properties:
          url:
            $ref: '#/components/schemas/EndpointHttpServerTestUrl'
    EndpointNetworkTestUpdate:
      allOf:
      - $ref: '#/components/schemas/TestUpdate'
      - type: object
        properties:
          port:
            $ref: '#/components/schemas/TestPort'
          server:
            type: string
            description: Target domain name or IP address.
            example: www.example.com
    EndpointDynamicTestUpdate:
      allOf:
      - $ref: '#/components/schemas/TestUpdate'
      - type: object
        properties:
          application:
            $ref: '#/components/schemas/DynamicTestApplication'
    UnauthorizedError:
      type: object
      properties:
        error:
          type: string
          example: invalid_token
        error_description:
          type: string
          example: Invalid access token
    Error:
      type: object
      properties:
        type:
          type: string
          description: A URI reference that identifies the problem type. When this member is not present, its value is assumed
            to be "about:blank".
        title:
          type: string
          description: A short, human-readable summary of the problem type.
        status:
          type: integer
          description: The HTTP status code generated by the origin server for this occurrence of the problem.
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem.
        instance:
          type: string
          description: A URI reference that identifies the specific occurrence of the problem.
    EndpointTestAgentSelectorType:
      type: string
      enum:
      - all-agents
      - specific-agents
      - agent-labels
      - agent-tags
      description: "Specifies how agents are selected for the endpoint test.\n\nAgents can be selected from:\n  - all available\
        \ agents\n  - a specific list of agents\n  - agents matching tags\n  - agents matching labels (deprecated)\n"
      default: all-agents
      example: all-agents
    EndpointTestAgents:
      type: array
      description: List of endpoint agent IDs (obtained from `/endpoint/agents` endpoint). Required when `agentSelectorType`
        is set to `specific-agent`.
      items:
        type: string
        format: uuid
      example:
      - 0a3b9998-dc3a-4ff2-b50d-ac4a7cd986e1
      - 66eec0f1-72b4-4755-aa83-3aed61d17f3c
    EndpointAgentLabels:
      type: array
      deprecated: true
      description: 'Deprecated. Use `tagIds` instead.


        List of endpoint agent label IDs (obtained from `/endpoint/labels` endpoint), required when `agentSelectorType` is
        set to `agent-labels`.

        '
      items:
        type: string
      example:
      - '567'
      - '214'
    TagIds:
      type: array
      description: List of tag IDs (obtained from `/tags` endpoint).
      items:
        type: string
        format: uuid
      example:
      - c6b78e57-81a2-4c5f-a11a-d96c3c664d55
      - 5aeab5d5-0d34-4d44-a7ac-fb440185295c
    EndpointTestMaxMachines:
      type: integer
      description: Maximum number of agents which can execute the test.
      default: 25
      example: 25
    TestName:
      type: string
      description: Name of the test.
      example: Test name
    EndpointIpVersionIn:
      description: For configuring network tests, the IP version of the test.
      type: string
      enum:
      - V4_ONLY
      - V6_ONLY
      - V6_PREFER
      - OS_DEFAULT
      example: V4_ONLY
    EndpointInstantTest:
      type: object
      required:
      - testName
      properties:
        agentSelectorType:
          $ref: '#/components/schemas/EndpointTestAgentSelectorType'
        agents:
          $ref: '#/components/schemas/EndpointTestAgents'
        endpointAgentLabels:
          $ref: '#/components/schemas/EndpointAgentLabels'
        tagIds:
          $ref: '#/components/schemas/TagIds'
        maxMachines:
          $ref: '#/components/schemas/EndpointTestMaxMachines'
        testName:
          $ref: '#/components/schemas/TestName'
        ipVersion:
          $ref: '#/components/schemas/EndpointIpVersionIn'
    EndpointTestPort:
      type: integer
      description: Port number.
      default: 443
      example: 443
    EndpointAgentToServerInstantTest:
      allOf:
      - $ref: '#/components/schemas/EndpointInstantTest'
      - type: object
        required:
        - server
        properties:
          serverName:
            type: string
            deprecated: true
            description: A server address without a protocol or IP address. **Deprecated, use `server` instead**.
            example: www.example.com
          server:
            type: string
            description: Target domain name or IP address.
            example: www.example.com
          port:
            $ref: '#/components/schemas/EndpointTestPort'
    TestIsPrioritized:
      type: boolean
      description: Indicates whether the test should be prioritized when the number of tests assigned to an agent exceeds
        the license limit.
      default: false
      example: false
    TestInterval:
      type: integer
      enum:
      - 60
      - 120
      - 300
      - 600
      - 900
      - 1800
      - 3600
      description: Interval between test runs in seconds.
      default: 60
      example: 60
    EndpointTestProtocol:
      type: string
      enum:
      - icmp
      - icmp-with-tcp-connect
      - tcp
      - prefer-tcp
      - ast-autodetect
      - autodetect
      description: Protocol requested for the test.
      default: icmp
      example: icmp
    EndpointAgentToServerTestRequest:
      allOf:
      - $ref: '#/components/schemas/EndpointAgentToServerInstantTest'
      - type: object
        properties:
          isPrioritized:
            $ref: '#/components/schemas/TestIsPrioritized'
          interval:
            $ref: '#/components/schemas/TestInterval'
          protocol:
            $ref: '#/components/schemas/EndpointTestProtocol'
    AccountGroupId:
      type: string
      description: A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the
        `/account-groups` endpoint.
      example: '1234'
    Link:
      type: object
      description: A hyperlink from the containing resource to a URI.
      required:
      - href
      properties:
        href:

# --- truncated at 32 KB (57 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/thousandeyes/refs/heads/main/openapi/thousandeyes-endpoint-tests-openapi.yml