/programs/{program_id}/frameworks/{framework_id}/finalize_restoreFinalize framework restore from snapshot
Finalize the restore operation for a framework created from a snapshot. This operation updates the framework so it functions as the original framework it replaced. This includes:
- Reassigning any computes from the original framework to the restored framework (this will restart the computes)
- Renaming the restored framework to the original framework's name
- Renaming the original framework so it no longer uses the original name
This operation only applies to frameworks created using the restoreSnapshot endpoint with finalize_restore: false.
Note: This endpoint is currently in Beta.
Quick start
curl "https://api.optitech.com/v1/programs/$PROGRAM_ID/frameworks/$FRAMEWORK_ID/finalize_restore" \
-X POST \
-H "Authorization: Bearer $OPTITECH_API_KEY"Every field below is optional. An empty body works too.
import { createOptiTechClient, raw } from '@optitech/sdk';
const optitech = createOptiTechClient({ apiKey: process.env.OPTITECH_API_KEY });
const { data } = await raw.finalizeRestoreBranch({
client: optitech.client,
path: {
program_id: process.env.PROGRAM_ID,
framework_id: process.env.FRAMEWORK_ID
}
});Parameters
program_idThe OptiTech program ID
framework_idThe framework ID
Request body
No field is required. Send an empty body to use sensible defaults.
nameused to rename the existing framework when it is replaced. if omitted, a default name is generated and used
Response
200OK
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.