Update history time to live

Updates history time to live for process definition. The field is used within History cleanup.


PUT /process-definition/{id}/history-time-to-live

PUT /process-definition/key/{key}/history-time-to-live (updates the latest version of the process definition which belongs to no tenant)

PUT /process-definition/key/{key}/tenant-id/{tenant-id}/history-time-to-live (updates the latest version of the process definition for tenant)


Path Parameters

Name Description
id The id of the process definition to change history time to live.

Request Body

A JSON object with the following properties:

Name Description
historyTimeToLive New value for historyTimeToLive field of process definition. Can be null. Can not be negative.


This method returns no content.

Response Codes

Code Media type Description
204 Request successful.
400 application/json Returned if some of the request parameters are invalid.
404 application/json Process definition with given id does not exist. See the Introduction for the error response format.



PUT /process-definition/aProcessDefinitionId/history-time-to-live

      "historyTimeToLive" : 5


Status 204. No content.

On this Page: