auth

Log in and fetch an authentication token

This endpoint is unavailable on Cribl.Cloud. Instead, follow the instructions at https://docs.cribl.io/stream/api-tutorials/#criblcloud to get an Auth token for Cribl.Cloud.

post/auth/login

Request

Base URL
/ (relative, and the document was published on a file host, not at the API’s origin)
Auth
none required

passwordstring required

Password for the account.

usernamestring required

Username of the account to authenticate.

Authentication token

forcePasswordChangeboolean required

If <code>true</code>, the user must change their password before accessing the API. Otherwise, <code>false</code>.

tokenstring required

Bearer token to include in the <code>Authorization</code> header for subsequent API requests.

Jul 23, 2026e9bef570d106 Revision changes
- info
  added the media type application/json for the response with the status
- info
  added the optional property to the response with the status
- info
  the response property became required for the status
- info
  added the required property to the response with the status
Jan 19, 202662472462b0c0 Revision changes
- warning
  the optional response header retry-after removed for the status 429
This list may be incomplete.