{"type":"model","meta":{"id":"/apps/pubhub/media/000-v7-apis/5b3454a4300b838cc17f7b2cdc0690fdd15058d5/262f51cf-d740-393c-acce-a17156db9cc4","info":{"description":"\nYou can create and execute a new endpoint instant scheduled test within ThousandEyes using this API. The test parameters are specified in the `POST` data.\n\nThe following applies to the Endpoint Instant Scheduled Tests API:\n\n* To initiate the creation and execution of an instant scheduled test, the user must possess the `Edit endpoint tests` permission.\n\n* Upon successful creation of an instant scheduled test, the API responds with an HTTP/201 CREATED status code and return the test definition.\n* It's important to note that the response does not include the results of the instant scheduled test. To retrieve test results, users can utilize the Endpoint Test Data endpoints.\nThe URLs for these API test data endpoints are provided within the test definition output when an instant scheduled test is created.\n","title":"Endpoint Instant Scheduled Tests API","version":"7.0.34"},"security":[{"BearerAuth":[]}],"tags":[{"name":"Agent to Server Endpoint Instant Scheduled Tests"},{"name":"HTTP Server Endpoint Instant Scheduled Tests"},{"name":"Run Endpoint Instant Scheduled 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":{"aid":{"description":"A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint.","example":"1234","type":"string"},"_links":{"description":"A list of links that can be accessed to get more information.","properties":{"self":{"description":"A hyperlink from the containing resource to a URI.","example":{"href":"https://api.thousandeyes.com/v7/endpoint/tests/{type}/281474976710706"},"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/EndpointTestSelfLink"},"testResults":{"description":"Reference to the test results.","example":[{"href":"https://api.thousandeyes.com/v7/endpoint/test-results/scheduled-tests/281474976710706/network/filter"},{"href":"https://api.thousandeyes.com/v7/endpoint/test-results/scheduled-tests/281474976710706/pathvis"}],"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/EndpointTestLinks"},"agentSelectorConfig":{"description":"Agents selection object based on agentSelectorType.","discriminator":{"mapping":{"all-agents":"#/components/schemas/EndpointAllAgentsSelectorConfig","specific-agents":"#/components/schemas/EndpointSpecificAgentsSelectorConfig","agent-labels":"#/components/schemas/EndpointAgentLabelsSelectorConfig"},"propertyName":"agentSelectorType"},"oneOf":[{"description":"Any agent selection object.","properties":{"agentSelectorType":{"example":"all-agents","pattern":"^all-agents$","type":"string"},"maxMachines":{"default":25,"description":"Maximum number of agents which can execute the test.","example":25,"type":"integer"}},"readOnly":true,"required":["agentSelectorType"],"type":"object","$$ref":"#/components/schemas/EndpointAllAgentsSelectorConfig"},{"description":"Agent labels selection object.","properties":{"agentSelectorType":{"example":"agent-labels","pattern":"^agent-labels$","type":"string"},"maxMachines":{"default":25,"description":"Maximum number of agents which can execute the test.","example":25,"type":"integer"},"endpointAgentLabels":{"description":"List of endpoint agent label IDs (obtained from `/endpoint/labels` endpoint), required when `agentSelectorType` is set to `agent-labels`.","example":["567","214"],"items":{"type":"string"},"type":"array"}},"readOnly":true,"required":["agentSelectorType"],"type":"object","$$ref":"#/components/schemas/EndpointAgentLabelsSelectorConfig"},{"description":"Specific agents selection object.","properties":{"agentSelectorType":{"example":"specific-agents","pattern":"^specific-agents$","type":"string"},"maxMachines":{"default":25,"description":"Maximum number of agents which can execute the test.","example":25,"type":"integer"},"agents":{"description":"List of endpoint agent IDs (obtained from `/endpoint/agents` endpoint). Required when `agentSelectorType` is set to `specific-agent`.","example":["0a3b9998-dc3a-4ff2-b50d-ac4a7cd986e1","66eec0f1-72b4-4755-aa83-3aed61d17f3c"],"items":{"format":"uuid","type":"string"},"type":"array"}},"readOnly":true,"required":["agentSelectorType"],"type":"object","$$ref":"#/components/schemas/EndpointSpecificAgentsSelectorConfig"}],"readOnly":true,"required":["agentSelectorType"],"type":"object","$$ref":"#/components/schemas/EndpointAgentSelectorConfig"},"createdDate":{"description":"UTC created date (ISO date-time format).","example":"2022-07-17T22:00:54Z","format":"date-time","readOnly":true,"type":"string"},"interval":{"default":60,"description":"Interval between test runs in seconds.","enum":[60,120,300,600,900,1800,3600],"example":60,"type":"integer","$$ref":"#/components/schemas/TestInterval"},"isEnabled":{"default":true,"description":"Indicates if test is enabled.","example":true,"type":"boolean"},"isSavedEvent":{"description":"Indicates if the test is a saved event.","example":false,"readOnly":true,"type":"boolean"},"hasPathTraceInSession":{"description":"Enables \"in session\" path trace. When enabled, this option initiates a TCP session with the target server and sends path trace packets within the established TCP session.","example":true,"type":"boolean"},"modifiedDate":{"description":"UTC last modification date (ISO date-time format).","example":"2022-07-17T22:00:54Z","format":"date-time","readOnly":true,"type":"string"},"networkMeasurements":{"default":true,"description":"Enable or disable network measurements. Set to true to enable or false to disable network measurements.","example":true,"type":"boolean"},"protocol":{"default":"icmp","description":"Protocol requested for the test.","enum":["icmp","icmp-with-tcp-connect","tcp","prefer-tcp","ast-autodetect","autodetect"],"example":"icmp","type":"string","$$ref":"#/components/schemas/EndpointTestProtocol"},"ipVersion":{"description":"IP version the test should use for network tests.","enum":["V4_ONLY","V6_ONLY","V6_PREFER","OS_DEFAULT"],"example":"V4_ONLY","type":"string","$$ref":"#/components/schemas/EndpointIpVersionTemplate"},"server":{"description":"Target domain name or IP address.","example":"www.example.com","type":"string"},"testId":{"description":"Each test is assigned a unique ID to access test data from other endpoints.","example":"281474976710706","readOnly":true,"type":"string"},"testName":{"description":"Name of the test.","example":"Test name","type":"string"},"type":{"description":"Type of test being queried.","enum":["agent-to-server","http-server"],"example":"agent-to-server","readOnly":true,"type":"string","$$ref":"#/components/schemas/EndpointAgentToServerType","pattern":"^agent-to-server$"},"tcpProbeMode":{"default":"auto","description":"Probe mode used by network test, only valid when the protocol is set to TCP.","enum":["auto","sack","syn","unknown"],"example":"auto","type":"string","$$ref":"#/components/schemas/TestProbeModeResponse"},"port":{"default":443,"description":"Port number.","example":443,"type":"integer"},"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"}},"required":["type"],"type":"object","$$ref":"#/components/schemas/EndpointAgentToServerTest","title":"EndpointAgentToServerTest"}}