curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows/executions/{executionId}/retry \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"authentication": {
"nonce": "hOfy4Zop4N2SPRfl"
}
}
'{
"id": "059edaa4-a17a-4102-910e-2c3591500cce",
"workflowExternalId": "<string>",
"status": "RUNNING",
"engineExecutionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdTime": 1730204346000,
"metadata": {},
"version": "<string>",
"startTime": 1730204346000,
"endTime": 1730204346000,
"reasonForIncompletion": "<string>"
}Retry workflow execution
Required capabilities:
workflowOrchestrationACL:WRITE
This endpoint restarts a previously failed, timed out, or terminated workflow execution by retrying tasks that did not complete successfully. It aims to resume execution activity from the point(s) of failure.
Behavior of the retry operation:
- Targeted Task Retry: Only retries tasks that have stopped in a terminal state such as
CANCELED,FAILED,FAILED_WITH_TERMINAL_ERROR, andTIMED_OUT. Optional tasks are not retried. - Subworkflows and Dynamic Tasks: When a failure occurs within a subworkflow or as part of a dynamic task, only the individual nested tasks that failed are retried. The subworkflow or dynamic task container itself is not retried.
- Retry Limits: Tasks that have reached or exceeded their designated retry limits will not have their retry counts reset to zero. Instead, each retry request permits these tasks a single additional retry.
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows/executions/{executionId}/retry \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"authentication": {
"nonce": "hOfy4Zop4N2SPRfl"
}
}
'{
"id": "059edaa4-a17a-4102-910e-2c3591500cce",
"workflowExternalId": "<string>",
"status": "RUNNING",
"engineExecutionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdTime": 1730204346000,
"metadata": {},
"version": "<string>",
"startTime": 1730204346000,
"endTime": 1730204346000,
"reasonForIncompletion": "<string>"
}Authorizations
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Path Parameters
UUIDv4 identifier for a workflow execution.
36"059edaa4-a17a-4102-910e-2c3591500cce"
Body
Show child attributes
Show child attributes
Response
Updated workflow execution
UUIDv4 identifier for a workflow execution.
36"059edaa4-a17a-4102-910e-2c3591500cce"
Identifier for a workflow. Must be unique for the project. No trailing or leading whitespace and no null characters allowed.
255RUNNING, COMPLETED, FAILED, TIMED_OUT, TERMINATED Additional UUIDv4 identifier for an execution. Useful for Cognite support to diagnose issues.
36The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
Custom, application-specific metadata. String key -> String value. Keys have a maximum length of 32 characters, values a maximum of 255, and there can be a maximum of 10 key-value pairs.
Show child attributes
Show child attributes
Identifier for a version. Must be unique for the workflow. No trailing or leading whitespace and no null characters allowed.
255The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
Human-readable reason for terminal failure of a workflow task.
Was this page helpful?