{"type":"model","meta":{"id":"/apps/pubhub/media/000-v7-apis/5b3454a4300b838cc17f7b2cdc0690fdd15058d5/8ebf57c6-5c11-32a6-b382-0c79fa6e8efc","info":{"description":"Manage 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).","title":"Endpoint Agents API","version":"7.0.34"},"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":{"description":"Bearer authentication token","scheme":"bearer","type":"http"}}},"spec":{"description":"Parameters for filtering a list of agents.","properties":{"searchFilters":{"properties":{"id":{"description":"Returns only agents that are an exact match of the provided identifiers.","items":{"description":"Unique ID of endpoint agent, from `/endpoint/agents` endpoint.","example":"861b7557-cd57-4bbb-b648-00bddf88ef49","format":"uuid","readOnly":true,"type":"string","$$ref":"#/components/schemas/EndpointAgentId"},"type":"array"},"agentName":{"description":"Returns only agents with the given name. \nThis is an exact match only.\n","items":{"description":"Returns only agents with the specified name. \nThis is an exact match only.\n","example":"myagent-1234","type":"string","$$ref":"#/components/schemas/AgentName"},"type":"array"},"computerName":{"description":"Returns only agents with the given computer name.\nThis is an exact match only.\n","items":{"description":"Returns only agents with the specified computer name.\nThis is an exact match only.\n","example":"DESKTOP-45AE8","type":"string","$$ref":"#/components/schemas/ComputerName"},"type":"array"},"username":{"description":"Returns only agents that have at least one user with a name.\nstarting with the provided string. This is a case-insensitive prefix match.\n","example":["picard"],"items":{"type":"string"},"type":"array"},"platform":{"description":"Filter on the platform on which the agent is running.\n","items":{"description":"OS platform types. Platform \"linux\" was recently renamed to \"roomos\".","enum":["windows","roomos","phoneos","elux","linux","mac","unknown"],"example":"mac","type":"string","$$ref":"#/components/schemas/Platform"},"type":"array"},"osVersion":{"description":"Case-insensitive prefix filter on the OS version.","items":{"example":"Version 10.15.2","type":"string"},"type":"array"},"locationCountryISO":{"description":"Filter using the ISO country code of the location.\n","items":{"example":"FR","type":"string"},"type":"array"},"locationSubdivision1Code":{"description":"Filter using the code for the first level administrative division within \nthe country. In US/Canada this is the State, in UK it's the country e.g. `ENG`\n","items":{"example":"ENG","type":"string"},"type":"array"},"locationCity":{"description":"This is a prefix match on the city name field. The endpoint expects this to contain the \nname of the city in English. e.g. 'Paris' or ''\n","items":{"example":"Paris","type":"string"},"type":"array"},"licenseType":{"description":"Filter on the agent's license type\n","items":{"enum":["essentials","advantage","embedded"],"example":"essentials","type":"string","$$ref":"#/components/schemas/AgentLicenseType"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/AgentSearchFilters"},"thresholdFilter":{"description":"All filters are applied based on the conditional operator (and/or).","properties":{"filters":{"items":{"description":"The metric is filtered based on the threshold value and operator provided.","properties":{"name":{"enum":["last-seen-ms"],"type":"string"},"value":{"description":"The threshold value.","format":"double","type":"number"},"operator":{"enum":["gte","lte"],"example":"gte","type":"string","$$ref":"#/components/schemas/ThresholdFilterOperator"}},"type":"object","$$ref":"#/components/schemas/AgentThresholdFilter"},"type":"array"},"conditionalOperator":{"enum":["and","or"],"example":"and","type":"string","$$ref":"#/components/schemas/ConditionalOperator"}},"type":"object","$$ref":"#/components/schemas/AgentThresholdFilters"},"searchSort":{"items":{"properties":{"sort":{"enum":["platform","osVersion","name","userName","city"],"type":"string","$$ref":"#/components/schemas/AgentSearchSortKey"},"order":{"description":"Parameter indicates the ascending/descending order of the sorting, using either the asc or desc values.","enum":["asc","desc"],"example":"desc","type":"string","$$ref":"#/components/schemas/SortOrder"}},"type":"object","$$ref":"#/components/schemas/AgentSearchSort"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/AgentSearchRequest","title":"AgentSearchRequest"}}