HttpServerInstantTestResponse - ThousandEyes API v7

{"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":{"createdBy":{"description":"User that created the test.","example":"user@user.com","readOnly":true,"type":"string"},"createdDate":{"description":"UTC created date (ISO date-time format).","example":"2022-07-17T22:00:54Z","format":"date-time","readOnly":true,"type":"string"},"description":{"description":"A description of the test.","example":"ThousandEyes Test","type":"string"},"liveShare":{"description":"Indicates if the test is shared with the account group.","example":false,"readOnly":true,"type":"boolean"},"modifiedBy":{"description":"User that modified the test.","example":"user@user.com","readOnly":true,"type":"string"},"modifiedDate":{"description":"UTC last modification date (ISO date-time format).","example":"2022-07-17T22:00:54Z","format":"date-time","readOnly":true,"type":"string"},"savedEvent":{"description":"Indicates if the test is a saved event.","readOnly":true,"type":"boolean"},"testId":{"description":"Each test is assigned an unique ID; this is used to access test information and results from other endpoints.","example":"281474976710706","readOnly":true,"type":"string"},"testName":{"description":"The name of the test. Test name must be unique.","example":"ThousandEyes Test","type":"string"},"type":{"description":"This is a read only value, as test type is implicit in the test creation url.","enum":["api","agent-to-agent","agent-to-server","bgp","http-server","page-load","web-transactions","ftp-server","dns-trace","dns-server","dnssec","sip-server","voice"],"example":"http-server","readOnly":true,"type":"string","$$ref":"#/components/schemas/TestHttpType"},"_links":{"description":"A list of links that can be accessed to get more information","properties":{"self":{"description":"Reference to the test.","properties":{"href":{"description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id","type":"string"},"templated":{"description":"Should be true when the link object's \"href\" property is a URI template.","type":"boolean"},"type":{"description":"Used as a hint to indicate the media type expected when dereferencing the target resource.","type":"string"},"deprecation":{"description":"Its presence indicates that the link is to be deprecated at a future date. Its value is a URL that should provide further information about the deprecation.","type":"string"},"name":{"description":"Its value may be used as a secondary key for selecting link objects that share the same relation type.","type":"string"},"profile":{"description":"A URI that hints about the profile of the target resource.","type":"string"},"title":{"description":"Intended for labelling the link with a human-readable identifier","type":"string"},"hreflang":{"description":"Indicates the language of the target resource","type":"string"}},"required":["href"],"type":"object","$$ref":"#/components/schemas/TestSelfLink","example":{"href":"https://api.thousandeyes.com/v7/tests/{type}/281474976710706"}},"testResults":{"description":"Reference to the test results.","example":[{"href":"https://api.thousandeyes.com/v7/test-results/281474976710706/network"},{"href":"https://api.thousandeyes.com/v7/test-results/281474976710706/path-vis"}],"items":{"description":"A hyperlink from the containing resource to a URI.","properties":{"href":{"description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id","type":"string"},"templated":{"description":"Should be true when the link object's \"href\" property is a URI template.","type":"boolean"},"type":{"description":"Used as a hint to indicate the media type expected when dereferencing the target resource.","type":"string"},"deprecation":{"description":"Its presence indicates that the link is to be deprecated at a future date. Its value is a URL that should provide further information about the deprecation.","type":"string"},"name":{"description":"Its value may be used as a secondary key for selecting link objects that share the same relation type.","type":"string"},"profile":{"description":"A URI that hints about the profile of the target resource.","type":"string"},"title":{"description":"Intended for labelling the link with a human-readable identifier","type":"string"},"hreflang":{"description":"Indicates the language of the target resource","type":"string"}},"required":["href"],"type":"object","$$ref":"#/components/schemas/Link"},"type":"array"}},"readOnly":true,"type":"object","$$ref":"#/components/schemas/TestLinks"},"labels":{"items":{"example":{"labelId":"961","name":"Artem label","isBuiltin":false},"properties":{"labelId":{"description":"Label ID.","type":"string"},"name":{"description":"Name of the label.","type":"string"},"isBuiltin":{"description":"Value indicating if the label in question is BuiltIn (Account Admin, Organization Admin, Regular User).","type":"boolean"}},"type":"object","$$ref":"#/components/schemas/TestLabel"},"readOnly":true,"type":"array","$$ref":"#/components/schemas/TestLabels"},"sharedWithAccounts":{"items":{"properties":{"aid":{"description":"Account group ID.","example":"1234","type":"string"},"name":{"description":"Account group name.","example":"Account name","type":"string"}},"type":"object","$$ref":"#/components/schemas/SharedWithAccount"},"readOnly":true,"type":"array","$$ref":"#/components/schemas/TestSharedAccounts"},"authType":{"default":"none","description":"HTTP authentication type.","enum":["none","basic","ntlm","kerberos","oauth"],"example":"none","type":"string","$$ref":"#/components/schemas/TestAuthType"},"agentInterfaces":{"properties":{"ipAddress":{"description":"IP address of the agent interface.","example":"192.1.1.0","type":"string"},"agentId":{"description":"The agent ID of the enterprise agent for the test.","example":"2954","type":"string"}},"type":"object","$$ref":"#/components/schemas/AgentInterfaces"},"bandwidthMeasurements":{"description":"Set to `true` to enable bandwidth measurements, only applies to Enterprise agents assigned to the test.","example":true,"type":"boolean"},"clientCertificate":{"description":"String representation (containing newline characters) of client certificate, the private key must be placed first, then the certificate.","example":"-----BEGIN PRIVATE KEY-----\nMIICUTCCAfugAwIBAgIBADANBgkqhkiG9w0BAQQFADBXMQswCQYDVQQGEwJDTjEL\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE-----\nMIICUTCCAfugAwIBAgIBADANBgkqhkiG9w0BAQQFADBXMQswCQYDVQQGEwJDTjEL\n-----END CERTIFICATE-----\n","type":"string"},"contentRegex":{"description":"Content regex, this field does not require escaping.","example":"(regex)+","type":"string"},"customHeaders":{"example":{"root":{"header1":"value1"},"domains":{"domain1.com":{"header2":"value2"}},"all":{"header3":"value3"}},"properties":{"root":{"additionalProperties":{"type":"string"},"description":"Use these HTTP headers for root server request.","type":"object"},"domains":{"additionalProperties":{"additionalProperties":{"type":"string"},"type":"object"},"description":"Use these HTTP headers for the specified domains.","type":"object"},"all":{"additionalProperties":{"type":"string"},"description":"Use these HTTP headers for all domains.","type":"object"}},"type":"object","$$ref":"#/components/schemas/TestCustomHeaders"},"desiredStatusCode":{"default":"default","description":"Specify the HTTP status code value that indicates a successful response. The default value accepts any 2xx or 3xx status code.","example":"200","type":"string"},"downloadLimit":{"description":"Specifies maximum number of bytes to download from the target object.","example":2048,"type":"integer"},"dnsOverride":{"description":"IP address to use for DNS override.","example":"8.8.8.8","format":"ipv4","type":"string"},"httpTargetTime":{"description":"Target time for HTTP server completion, specified in milliseconds.","example":100,"maximum":5000,"minimum":100,"type":"integer"},"httpTimeLimit":{"default":5,"description":"HTTP time limit in seconds.","example":5,"maximum":60,"minimum":5,"type":"integer"},"httpVersion":{"default":2,"description":"HTTP protocol version. Set to '2' to prefer HTTP/2, or '1' to use only HTTP/1.1.","example":2,"maximum":2,"minimum":1,"type":"integer"},"includeHeaders":{"default":true,"description":"Set to `true` to capture response headers for objects loaded by the test.","example":true,"type":"boolean"},"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"},"oAuth":{"description":"Use this only if you want to use OAuth as the authentication mechanism.","example":{"configId":"123321123","testUrl":"https://api.thousandeyes.com/v7/status","requestMethod":"get","postBody":"client_id: ************","headers":"Authorization: Basic ************","authType":"none","username":"user123","password":"*******"},"properties":{"configId":{"description":"The ID of the OAuth configuration.","type":"string"},"testUrl":{"description":"Target for the test.","example":"www.thousandeyes.com","type":"string"},"requestMethod":{"description":"HTTP request method.","enum":["get","post","put","delete","patch","options","trace"],"example":"get","type":"string","$$ref":"#/components/schemas/RequestMethod"},"postBody":{"description":"Enter the OAuth body for the HTTP POST request in this field when using OAuth as the authentication mechanism. No special escaping is required. If content is provided in the post body, the `requestMethod` is automatically set to POST.","type":"string"},"headers":{"description":"Request headers used for OAuth.","type":"string"},"authType":{"default":"none","description":"HTTP authentication type.","enum":["none","basic","ntlm","kerberos","oauth"],"example":"none","type":"string","$$ref":"#/components/schemas/TestAuthType"},"username":{"description":"OAuth username","type":"string"},"password":{"description":"OAuth password","type":"string"}},"type":"object","$$ref":"#/components/schemas/OAuth"},"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"},"sslVersion":{"description":"Reflects the verbose SSL protocol version used by a test.","example":"Auto","readOnly":true,"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"},"url":{"description":"Target for the test.","example":"www.thousandeyes.com","type":"string"},"useNtlm":{"description":"Set to true to use NTLM, false to use Basic Authentication. Requires username and password to be set.","example":false,"type":"boolean"},"userAgent":{"description":"User-agent string to be provided during the test.","example":"curl","type":"string"},"username":{"description":"Username for Basic/NTLM authentication.","example":"username","type":"string"},"verifyCertificate":{"default":false,"description":"Ignore or acknowledge certificate errors. Set to false to ignore certificate errors.","example":false,"type":"boolean"},"allowUnsafeLegacyRenegotiation":{"default":true,"description":"Allows TLS renegotiation with servers not supporting RFC 5746. Default Set to true to allow unsafe legacy renegotiation.","example":true,"type":"boolean"},"followRedirects":{"default":true,"description":"To disable following HTTP/301 or HTTP/302 redirect directives, set this parameter to `false`.","example":true,"type":"boolean"},"fixedPacketRate":{"description":"Sets packets rate sent to measure the network in packets per second.","example":50,"maximum":100,"minimum":0,"type":"integer"},"overrideAgentProxy":{"default":false,"description":"Flag indicating if a proxy other than the default should be used. To override the default proxy for agents, set to `true` and specify a value for `overrideProxyId`.","example":false,"type":"boolean"},"overrideProxyId":{"description":"ID of the proxy to be used if the default proxy is overridden.","example":"281474976710706","type":"string"},"collectProxyNetworkData":{"default":false,"description":"Indicates whether network data to the proxy should be collected.","example":false,"type":"boolean"},"headers":{"description":"HTTP request headers used.","example":["header1: value1","header2: value2"],"items":{"type":"string"},"type":"array","$$ref":"#/components/schemas/TestHeaders"},"randomizedStartTime":{"default":false,"description":"Indicates whether agents should randomize the start time in each test round.","example":false,"type":"boolean","$$ref":"#/components/schemas/TestRandomizedStartTime"},"postBody":{"description":"Enter the body for the HTTP POST request in this field. No special escaping is necessary. If the post body is provided with content, the `requestMethod` is automatically set to POST.","example":"{ \"example\" : \"value\"}","type":"string"},"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"},"agents":{"description":"Contains list of agents.","items":{"properties":{"agentType":{"description":"Type of the agent.","enum":["cloud","enterprise-cluster","enterprise"],"example":"enterprise-cluster","readOnly":true,"type":"string","$$ref":"#/components/schemas/CloudEnterpriseAgentType"},"ipAddresses":{"description":"Array of private IP addresses.","example":["99.139.65.220","9bbd:8a0a:a257:5876:288b:6cb2:3f36:64ce"],"items":{"type":"string"},"readOnly":true,"type":"array"},"publicIpAddresses":{"description":"Array of public IP addresses.","example":["192.168.1.78","f9b2:3a21:f25c:d300:03f4:586d:f8d6:4e1c"],"items":{"type":"string"},"readOnly":true,"type":"array"},"network":{"description":"Network (including ASN) of agent’s public IP.","example":"AT&T Services, Inc. (AS 7018)","readOnly":true,"type":"string"},"agentId":{"description":"Unique ID of the agent.","example":"281474976710706","readOnly":true,"type":"string"},"agentName":{"description":"Name of the agent.","example":"thousandeyes-stg-va-254","type":"string"},"location":{"description":"Location of the agent.","example":"San Francisco Bay Area","readOnly":true,"type":"string"},"countryId":{"description":"2-digit ISO country code","example":"US","readOnly":true,"type":"string"},"enabled":{"description":"Flag indicating if the agent is enabled.","example":true,"type":"boolean"},"prefix":{"description":"Prefix containing agents public IP address.","example":"99.128.0.0/11","readOnly":true,"type":"string"},"verifySslCertificates":{"description":"Flag indicating if has normal SSL operations or if instead it's set to ignore SSL errors on browserbot-based tests.","example":true,"readOnly":true,"type":"boolean"}},"required":["agentType"],"type":"object","$$ref":"#/components/schemas/AgentResponse"},"type":"array","$$ref":"#/components/schemas/TestAgentsResponse"}},"type":"object","$$ref":"#/components/schemas/HttpServerInstantTestResponse","required":["url"],"title":"HttpServerInstantTestResponse"}}