{"type":"model","meta":{"id":"/apps/pubhub/media/000-v7-apis/5b3454a4300b838cc17f7b2cdc0690fdd15058d5/fb944e6d-6400-3b77-a981-83f695a8f9f8","info":{"description":"\nManage endpoint agent dynamic and scheduled tests using the Endpoint Tests API.\n","title":"Endpoint Tests API","version":"7.0.34"},"security":[{"BearerAuth":[]}],"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"}],"externalDocs":{"description":"Find out more about Endpoint Agent Scheduled Tests","url":"https://docs.thousandeyes.com/product-documentation/end-user-monitoring/scheduled-tests"},"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":{"properties":{"agentSelectorType":{"default":"all-agents","description":"Retrieve either all available agents, a specific list of agents, or a list of agent labels.","enum":["all-agents","specific-agents","agent-labels"],"example":"all-agents","type":"string","$$ref":"#/components/schemas/EndpointTestAgentSelectorType"},"agents":{"description":"List of endpoint agent IDs (obtained from `/endpoint/agents` endpoint). Required when `agentSelectorType` is set to `specific-agent`.","example":["0a3b9998-dc3a-4ff2-b50d-ac4a7cd986e1","66eec0f1-72b4-4755-aa83-3aed61d17f3c"],"items":{"format":"uuid","type":"string"},"type":"array","$$ref":"#/components/schemas/EndpointTestAgents"},"endpointAgentLabels":{"description":"List of endpoint agent label IDs (obtained from `/endpoint/labels` endpoint), required when `agentSelectorType` is set to `agent-labels`.","example":["567","214"],"items":{"type":"string"},"type":"array","$$ref":"#/components/schemas/EndpointAgentLabels"},"interval":{"default":60,"description":"Interval between test runs in seconds.","enum":[60,120,300,600,900,1800,3600],"example":60,"type":"integer","$$ref":"#/components/schemas/TestInterval"},"maxMachines":{"default":25,"description":"Maximum number of agents which can execute the test.","example":25,"type":"integer","$$ref":"#/components/schemas/EndpointTestMaxMachines"},"application":{"description":"Which supported application to monitor, can be one of `webex`, `zoom`, `microsoft-teams`.","example":"webex","type":"string","$$ref":"#/components/schemas/DynamicTestApplication"},"protocol":{"default":"icmp","description":"Protocol requested for the test.","enum":["icmp","icmp-with-tcp-connect","tcp","prefer-tcp","ast-autodetect","autodetect"],"example":"icmp","type":"string","$$ref":"#/components/schemas/EndpointTestProtocol"},"tcpProbeMode":{"default":"auto","description":"Probe mode used by network test, only valid when the protocol is set to TCP.","enum":["auto","sack","syn"],"example":"auto","type":"string","$$ref":"#/components/schemas/TestProbeMode"},"testName":{"description":"Name of the test.","example":"Test name","type":"string","$$ref":"#/components/schemas/TestName"},"hasPathTraceInSession":{"description":"Enables \"in session\" path trace. When enabled, this option initiates a TCP session with the target server and sends path trace packets within the established TCP session.","example":true,"type":"boolean","$$ref":"#/components/schemas/TestHasPathTraceInSession"}},"required":["application","testName"],"type":"object","$$ref":"#/components/schemas/DynamicTestRequest","title":"DynamicTestRequest"}}