{"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"},"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"},"maxMachines":{"default":25,"description":"Maximum number of agents which can execute the test.","example":25,"type":"integer"},"testName":{"description":"Name of the test.","example":"Test name","type":"string"},"authType":{"default":"none","description":"HTTP authentication type.","enum":["none","basic","ntlm"],"example":"none","type":"string","$$ref":"#/components/schemas/EndpointTestAuthType"},"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"},"httpTimeLimit":{"default":5000,"description":"Maximum amount of time in milliseconds the agents wait before a request times out.","example":5000,"type":"integer"},"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"},"username":{"description":"Username for Basic/NTLM authentication.","example":"username","type":"string"},"sslVersionId":{"default":"0","description":"SSL version options:\n\n* Use '0' for automatic selection.\n* Use '3' for SSLv3.\n* Use '4' for TLS v1.0.\n* Use '5' for TLS v1.1.\n* Use '6' for TLS v1.2.\n","enum":["0","3","4","5","6"],"example":"0","type":"string","$$ref":"#/components/schemas/TestSslVersionId"},"tcpProbeMode":{"default":"auto","description":"Probe mode used by network test, only valid when the protocol is set to TCP.","enum":["auto","sack","syn","unknown"],"example":"auto","type":"string","$$ref":"#/components/schemas/TestProbeModeResponse"},"verifyCertificate":{"default":true,"description":"Flag indicating if a certificate should be verified.","example":true,"type":"boolean"},"url":{"description":"The test target URL. You can optionally specify the protocol (`http` or `https`). \n\n- **Default Protocol:** If no protocol is specified, `https` is used by default.\n\n- **Port Number:** To specify a port, append it to the URL with a colon after the hostname or IP address (e.g., `https://example.com:443`).\n\n - If no port is specified in the URL, the `port` is determined by the default for protocol (HTTP: 80, HTTPS: 443).\n","example":"https://example.com:443","type":"string","$$ref":"#/components/schemas/EndpointHttpServerTestUrl"},"hasPing":{"default":true,"deprecated":true,"description":"**(Deprecated)** Optional flag indicating if the test should run ping.","type":"boolean","$$ref":"#/components/schemas/TestRequestHasPing"},"hasTraceroute":{"default":true,"deprecated":true,"description":"**(Deprecated)** Optional flag indicating if the test should run traceroute.","type":"boolean","$$ref":"#/components/schemas/TestRequestHasTraceRoute"},"networkMeasurements":{"default":true,"description":"Enable or disable network measurements. Set to true to enable or false to disable network measurements.","example":true,"type":"boolean","$$ref":"#/components/schemas/TestNetworkMeasurements"},"targetResponseTime":{"default":1000,"description":"Response time target in milliseconds. Affects the colors of agents and legends on the view page. The value is compared with actual response time in order to determine the color scale (from green to red).","example":1000,"type":"integer"},"password":{"description":"Password for Basic/NTLM authentication.","example":"password","type":"string","writeOnly":true,"$$ref":"#/components/schemas/TestPassword"}},"required":["testName","url"],"type":"object","$$ref":"#/components/schemas/EndpointHttpServerInstantTest","title":"EndpointHttpServerInstantTest"}}