These are the docs for the Metabase master branch. Some features documented here may not yet be available in the latest release. Check out the docs for the latest version, Metabase v0.51.
Session
/api/session endpoints.
DELETE /api/session/
Logout.
PARAMS:
metabase-session-id
GET /api/session/password_reset_token_valid
Check if a password reset token is valid and isn’t expired.
PARAMS:
tokenvalue must be a non-blank string.
GET /api/session/properties
Get all properties and their values. These are the specific Settings that are readable by the current user, or are
public if no user is logged in.
POST /api/session/
Login.
PARAMS:
-
usernamevalue must be a non-blank string. -
passwordvalue must be a non-blank string. -
request
POST /api/session/forgot_password
Send a reset email when user has forgotten their password.
PARAMS:
-
emailvalue must be a valid email address. -
request
POST /api/session/google_auth
Login with Google Auth.
PARAMS:
-
tokenvalue must be a non-blank string. -
request
POST /api/session/pulse/unsubscribe
Allow non-users to unsubscribe from pulses/subscriptions, with the hash given through email.
PARAMS:
-
emailstring. -
hashstring. -
pulse-idvalue must be an integer greater than zero. -
request
POST /api/session/pulse/unsubscribe/undo
Allow non-users to undo an unsubscribe from pulses/subscriptions, with the hash given through email.
PARAMS:
-
emailstring. -
hashstring. -
pulse-idvalue must be an integer greater than zero. -
request
POST /api/session/reset_password
Reset password with a reset token.
PARAMS:
-
tokenvalue must be a non-blank string. -
passwordpassword is too common. -
request
Read docs for other versions of Metabase.