Get the configured backup repository for a documentation

Documentation Backup Get the configured backup repository for a documentation

GET

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

Authentication

API Key (BearerAuth)

Header: Authorization

Path Parameters

organization_idstringrequired

Organization ID

documentation_idstringrequired

Documentation ID

Responses

200

Response Fields:

branch (string)
documentation_id (string)
path (string)
repository (object)

Example:

{
  "branch": "string",
  "documentation_id": "string",
  "path": "string",
  "repository": {
    "branches": [
      "string"
    ],
    "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
  }
}

404

Not Found

Example:

{
  "key": "value"
}