/programs/{program_id}/frameworks/{framework_id}/restoreRestore framework to a historical state
Restores a framework to an earlier state in its own or another framework's history by specifying an LSN or timestamp. Creates a new framework from the historical state.
Quick start
curl "https://api.optitech.com/v1/programs/$PROGRAM_ID/frameworks/$FRAMEWORK_ID/restore" \
-X POST \
-H "Authorization: Bearer $OPTITECH_API_KEY"optitech branches restore <id|name>Parameters
program_idThe OptiTech program ID
framework_idThe framework ID
Request body
1 required Required: source_branch_id.
source_branch_idThe framework_id of the restore source framework.
If source_timestamp and source_lsn are omitted, the framework will be restored to head.
If source_branch_id is equal to the framework's id, source_timestamp or source_lsn is required.
source_lsnA Log Sequence Number (LSN) on the source framework. The framework will be restored with data from this LSN.
source_timestampA timestamp identifying a point in time on the source framework. The framework will be restored with data starting from this point in time.
The timestamp must be provided in ISO 8601 format; for example: 2024-02-26T12:00:00Z.
preserve_under_nameIf not empty, the previous state of the framework will be saved to a framework with this name.
If the framework has children or the source_branch_id is equal to the framework id, this field is required. All existing child frameworks will be moved to the newly created framework under the name preserve_under_name.
Response
200Updated the specified framework
Errors
General error
This endpoint can return the standard OptiTech API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
Retry guidance
If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.
Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.
Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.