Documentation Backup Restore a documentation from a previous backup

Pulls the saved backup at the given branch/path (or the saved config defaults) and applies it to the documentation. Mode "replace" wipes the doc before applying, "merge" upserts on top.

POST
/control-plane/api/v1/v1/documentation/{organization_id}/{documentation_id}/backup/restore

Authentication

API Key (BearerAuth)

  • Header: Authorization

Path Parameters

organization_idstringrequired

Organization ID


documentation_idstringrequired

Documentation ID


Request Body

Restore options

backup_idstringrequired

modestring

Example:

{
  "backup_id": "string",
  "mode": "string"
}

Responses

200
OK

Response Fields:

  • branch (string)

  • file_count (integer)

  • path (string)

Example:

{
  "branch": "string",
  "file_count": 0,
  "path": "string"
}