Skip to main content

RetryPolicy

RetryPolicy controls how failed executions are retried.

Usage profiles​

UsageFields and validation
In requestsView fields
In responsesView fields

In requests​

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
maxAttemptsinteger (int32)OptionalMaximum delivery attempts (including the initial attempt). Default 10. Minimum: -2147483648. Maximum: 2147483647.
initialBackoffMsinteger (int32)OptionalInitial backoff before the first retry, in milliseconds. Default 5000. Minimum: -2147483648. Maximum: 2147483647.
maxBackoffMsinteger (int32)OptionalMaximum backoff cap, in milliseconds. Default 1800000 (30 min). Minimum: -2147483648. Maximum: 2147483647.

In responses​

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
maxAttemptsinteger (int32)OptionalMaximum delivery attempts (including the initial attempt). Default 10. Minimum: -2147483648. Maximum: 2147483647.
initialBackoffMsinteger (int32)OptionalInitial backoff before the first retry, in milliseconds. Default 5000. Minimum: -2147483648. Maximum: 2147483647.
maxBackoffMsinteger (int32)OptionalMaximum backoff cap, in milliseconds. Default 1800000 (30 min). Minimum: -2147483648. Maximum: 2147483647.

Where used​

ReferenceRelationship
Create a scheduled jobPOST /api/v1/scheduler/create-job
Update a scheduled jobPOST /api/v1/scheduler/update-job
Get a scheduled jobPOST /api/v1/scheduler/get-job
List scheduled jobsPOST /api/v1/scheduler/list-jobs
Pause a scheduled jobPOST /api/v1/scheduler/pause-job
Resume a scheduled jobPOST /api/v1/scheduler/resume-job
ScheduleNested in model

Download the public reference contract.

Document: DOC-API-MODEL-retry-policy.