{"type":"model","meta":{"id":"/apps/pubhub/media/000-v7-apis/5b3454a4300b838cc17f7b2cdc0690fdd15058d5/78f45443-a63d-31b5-a066-5ca5d2bfbb18","info":{"description":"This API supports listing, creating, editing, and deleting Cloud and Enterprise Agent (CEA) based tests.\n","title":"Tests API","version":"7.0.34"},"security":[{"BearerAuth":[]}],"tags":[{"description":"Get all tests","name":"Tests"},{"description":"Agent to Server test management operations","name":"Agent to Server Tests"},{"description":"Agent to Agent test management operations","name":"Agent to Agent Tests"},{"description":"BGP test management operations","name":"BGP Tests"},{"description":"DNS Server test management operations","name":"DNS Server Tests"},{"description":"DNS Trace test management operations","name":"DNS Trace Tests"},{"description":"DNSSEC test management operations","name":"DNSSEC Tests"},{"description":"HTTP Server test management operations","name":"HTTP Server Tests"},{"description":"Page Load test management operations","name":"Page Load Tests"},{"description":"Web Transactions test management operations","name":"Web Transaction Tests"},{"description":"API test management operations","name":"API Tests"},{"description":"FTP Server test management operations","name":"FTP Server Tests"},{"description":"SIP Server test management operations","name":"SIP Server Tests"},{"description":"Voice test management operations","name":"Voice Tests"},{"name":"Path Visualization Interface Groups"}],"externalDocs":{"description":"Find out more about Cloud and Enterprise Agent-Based Tests","url":"https://docs.thousandeyes.com/product-documentation/internet-and-wan-monitoring/tests#cloud-and-enterprise-agent-based-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"}}