Skip to main content
POST
cURL
On-demand backup of a knowledge base.

Authorizations

Authorization
string
header
required

Timbal API key. Obtain your API key from the Timbal platform settings. See Authentication for more information.

Path Parameters

org_id
string
required
kb_id
string
required

Body

application/json
dry_run
boolean

When omitted or when the request has no JSON body, treated as false.

force
boolean

Create the backup even if the knowledge base is currently served by another host. Defaults to false, in which case such requests are rejected with 409 Conflict.

Response

Backup accepted

dry_run
boolean
required
id
string
required
kb_id
string
required
started_at
string<date-time>
required
status
string
required
triggered_by
string
required
bytes_uploaded
integer<int64> | null
completed_at
string<date-time> | null
error
string | null
expires_at
string<date-time> | null