Skip to Content
SeyloDocs
API referenceDatabases

Open a database shell

POST
/api/v1/databases.openShell

Returns a ticket for a terminal already signed in to the database (psql, mysql, mongosh, redis-cli). The web app passes it to the terminal socket; it works once and expires in a minute.

Needs databases.tools on the service (a grant on its project covers it). Not available to MCP clients or the assistant.

Authorization

cookieseylo_session<token>

Request Body

application/json
  1. body
serviceId*string

Panel-issued id.

Match^[a-z0-9]{16}$

Response Body

Success.

application/json
  1. response
ticket*string
socketPath*string
client*string
expiresAt*string
Formatdate-time
Example Request
curl -X POST 'https://example.com/api/v1/databases.openShell' \  -H 'Content-Type: application/json' \  -d '{  "serviceId": "string"}'
Example Response
{  "ticket": "string",  "socketPath": "string",  "client": "string",  "expiresAt": "2019-08-24T14:15:22Z"}

Get a database GET

Returns a database's engine, node, internal address, exposure and web UI state, without passwords. Needs `services.view` on the service (a grant on its project covers it). Available to MCP clients and the assistant.

Open the database web UI POST

Returns a one-time link to the database's web UI (pgweb, Adminer, mongo-express or Redis Commander), already signed in. The tool starts on first use and stops when idle. Needs `databases.tools` on the service (a grant on its project covers it). Not available to MCP clients or the assistant.