Cloady Docs
API ReferenceEndpointsApplications

Cancel a session's query or terminate the session

Cancels the statement a session is running (`mode=cancel`) or ends its connection (`mode=terminate`, the default): pg_cancel_backend or pg_terminate_backend, KILL QUERY or KILL, killOp on MongoDB, KILL QUERY on ClickHouse. `sessionId` comes from streamEngineSessions.

DELETE
/api/workspaces/{workspaceSlug}/apps/{appSlug}/services/{serviceName}/engine/sessions/{sessionId}

Authorization

cloady
AuthorizationBearer <token>

Personal API token (cldy_…)

In: header

Path Parameters

workspaceSlug*string
appSlug*string
serviceName*string
sessionId*string
Lengthlength <= 100

Query Parameters

env?string

Value in

  • "production"
  • "preview"
  • "development"
region?string
mode?string
Default"terminate"

Value in

  • "cancel"
  • "terminate"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/workspaces/string/apps/string/services/string/engine/sessions/string"
{  "ended": true}

Read a database's connections and long-running sessions GET

Returns connections grouped by client, each mapped to the compose service it comes from where its address is a pod of the app, and the sessions running or holding a transaction for five seconds or more, waiting on a lock or blocking another, with their query text. Needs the developer role. Sending `Accept: text/event-stream` instead follows it live, a frame every five seconds.

Read a database's tables, sizes and unused indexes GET

Returns each database's size, the largest 100 tables or collections with rows, table and index bytes, dead tuples and vacuum state on Postgres and reclaimable space elsewhere, and the indexes nothing has used since the counters began. Names the schema, so it needs the developer role.