---
title: "A console session's state"
method: GET
path: "/databases/{databaseId}/console/{sessionId}"
tags: ["Databases"]
---

# A console session's state

`GET /databases/{databaseId}/console/{sessionId}`

## Request

- Base URL: `https://hostingsurge.com/api/v1`
- URL: `https://hostingsurge.com/api/v1/databases/{databaseId}/console/{sessionId}`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `__Host-hs_session`

## Path parameters

- `databaseId` string, uuid, required
- `sessionId` string, uuid, required

## Response `200`

Console session

- object
  - `id` string, uuid, required
  - `databaseId` string, uuid, required
  - `engine` 'postgresql' | 'mysql' | 'mariadb' | 'redis' | 'mongodb', required
  - `status` 'starting' | 'ready' | 'closed' | 'expired' | 'failed', required: starting: the console is connecting (the team's database tools may be starting, about a minute the first time); ready: statements run; closed/expired/failed: ended, open a new session
  - `mode` 'read' | 'write', required: read (default): the database refuses changes; write: statements may change data (needs databases:write)
  - `canWrite` boolean, required: the caller may switch this session to write mode
  - `preparing` boolean, required: the team's database tools are starting; the console connects on its own once they run
  - `serverVersion` string, nullable, required
  - `error` string, nullable, required
  - `endReason` 'closed' | 'idle' | 'lifetime' | 'worker_lost' | 'failed' | 'replaced' | 'unavailable' | 'null', nullable, required
  - `statements` integer, required: statements run in this session
  - `idleTimeoutSeconds` integer, required: the session ends after this long without a statement
  - `statementTimeoutSeconds` integer, required
  - `maxRows` integer, required: rows returned per result at most
  - `createdAt` string, required: ISO-8601 timestamp
  - `lastActivityAt` string, required: ISO-8601 timestamp
  - `expiresAt` string, required: the session ends at this time at the latest
  - `endedAt` string, nullable, required: ISO-8601 timestamp

## Other responses

- `400`: Invalid request (code invalid_request)
- `401`: Missing or invalid session/token (code unauthorized)
- `403`: Not permitted (code forbidden); details.sessionRequired: the console needs a dashboard session
- `404`: Not found or not visible to the caller (code not_found)
- `409`: Conflicting state (code conflict): details.preparing (the console is connecting, retry after details.retryAfterSeconds), details.busy (a statement is running), details.ended (open a new session), details.reason console_limit
- `429`: Too many requests (code rate_limited); see Retry-After
- `501`: Not available on this server (code not_configured)
- `503`: The console did not answer in time (code provider_unavailable)

---

[API](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api.md) · [All operations](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/revisions/4d08337cdff1?raw)