{"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":"api","readOnly":true,"type":"string","$$ref":"#/components/schemas/TestType"},"_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"},"collectProxyNetworkData":{"default":false,"description":"Indicates whether network data to the proxy should be collected.","example":false,"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"},"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"},"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"},"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"},"predefinedVariables":{"items":{"properties":{"name":{"description":"Variable name. Must be unique.","example":"myUsername","type":"string"},"value":{"description":"Variable value, will be treated as string.","example":"ThousandEyesAccountUserName","type":"string"}},"type":"object","$$ref":"#/components/schemas/ApiPredefinedVariable"},"type":"array"},"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"},"requests":{"items":{"properties":{"assertions":{"description":"List of assertion objects.","items":{"properties":{"name":{"description":"Set to `status-code` to assert the response status code. Set to `response-body` to assert data is present in the response body. Use `ApiRequestAssertion` to set the value for the assertion.","enum":["status-code","response-body"],"example":"status-code","type":"string","$$ref":"#/components/schemas/ApiRequestAssertionName"},"operator":{"description":"If `name = status-code``, accepted values are [is, is-not]. If `name = response-body``, accepted values are [includes, not-includes]`.","enum":["is","is-not","includes","not-includes"],"example":"is","type":"string","$$ref":"#/components/schemas/ApiRequestAssertionOperator"},"value":{"description":"The value of the assertion. If name = `status-code`, the status code to assert. If name = `response-body`, the lookup value to assert.","example":"200","type":"string"}},"type":"object","$$ref":"#/components/schemas/ApiRequestAssertion"},"type":"array"},"authType":{"default":"none","description":"Will override the Authorization request header.","enum":["none","basic","bearer-token","oauth2"],"example":"none","type":"string","$$ref":"#/components/schemas/ApiRequestAuthType"},"bearerToken":{"description":"The bearer token if `authType = bearer-token`.","example":"abcd-1234-...","type":"string","writeOnly":true},"body":{"description":"POST/PUT request body. Must be in JSON format.","type":"string"},"clientAuthentication":{"description":"The OAuth2 client authentication location type.","enum":["basic-auth-header","in-body"],"example":"basic-auth-header","type":"string","$$ref":"#/components/schemas/ApiClientAuthentication"},"clientId":{"description":"The application ID used when `authType` is set to \"oauth2\".","example":"client-id","type":"string","writeOnly":true},"clientSecret":{"description":"The private client secret used when `authType` is set to \"oauth2\".","example":"client-secret","type":"string","writeOnly":true},"collectApiResponse":{"default":true,"description":"Set to `true` if API response body should be collected and saved. Set to `false` if API response body should not be saved.","example":true,"type":"boolean"},"headers":{"description":"Array of API Request Header objects.","items":{"properties":{"key":{"description":"Request header key.","example":"x-custom-header","type":"string"},"value":{"description":"Request header value. Supports variables `{{variableName}}`.","example":"keep-alive","type":"string"}},"type":"object","$$ref":"#/components/schemas/ApiRequestHeader"},"type":"array"},"method":{"description":"HTTP request method.","enum":["get","post","put","delete","patch"],"example":"get","type":"string","$$ref":"#/components/schemas/ApiRequestMethod"},"name":{"description":"API step name, must be unique.","example":"Step 1","type":"string"},"password":{"description":"The password if `authType = basic`.","example":"basic_pw123","type":"string","writeOnly":true},"scope":{"description":"Application-specific scope values for the access token when `authType` is \"oauth2\".","example":"read, write, deploy","type":"string"},"tokenUrl":{"description":"The endpoint used to request the access token when `authType` is \"oauth2\".","example":"https://id.cisco.com/oauth2/default/v1/token","type":"string"},"url":{"description":"Request url. Supports variables in the format `{{variableName}}`.","example":"https://api.thousandeyes.com/v7/status","type":"string"},"username":{"description":"The username if `authType = basic`.","example":"ThousandEyesUserName","type":"string"},"variables":{"description":"Array of API post request variable objects.","items":{"properties":{"name":{"description":"Variable name","example":"myTestName","type":"string"},"value":{"description":"The JSON path of data within the Response Body to assign to this variable.","example":"tests[0].name","type":"string"}},"type":"object","$$ref":"#/components/schemas/ApiRequestVariable"},"type":"array"},"waitTimeMs":{"description":"Post request delay before executing the next API requests, in milliseconds.","example":0,"type":"integer"}},"required":["name","url"],"type":"object","$$ref":"#/components/schemas/ApiRequest"},"type":"array"},"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"},"targetTime":{"description":"Target time for completion metric, defaults to 50% of time limit specified in seconds. (0 means default behavior)","example":1,"maximum":60,"minimum":0,"type":"integer"},"timeLimit":{"default":30,"description":"Time limit for transaction in seconds. Exceeding this limit will result in a Timeout error.","maximum":180,"minimum":5,"type":"integer"},"url":{"description":"Target for the test.","example":"www.thousandeyes.com","type":"string"},"credentials":{"description":"Contains a list of credential IDs (get `credentialId` from `/credentials` endpoint).","example":["3247","1051"],"items":{"type":"string"},"type":"array","$$ref":"#/components/schemas/TestCredentials"},"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/ApiInstantTestResponse","required":["requests","url"],"title":"ApiInstantTestResponse"}}