{"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":{"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","title":"ApiRequest"}}