{"type":"api","title":"List endpoint proxy settings","meta":{"id":"/apps/pubhub/media/000-v7-apis/2cabdc9a06013343df12ec6445cac4b1398af4a3/8ebf57c6-5c11-32a6-b382-0c79fa6e8efc","info":{"version":"7.0.97","title":"Endpoint Agents 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)."},"security":[{"BearerAuth":[]}],"tags":[{"name":"Endpoint Agents"},{"name":"Endpoint Agent Log Items"},{"name":"Endpoint Proxies"},{"name":"Endpoint Agents Transfer"}],"openapi":"3.0.1","servers":[{"description":"ThousandEyes API production URL","url":"https://api.thousandeyes.com/v7"}],"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Bearer authentication token"}}},"spec":{"tags":["Endpoint Proxies"],"summary":"List endpoint proxy settings","operationId":"getEndpointProxies","description":"Returns proxy settings for endpoint agents. Proxy passwords are never returned.","parameters":[{"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"},"$$ref":"#/components/parameters/AccountGroupId"}],"responses":{"200":{"description":"Proxy settings for endpoint agents.","content":{"application/json":{"schema":{"type":"object","required":["proxies"],"properties":{"proxies":{"type":"array","description":"Proxy settings configured for endpoint agents.","items":{"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":{"type":"string","description":"Proxy setting type.","enum":["static","pac","direct","system","interactive-user-proxy"],"example":"static","readOnly":true,"$$ref":"#/components/schemas/EndpointProxyType"},"host":{"type":"string","nullable":true,"description":"Static proxy host name or IP address.","example":"localhost","readOnly":true},"port":{"type":"integer","nullable":true,"description":"Static proxy port.","example":8080,"readOnly":true},"pac":{"type":"string","nullable":true,"description":"PAC URL or PAC script location.","example":"https://example.com/proxy.pac","readOnly":true},"userName":{"type":"string","nullable":true,"description":"Proxy authentication user name.","example":"endpoint-proxy-user","readOnly":true},"bypassList":{"type":"string","nullable":true,"description":"Comma-separated proxy bypass list.","example":"localhost,127.0.0.1","readOnly":true},"authType":{"type":"string","description":"Proxy authentication type.","enum":["none","basic","ntlm"],"example":"none","readOnly":true,"$$ref":"#/components/schemas/EndpointProxyAuthType"},"agentIds":{"type":"array","nullable":true,"description":"Endpoint Agent IDs assigned to the proxy setting.","items":{"type":"string","format":"uuid","description":"Unique ID of endpoint agent, from `/endpoint/agents` endpoint.","example":"861b7557-cd57-4bbb-b648-00bddf88ef49","readOnly":true,"$$ref":"#/components/schemas/EndpointAgentId"}},"testIds":{"type":"array","nullable":true,"description":"Endpoint scheduled test IDs assigned to the proxy setting.","items":{"type":"string","example":"9923667","readOnly":true}}},"$$ref":"#/components/schemas/EndpointProxy"}}},"$$ref":"#/components/schemas/EndpointProxiesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"invalid_token"},"error_description":{"type":"string","example":"Invalid access token"}},"$$ref":"#/components/schemas/UnauthorizedError"}}},"$$ref":"#/components/responses/401"},"403":{"description":"Insufficient permissions to query endpoint","content":{"application/problem+json":{"schema":{"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."}},"$$ref":"#/components/schemas/Error"}}},"$$ref":"#/components/responses/403"},"429":{"description":"Exhausted rate limit for the organization","content":{"application/problem+json":{"schema":{"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."}},"$$ref":"#/components/schemas/Error"}}},"$$ref":"#/components/responses/429"},"500":{"description":"Internal server error","content":{"application/problem+json":{"schema":{"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."}},"$$ref":"#/components/schemas/Error"},"example":{"type":"about:blank","title":"Internal server error","status":500,"detail":"Optional detail about the internal error message.","instance":"/v7"}}},"$$ref":"#/components/responses/500"},"default":{"description":"An error occurred","$$ref":"#/components/responses/GeneralError"}},"__originalOperationId":"getEndpointProxies","security":[{"BearerAuth":[]}],"method":"get","path":"/endpoint/proxies"}}