Skip to main content
POST
Sign in
Signs the user in. Send your FalkorDB Cloud credentials as a JSON body. The response sets two HttpOnly cookies that authorize every other endpoint.

Body

string
required
The email address of your FalkorDB Cloud account.
string
required
The password of your FalkorDB Cloud account.

Response

Cookies

string
required
Session JWT. Send it on every subsequent request. Expires after 1 hour (Max-Age=3600).
string
required
Refresh token used to obtain a new session token. Expires after 24 hours (Max-Age=86400).
Both cookies are issued with the following attributes:
200 OK
Because the cookies are HttpOnly, your application cannot read or store them itself. Browser clients should send requests with credentials included; server-side and CLI clients should persist the Set-Cookie values and replay omnistrate_token as a Cookie header.
Browsers attach the cookies automatically as long as the request includes credentials:
Other clients must store the cookies and send them back. With curl, use a cookie jar:
Because the cookies are scoped to .falkordb.cloud, curl does not replay them to https://api.omnistrate.cloud. Read omnistrate_token out of the cookie jar and send it as an explicit Cookie header instead:

Session lifetime

The session token is valid for 1 hour. After it expires, use the refresh token to obtain a new session, or sign in again. The refresh token is valid for 24 hours; once it expires, the user must sign in with their credentials.

Errors

Error responses are JSON with a single message field: