{"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":"dnssec","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":"string","$$ref":"#/components/schemas/TestLabel"},"readOnly":false,"type":"array","$$ref":"#/components/schemas/TestLabels","description":"A list of test label identifiers (get `labelId` from `/labels` endpoint).","example":["9842","1283"],"writeOnly":true},"sharedWithAccounts":{"items":{"properties":{"aid":{"description":"Account group ID.","example":"1234","type":"string"},"name":{"description":"Account group name.","example":"Account name","type":"string"}},"type":"string","$$ref":"#/components/schemas/SharedWithAccount"},"readOnly":false,"type":"array","$$ref":"#/components/schemas/TestSharedAccounts","description":"A list of account group identifiers that the test is shared with (get `aid` from `/account-groups` endpoint).","example":["1234","12345"],"writeOnly":true},"domain":{"description":"The target record for the test, with the record type suffixed. If no record type is specified, the test defaults to an ANY record.","example":"www.thousandeyes.com","type":"string"},"dnsQueryClass":{"description":"Domain class used by this test. 'in' stands for Internet, while 'ch' stands for Chaos.","enum":["in","ch"],"example":"in","type":"string","$$ref":"#/components/schemas/DnsQueryClass"},"randomizedStartTime":{"default":false,"description":"Indicates whether agents should randomize the start time in each test round.","example":false,"type":"boolean"},"agents":{"description":"A list of objects with `agentId` (required) and `sourceIpAddress` (optional).","items":{"example":{"agentId":"125","sourceIpAddress":"1.1.1.1"},"properties":{"agentId":{"description":"Identifier for the agent (get `agentId` from `/agents` endpoint).","type":"string"},"sourceIpAddress":{"description":"IP address from the agent's `ipAddresses` field (get `ipAddresses` from `/agents` endpoint). Used for interface selection.","type":"string"}},"type":"object","$$ref":"#/components/schemas/TestAgent"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/DnsSecInstantTestRequest","required":["domain","agents"],"title":"DnsSecInstantTestRequest"}}