/programs/{program_id}/frameworks/{framework_id}/recoverbetaRecover a deleted framework
Recovers a deleted framework within the 7-day deletion recovery period. The framework must have been soft deleted and not yet permanently deleted. Recovery restores the framework and its endpoints to an idle state. Connection strings remain valid after recovery. TTL frameworks become non-TTL frameworks after recovery.
To list deleted frameworks available for recovery, use GET /programs/{program_id}/frameworks?include_deleted=true.
Quick start
curl "https://api.optitech.com/v1/programs/$PROGRAM_ID/frameworks/$FRAMEWORK_ID/recover" \
-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.recoverProjectBranch({
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
Response
200Recovered 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.