Documentation Backup List all backups for a documentation
GET
/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


Query Parameters

pageinteger

Page number (default 1)


page_sizeinteger

Page size (default 20, max 100)


Responses

200
OK

Response Fields:

  • items (object[])

  • page (integer)

  • page_size (integer)

  • total (integer)

  • total_pages (integer)

Example:

{
  "items": [
    {
      "branch": "string",
      "commit_message": "string",
      "commit_sha": "string",
      "documentation_id": "string",
      "id": "string",
      "page_count": 0,
      "path": "string",
      "repository": {
        "branches": [
          "..."
        ],
        "created_at": "string",
        "default_branch": "string",
        "description": "string",
        "external_id": "string",
        "full_name": "string",
        "id": "string",
        "installation_id": "string",
        "is_archived": true,
        "is_fork": true
      },
      "section_count": 0,
      "summary": {
        "versions": [
          "..."
        ]
      }
    }
  ],
  "page": 0,
  "page_size": 0,
  "total": 0,
  "total_pages": 0
}