POST
/canary/{name}/runs
http://synthetics.{region}.amazonaws.com/canary/{name}/runsRetrieves a list of runs for a specified canary.
Access Token Required: API Key
Path Parameters
namestringrequired
The name of the canary that you want to see runs for.
Query Params
MaxResultsstring
Pagination limit
NextTokenstring
Pagination token
Body Params
NextTokenstring
A token that indicates that there is more data available. You can use this token in a subsequent <code>GetCanaryRuns</code> operation to retrieve the next set of results.
MaxResultsinteger
Specify this parameter to limit how many runs are returned each time you use the <code>GetCanaryRuns</code> operation. If you omit this parameter, the default of 100 is used.
Responses
{
"success": true,
"data": {
"id": "abc123",
"created_at": "2025-01-01T00:00:00Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters"
}
}Language
CredentialsAPI KEY
API Key
Enter token below to save for later
cURL Request
1curl --request POST \2 --url 'http://synthetics.{region}.amazonaws.com/canary/{name}/runs' \3 --header 'accept: application/json' \4 --header 'content-type: application/json'Response
1{2 "success": true,3 "data": {4 "id": "abc123",5 "created_at": "2025-01-01T00:00:00Z"6 }7}