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

Delete a server

Deletes a server. Rejected with 409 while the server fills a member slot of a database service or a DCS cluster (release it from its slot first), while a slot that it left is empty or waits for its rebuild (the rebuild needs its mesh address), while it hosts a LiveSync session, or while it hosts pgbackrest backup data; pass force=true to delete anyway with backup data (intended for dead or unreachable hosts): the stanza, repo, and binding rows referencing the server are removed and the on-disk backup data is abandoned. Without force, the console cleans a server first only when its recent reachability reading says that the server answers: the console stops and disables the database services on it and logs it out of the mesh. When such a server needs cleanup, the console runs the cleanup first, with the deletion of the PostgreSQL and etcd data of a slot that it left while unreachable: that runs as a workflow, the response is 202, and the console deletes the server when the workflow completes. A server that is unreachable, or that has no recent reachability reading, is deleted at once with 200, and the data on its disk stays.

DELETE/api/v1/servers/{id}
Authorization
tse_sessionAPI key · cookierequired
Path parameters
idstringrequired
Query parameters
forceboolean
Responses
200

OK

deletedbooleanrequired

true: the server is deleted. false: the cleanup workflow runs, and the console deletes the server when it completes.

workflow_idstring
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 DELETE 'https://console.example.com/api/v1/servers/string' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "deleted": true,
  "workflow_id": "string"
}