openapi: 3.2.0
info:
  version: 7.0.100
  title: Endpoint Agents Endpoint Proxies API
  description: "**Note:** The Endpoint Agents Transfer APIs are not available for ThousandEyes for Government instance.\n\nManage ThousandEyes Endpoint Agents using this API. \n\nFor more information about Endpoint Agents, see [Endpoint Agents](https://docs.thousandeyes.com/product-documentation/global-vantage-points/endpoint-agents)."
  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/
servers:
- description: ThousandEyes API production URL
  url: https://api.thousandeyes.com/v7
security:
- BearerAuth: []
tags:
- name: Endpoint Proxies
paths:
  /endpoint/proxies:
    get:
      tags:
      - Endpoint Proxies
      summary: List endpoint proxy settings
      operationId: getEndpointProxies
      description: Returns proxy settings for endpoint agents. Proxy passwords are never returned.
      parameters:
      - $ref: '#/components/parameters/AccountGroupId'
      responses:
        '200':
          description: Proxy settings for endpoint agents.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointProxiesResponse'
        '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'
components:
  responses:
    '500':
      description: Internal server error
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            type: about:blank
            title: Internal server error
            status: 500
            detail: Optional detail about the internal error message.
            instance: /v7
    '403':
      description: Insufficient permissions to query endpoint
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Error'
    '429':
      description: Exhausted rate limit for the organization
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Error'
    GeneralError:
      description: An error occurred
    '401':
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/UnauthorizedError'
  schemas:
    EndpointProxiesResponse:
      type: object
      required:
      - proxies
      properties:
        proxies:
          type: array
          description: Proxy settings configured for endpoint agents.
          items:
            $ref: '#/components/schemas/EndpointProxy'
    EndpointProxyType:
      type: string
      description: Proxy setting type.
      enum:
      - static
      - pac
      - direct
      - system
      - interactive-user-proxy
      example: static
      readOnly: true
    UnauthorizedError:
      type: object
      properties:
        error:
          type: string
          example: invalid_token
        error_description:
          type: string
          example: Invalid access token
    EndpointProxy:
      type: object
      properties:
        proxyId:
          type: string
          description: Unique ID of the proxy setting.
          example: '101498'
          readOnly: true
        name:
          type: string
          description: Proxy setting name.
          example: Local Mitmproxy
          readOnly: true
        type:
          $ref: '#/components/schemas/EndpointProxyType'
        host:
          type:
          - string
          - 'null'
          description: Static proxy host name or IP address.
          example: localhost
          readOnly: true
        port:
          type:
          - integer
          - 'null'
          description: Static proxy port.
          example: 8080
          readOnly: true
        pac:
          type:
          - string
          - 'null'
          description: PAC URL or PAC script location.
          example: https://example.com/proxy.pac
          readOnly: true
        userName:
          type:
          - string
          - 'null'
          description: Proxy authentication user name.
          example: endpoint-proxy-user
          readOnly: true
        bypassList:
          type:
          - string
          - 'null'
          description: Comma-separated proxy bypass list.
          example: localhost,127.0.0.1
          readOnly: true
        authType:
          $ref: '#/components/schemas/EndpointProxyAuthType'
        agentIds:
          type:
          - array
          - 'null'
          description: Endpoint Agent IDs assigned to the proxy setting.
          items:
            $ref: '#/components/schemas/EndpointAgentId'
        testIds:
          type:
          - array
          - 'null'
          description: Endpoint scheduled test IDs assigned to the proxy setting.
          items:
            type: string
            example: '9923667'
            readOnly: true
    EndpointProxyAuthType:
      type: string
      description: Proxy authentication type.
      enum:
      - none
      - basic
      - ntlm
      example: none
      readOnly: true
    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.
    EndpointAgentId:
      type: string
      format: uuid
      description: Unique ID of endpoint agent, from `/endpoint/agents` endpoint.
      example: 861b7557-cd57-4bbb-b648-00bddf88ef49
      readOnly: true
  parameters:
    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'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Bearer authentication token