Rerun a synthetic monitor execution in Dynatrace with the Synthetic API by providing the on-demand execution ID in the path.
| POST | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/synthetic/v1/executions/{execution-id} |
You use the execution-id endpoint to rerun the specified on-demand synthetic monitor execution. The path parameter execution-id identifies the execution to rerun, and the operation returns success when the rerun starts.
To execute this request, you need a platform token or OAuth access token with synthetic:monitors:execute scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| execution-id | integer | The ID of the on-demand execution. | path | Required |
| Code | Type | Description |
|---|---|---|
| 200 | Synthetic | Success |
| 4XX | Error | Client side error. |
| 5XX | Error | Server side error. |
SyntheticOnDemandExecutionResponse objectThe result of on-demand synthetic monitor execution.
| Element | Type | Description |
|---|---|---|
| batchId | string | The batch identifier of the triggered executions. |
| triggered | Synthetic | Monitors for which on-demand executions were triggered. |
| triggeredCount | integer | The total number of the triggered executions within the batch. |
| triggeringProblemsCount | integer | The total number of problems within the batch. |
| triggeringProblemsDetails | Synthetic | List with the entities for which triggering problems occurred. |
SyntheticOnDemandTriggeredMonitorResponse objectContains the list of on-demand executions of the monitor.
| Element | Type | Description |
|---|---|---|
| executions | Synthetic | The list of triggered executions. |
| monitorId | string | The monitor identifier. |
SyntheticOnDemandTriggeredExecutionDetailsResponse objectContains details of the triggered on-demand execution.
| Element | Type | Description |
|---|---|---|
| executionId | string | The execution's identifier. |
| locationId | string | The identifier of the location from which the monitor is to be executed. |
SyntheticOnDemandTriggeringProblemDetailsResponse objectContains the details of problems encountered while triggering on-demand executions.
| Element | Type | Description |
|---|---|---|
| cause | string | The cause of not triggering entity. |
| details | string | The details of triggering problem. |
| executionId | string | The execution identifier. |
| id | string | The entity identifier. |
| locationId | string | The location identifier. |
ErrorResponseEnvelope objectEncloses the encountered error.
| Element | Type | Description |
|---|---|---|
| error | Error | Basic information of the encountered error. |
ErrorResponse objectBasic information of the encountered error.
| Element | Type | Description |
|---|---|---|
| code | integer | The returned HTTP status code. |
| details | Error | Detailed information of the error. |
| message | string | Description of the encountered error. |
ErrorResponseDetails objectDetailed information of the error.
| Element | Type | Description |
|---|---|---|
| type | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
|
{"batchId": "22396514015719218","triggered": [{"executions": [{"executionId": "1069999568093682590","locationId": "SYNTHETIC_LOCATION-9BB04DAE11123122"}],"monitorId": "HTTP_MONITOR-69A9B98E1CD87352"}],"triggeredCount": 1,"triggeringProblemsCount": 4,"triggeringProblemsDetails": [{"cause": "Location not found","id": "HTTP_MONITOR-6349B98E1CD87352","locationId": "SYNTHETIC_LOCAT-9BB04DAEBA71B8CA"},{"cause": "Monitor not found","id": "HTTP_MONITOR-6349B98E1CD85432"},{"cause": "Incorrect monitor identifier format","id": "HTTP_HACK-AAAAAAA"},{"cause": "Incorrect application identifier format","id": "APPLICATION-WRONG"}]}
{"error": {"code": 1,"details": {"type": "constraintViolation"},"message": "string"}}