Skip to content
You're viewing documentation for v2026.11.14-beta. It may be out of date.Go to latest
TimescaleDB Enterprise
Esc
↑↓navigate↵open⌘Jpreview

Upload a restore archive

Streams the request body into the data volume. It needs a Content-Length, and the data volume must have the size and 1 GB more free (507). A new upload replaces the earlier one. The console removes the upload after the restore, and at each start.

POST/api/v1/console-backup/restore/uploads
Authorization
tse_sessionAPI key · cookierequired
Query parameters
file_namestringrequired

The name of the archive file

max length 255
Request body
requiredapplication/octet-stream
string<binary>
Responses
200

OK

file_namestringrequired
sizeinteger<int64>required
upload_idstringrequired
default

Error

codestring

Stable code of the refusal, when the route has codes

detailsstring[]

Additional detail, e.g. per-field validation failures

errorstringrequired

Human-readable error message

Request
curl -X POST 'https://console.example.com/api/v1/console-backup/restore/uploads?file_name=string' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/octet-stream' \
  -d 'string'
Response
{
  "file_name": "string",
  "size": 0,
  "upload_id": "string"
}