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

Log in as a local user

After 5 failed logins for one username (or 20 from one address), the login refuses it for 15 minutes. While an admin has turned off local login, the login answers 403.

POST/api/v1/login/password
Header parameters
X-Forwarded-Protostring
Request body
requiredapplication/json
accept_termsboolean

Accept the current terms version

passwordstring
usernamestring
Responses
200

OK

okbooleanrequired
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/login/password' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "accept_terms": true,
  "password": "string",
  "username": "string"
}'
Response
{
  "ok": true
}