{"type":"model","meta":{"id":"/apps/pubhub/media/000-v7-apis/5b3454a4300b838cc17f7b2cdc0690fdd15058d5/202e6e17-f3af-335e-a547-da4402ccdd8d","info":{"description":"The Instant Tests API operations lets you create and run new instant tests. You will need to be a regular user or have the following permissions:\n * `API Access`\n * `View tests`\n\nThe response does not include the immediate test results. Use the Test Results endpoints to get test results after creating and executing an instant test. You can find the URLs for these endpoints in the _links section of the test definition that is returned when you create the instant test.\n","title":"Instant Tests API","version":"7.0.34"},"security":[{"BearerAuth":[]}],"tags":[{"name":"Instant Tests"},{"name":"Agent to Agent Instant Tests"},{"name":"Agent to Server Instant Tests"},{"name":"DNS Server Instant Tests"},{"name":"DNS Trace Instant Tests"},{"name":"DNSSEC Instant Tests"},{"name":"HTTP Server Instant Tests"},{"name":"HTTP Page Load Instant Tests"},{"name":"Web Transaction Instant Tests"},{"name":"API Instant Tests"},{"name":"FTP Server Instant Tests"},{"name":"SIP Server Instant Tests"},{"name":"Voice Instant Tests"}],"externalDocs":{"description":"Find out more about Instant Tests.","url":"https://docs.thousandeyes.com/product-documentation/internet-and-wan-monitoring/tests/working-with-instant-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":{"bandwidthMeasurements":{"description":"Set to `true` to enable bandwidth measurements, only applies to Enterprise agents assigned to the test.","example":true,"type":"boolean"},"downloadLimit":{"description":"Specify maximum number of bytes to download from the target object.","example":1048576,"type":"integer"},"ftpTargetTime":{"description":"Target time for operation completion; specified in milliseconds.","maximum":6000,"minimum":1000,"type":"integer"},"ftpTimeLimit":{"default":10,"description":"Set the time limit for the test in seconds.","example":10,"maximum":60,"minimum":10,"type":"integer"},"mtuMeasurements":{"description":"Set `true` to measure MTU sizes on network from agents to the target.","example":false,"type":"boolean"},"networkMeasurements":{"default":true,"description":"Enable or disable network measurements. Set to true to enable or false to disable network measurements.","example":true,"type":"boolean"},"numPathTraces":{"default":3,"description":"Number of path traces executed by the agent.","example":3,"maximum":10,"minimum":1,"type":"integer"},"password":{"description":"Password for Basic/NTLM authentication.","example":"password","type":"string","writeOnly":true},"pathTraceMode":{"default":"classic","description":"Select `inSession` to perform the path trace within a TCP session.","enum":["classic","in-session"],"example":"classic","type":"string","$$ref":"#/components/schemas/TestPathTraceMode"},"probeMode":{"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"},"protocol":{"default":"tcp","description":"Protocol used by dependent network tests (end-to-end, path trace, PMTUD).","enum":["tcp","icmp","udp"],"example":"tcp","type":"string","$$ref":"#/components/schemas/TestProtocol"},"randomizedStartTime":{"default":false,"description":"Indicates whether agents should randomize the start time in each test round.","example":false,"type":"boolean"},"requestType":{"description":"Set the type of activity for the test.","enum":["download","upload","list"],"example":"download","type":"string","$$ref":"#/components/schemas/FtpServerRequestType"},"url":{"description":"Target for the test.","example":"www.thousandeyes.com","type":"string"},"useActiveFtp":{"default":false,"description":"Explicitly set the flag to use active FTP.","example":false,"type":"boolean"},"useExplicitFtps":{"description":"Use explicit FTPS (ftp over SSL). By default, tests will autodetect when it is appropriate to use FTPS.","example":false,"type":"boolean"},"username":{"description":"Username for Basic/NTLM authentication.","example":"username","type":"string"},"fixedPacketRate":{"description":"Sets packets rate sent to measure the network in packets per second.","example":50,"maximum":100,"minimum":0,"type":"integer"},"ipv6Policy":{"default":"use-agent-policy","description":"IP version policy. Overrides the IPv6 policy configured at the agent level.","enum":["force-ipv4","prefer-ipv6","force-ipv6","use-agent-policy"],"example":"use-agent-policy","type":"string","$$ref":"#/components/schemas/TestIpv6Policy"},"type":{"example":"ftp-server","readOnly":true,"type":"string"}},"required":["password","requestType","url","username"],"type":"object","$$ref":"#/components/schemas/FtpServerProperties","title":"FtpServerProperties"}}