Qodex.ai

Create test snapshot

POST {{baseUrl}}/tests/:testId/snapshot?aid=1234

This endpoint creates a test snapshot based on the properties provided in the POST data.

  • To use this endpoint, you need the Create snapshot shares permission.
  • You can create a maximum of 5 snapshots per organization within a 5-minute interval.
  • Snapshots generated through this endpoint have a 30-day expiration period.
  • The time range specified with the from and to parameters must adhere to one of the following intervals: 1, 2, 4, 6, 12, 24, or 48 hours.
  • The endDate field of the snapshot must be set to the present or a past date.

Note: This endpoint does not support the creation of Endpoint Agent snapshots.

Request Params

KeyDatatypeRequiredDescription
aidnumberA unique identifier associated with your account group. You can retrieve your AccountGroupId from the /account-groups endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.

Request Body

{"displayName"=>"Snapshot created through API", "endDate"=>"2023-06-06T01:00:00Z", "startDate"=>"2023-06-06T00:00:00Z", "isPublic"=>false}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: Created

{"id":"wdiac","startRoundId":1538784000,"endRoundId":1538787600,"roundId":1538784000,"shareDate":"2023-06-06T00:00:00Z","sourceTestId":"281474976710706","testId":"281474976710801","uid":"281474976810911","displayName":"Snapshot created through API","extraParams":"params","test":{"interval":60,"alertsEnabled":true,"enabled":true,"createdBy":"user@user.com","createdDate":"2022-07-17T22:00:54Z","description":"ThousandEyes Test","liveShare":false,"modifiedBy":"user@user.com","modifiedDate":"2022-07-17T22:00:54Z","savedEvent":false,"testId":"281474976710706","testName":"ThousandEyes Test","type":"agent-to-server","_links":{"self":{"href":"https://api.thousandeyes.com/v7/tests/{type}/281474976710706"},"testResults":[{"href":"https://api.thousandeyes.com/v7/test-results/281474976710706/network"},{"href":"https://api.thousandeyes.com/v7/test-results/281474976710706/path-vis"}]}},"_links":{"self":{"href":"http://api.thousandeyes.com/v7/tests/227103/snapshot"},"appLink":{"href":"https://app.stg.thousandeyes.com/view/tests/?testId=227103\u0026__a=105"}}}