EndpointAgents - ThousandEyes API v7

{"type":"model","meta":{"id":"/apps/pubhub/media/000-v7-apis/eb73ef9d6f95b0e73b23b4642ac64f87b00a2845/8ebf57c6-5c11-32a6-b382-0c79fa6e8efc","info":{"version":"7.0.88","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 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":{"description":"A list of `EndpointAgents`.","type":"object","properties":{"totalAgents":{"type":"integer","example":1,"description":"The total number of agents."},"agents":{"x-paginated-items":true,"type":"array","items":{"description":"The `EndpointAgent` object, which may include multiple clients.","type":"object","properties":{"id":{"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"},"aid":{"type":"string","description":"A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint.","example":"1234","$$ref":"#/components/schemas/AccountId","readOnly":true},"name":{"description":"The name of the agent.","type":"string","readOnly":false,"example":"Office Printer"},"computerName":{"type":"string","example":"DESKJET-123","readOnly":true},"osVersion":{"type":"string","example":"Version 10.15.2 (Build 19C57)","readOnly":true},"platform":{"description":"OS platform types. Platform \"linux\" was recently renamed to \"roomos\".","type":"string","enum":["windows","roomos","phoneos","elux","cisco-wireless","linux","mac","android","unknown"],"example":"mac","$$ref":"#/components/schemas/Platform"},"kernelVersion":{"type":"string","example":"Darwin 19.2.0","readOnly":true},"manufacturer":{"type":"string","example":"Apple, Inc.","readOnly":true},"model":{"type":"string","example":"MacBookAir7,2","readOnly":true},"serialNumber":{"type":"string","example":"xaab2ba4-d40f-4e80-9363-7e4826556055","readOnly":true},"lastSeen":{"description":"The last time the agent checked-in.","type":"string","format":"date-time","example":"2022-05-26T23:37:16Z","readOnly":true},"status":{"description":"Status of the endpoint agent in ThousandEyes. Disabled agents don't report data.","type":"string","example":"enabled","enum":["enabled","disabled"],"readOnly":true,"$$ref":"#/components/schemas/Status"},"deleted":{"type":"boolean","readOnly":true},"version":{"description":"Version of the agent software running.","type":"string","example":"0.123.4","readOnly":true},"targetVersion":{"description":"The latest available version of the agent. This field is populated only if expand includes `targetVersion`.","type":"string","example":"0.123.4","readOnly":true},"createdAt":{"type":"string","format":"date-time","example":"2022-05-26T23:37:16Z","readOnly":true},"numberOfClients":{"type":"integer","format":"int64","example":3,"readOnly":true},"publicIP":{"type":"string","format":"ip","example":"88.45.2.123","readOnly":true},"location":{"description":"Approximate location of the agent.","type":"object","properties":{"latitude":{"type":"number","format":"double","example":51.51279,"readOnly":true},"longitude":{"type":"number","format":"double","example":-0.09184,"readOnly":true},"locationName":{"type":"string","example":"London","readOnly":true}},"$$ref":"#/components/schemas/EndpointAgentLocation"},"clients":{"type":"array","readOnly":true,"description":"List of clients (user accounts) that the agent works with.\nNot populated by default.\n","items":{"description":"Information about the user who has the agent installed.","type":"object","properties":{"userProfile":{"required":["userName"],"type":"object","properties":{"userName":{"type":"string","example":"joeblogs32"},"userPrincipalName":{"type":"string","example":"joeblogs32@c.com"}},"$$ref":"#/components/schemas/EndpointUserProfile"},"browserExtensions":{"type":"array","items":{"type":"object","properties":{"browser":{"type":"string","example":"edge","enum":["chrome","chrome-canary","chromium","ie","edge","unknown"],"$$ref":"#/components/schemas/BrowserType"},"profile":{"type":"string","description":"Name of the browser profile where this extension is stored.","example":"Profile 1"},"version":{"type":"string","description":"Endpoint agent browser extension version.","example":"0.123.0"},"enabled":{"type":"boolean","description":"Indicates if the extension is disabled or enabled in the web browser."},"active":{"type":"boolean","description":"Flag indicating if there is communication between the extension and ThousandEyes portal.\n"},"error":{"type":"string","description":"Contains any errors encountered while getting extension status.","example":""}},"$$ref":"#/components/schemas/EndpointBrowserExtension"}}},"$$ref":"#/components/schemas/EndpointClient"}},"totalMemory":{"type":"string","example":"16384 MB","readOnly":true},"agentType":{"type":"string","example":"endpoint","readOnly":true},"vpnProfiles":{"type":"array","readOnly":true,"description":"List of VPN connections on the agent.\nNot populated by default.\n","items":{"required":["vpnClientAddresses","vpnClientNetworkRange"],"type":"object","properties":{"interfaceName":{"type":"string","description":"Interface name associated with `interfaceProfile`."},"vpnType":{"type":"string","description":"Name of the VPN provider.","enum":["cisco-anyconnect","palo-alto-globalprotect","ivanti-connect-secure","zscaler-internet-access","f5-big-ip"],"example":"cisco-anyconnect","$$ref":"#/components/schemas/VpnType"},"vpnGatewayAddress":{"type":"string","description":"IP address of the VPN gateway."},"vpnClientAddresses":{"type":"array","description":"List of private IP addresses assigned to the device, by the VPN server.","example":["10.100.0.10"],"items":{"type":"string","format":"ip"}},"vpnClientNetworkRange":{"type":"array","description":"List of private networks assigned to the device, by the VPN server.","example":["10.100.0.0/22"],"items":{"type":"string"}}},"$$ref":"#/components/schemas/EndpointVpnProfile"}},"externalMetadata":{"type":"array","items":{"properties":{"key":{"type":"string","example":"anyConnectDeviceId","description":"ID of the device that has the Cisco Secure Client deployed with the Internet Security module."},"value":{"type":"string","example":"DF434343D","description":"Value of the external metadata property."}},"example":{"key":"anyConnectDeviceId","value":"DF434343D"},"$$ref":"#/components/schemas/ExternalMetadataItem"},"description":"List of external metadata assigned to the endpoint agent. \nVisible only if the `expandAgent=externalMetadata` query parameter is included.\n","$$ref":"#/components/schemas/ExternalMetadata"},"networkInterfaceProfiles":{"description":"List of network interfaces on the agent.\nNot populated by default.\n","type":"array","readOnly":true,"items":{"type":"object","properties":{"interfaceName":{"type":"string","example":"en0"},"addressProfiles":{"type":"array","items":{"type":"object","description":"A description of the IPs assigned to this machine.","properties":{"addressType":{"type":"string","example":"unique-local","enum":["loopback","unspecified","unique-local","link-local","unique-global"],"$$ref":"#/components/schemas/AddressType"},"ipAddress":{"type":"string","format":"ip","example":"2001:db8:3333:4444:5555:6666:7777:8888","description":"IP address of this interface in the network it's currently connected to."},"prefixLength":{"type":"integer","format":"int32","example":24,"description":"The number of bits representing the network part of the `ipAddress`."},"gateway":{"type":"string","format":"ip","example":"192.168.0.254","description":"The default gateway for this interface."},"routerHardwareAddress":{"type":"string","format":"macaddress","example":"5c:b1:3e:46:1c:84","description":"The router's MAC address resolved from an ARP request."}},"$$ref":"#/components/schemas/AddressProfile"}},"hardwareType":{"type":"string","example":"wireless","enum":["unknown","wireless","ethernet","modem","virtual","loopback","other"],"$$ref":"#/components/schemas/InterfaceHardwareType"},"ethernetProfile":{"type":"object","description":"Information about the ethernet connectivity of this device.\nOnly present if the hardware type is `ethernet`.\n","properties":{"linkSpeed":{"type":"integer","description":"Link speed in Mbps.","format":"int32"}},"$$ref":"#/components/schemas/EndpointAgentEthernetProfile"},"wirelessProfile":{"type":"object","properties":{"bssid":{"type":"string","format":"macaddress","example":"00:11:22:aa:bb:cc"},"ssid":{"type":"string","example":"GuestWiFi"},"rssi":{"type":"integer","format":"int32","example":-36},"channel":{"type":"integer","format":"int32","example":48},"phyMode":{"type":"string","example":"802.11ac"}},"$$ref":"#/components/schemas/WirelessProfile"}},"$$ref":"#/components/schemas/InterfaceProfile"}},"asnDetails":{"required":["asNumber"],"type":"object","readOnly":true,"properties":{"asNumber":{"type":"integer","format":"int64","example":5089,"description":"Autonomous system number."},"asName":{"type":"string","example":"Virgin Media Limited","description":"Name of autonomous system."}},"$$ref":"#/components/schemas/EndpointAsnDetails"},"licenseType":{"type":"string","example":"essentials","enum":["essentials","advantage","embedded"],"$$ref":"#/components/schemas/AgentLicenseType"},"tcpDriverAvailable":{"type":"boolean","readOnly":true,"description":"Status of TCP test support on the agent."},"npcapVersion":{"type":"string","readOnly":true,"description":"For Windows agents, the version of the NPCAP driver that the agent has loaded."},"batteryMetrics":{"description":"Battery metrics for the endpoint agent.","type":"object","readOnly":true,"properties":{"batteryLevel":{"description":"Battery level indicator.","type":"string","example":"medium","enum":["high","medium","low"],"$$ref":"#/components/schemas/BatteryLevel"},"batteryLevelNormalizedPercent":{"type":"number","format":"double","description":"Battery level as a normalized percentage (0-1).","example":0.3,"minimum":0,"maximum":1}},"required":["batteryLevel","batteryLevelNormalizedPercent"],"$$ref":"#/components/schemas/BatteryMetrics"},"cellularProfile":{"description":"Cellular network profile information for a mobile endpoint agent.","type":"object","readOnly":true,"properties":{"carrierName":{"type":"string","description":"Carrier name","example":"T-Mobile"},"networkGen":{"description":"Cellular network generation.","type":"string","example":"2g, 3g, 4g, 5g","$$ref":"#/components/schemas/CellularNetworkGen"},"networkSubtype":{"type":"string","description":"A real network subtype. It may be different from an advertised network type.","example":"LTE/HSPA"},"advertisedNetworkGen":{"description":"Cellular network generation.","type":"string","example":"2g, 3g, 4g, 5g","$$ref":"#/components/schemas/CellularNetworkGen"},"advertisedNetworkSubtype":{"type":"string","description":"Advertised Network subtype","example":"LTE/HSPA"},"rssi":{"type":"number","format":"double","description":"Received Signal Strength Indicator in dBm. Values are always negative.","example":-10},"rsrp":{"type":"number","format":"double","description":"Reference Signal Received Power in dBm. Values are always negative.","example":-30},"rscp":{"type":"number","format":"double","description":"Received Signal Code Power in dBm. Values are always negative or zero.","example":-30},"rsrq":{"type":"number","format":"double","description":"Reference Signal Received Quality in dBm. Values are always negative.","example":-30},"sinr":{"type":"number","format":"double","description":"Signal to Interference and Noise Ratio in dBm. It can be negative or positive.","example":20}},"$$ref":"#/components/schemas/CellularProfile"},"_links":{"type":"object","description":"A links object containing the self link.","readOnly":true,"properties":{"self":{"type":"object","description":"A hyperlink from the containing resource to a URI.","required":["href"],"properties":{"href":{"type":"string","description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id"},"templated":{"type":"boolean","description":"Should be true when the link object's \"href\" property is a URI template."},"type":{"type":"string","description":"Used as a hint to indicate the media type expected when dereferencing the target resource."},"deprecation":{"type":"string","description":"Its presence indicates that the link is to be deprecated at a future date. Its value is a URL that should provide further information about the deprecation."},"name":{"type":"string","description":"Its value may be used as a secondary key for selecting link objects that share the same relation type."},"profile":{"type":"string","description":"A URI that hints about the profile of the target resource."},"title":{"type":"string","description":"Intended for labelling the link with a human-readable identifier"},"hreflang":{"type":"string","description":"Indicates the language of the target resource"}},"$$ref":"#/components/schemas/Link"}},"$$ref":"#/components/schemas/SelfLinks"}},"$$ref":"#/components/schemas/EndpointAgent"}}},"$$ref":"#/components/schemas/EndpointAgents","title":"EndpointAgents"}}