Backs up the documentation to the configured backup repository. If a body is supplied, it overrides the saved configuration; otherwise the saved backup repository is used.
POST
/control-plane/api/v1/v1/documentation/{organization_id}/{documentation_id}/backup
Authentication
API Key (BearerAuth)
Header:
Authorization
Path Parameters
organization_idstringrequired
Organization ID
documentation_idstringrequired
Documentation ID
Request Body
Backup request (optional)
author_emailstring
author_namestring
branchstring
commit_messagestring
pathstring
repository_idstringrequired
resource_idstringrequired
Example:
{
"author_email": "string",
"author_name": "string",
"branch": "string",
"commit_message": "string",
"path": "string",
"repository_id": "string",
"resource_id": "string"
}Responses
200
OK
Response Fields:
branch(string)commit_sha(string)file_count(integer)path(string)
Example:
{
"branch": "string",
"commit_sha": "string",
"file_count": 0,
"path": "string"
}