Skip to main content

sentrix auth

Test API authentication and connectivity.

sentrix auth

Test your API authentication and verify connectivity to the Sentrix API.

Subcommands#

sentrix auth test#

Verify that your API key is valid and the CLI can reach the Sentrix API.

Usage#

bash
sentrix auth test [--method <method>] [--url <url>] [--key <key>] [--verbose]

Options#

FlagTypeDefaultDescription
--methodstringautoAuthentication method. Values: auto, api-key. Both resolve to API key authentication.
--urlstringfrom configOverride the API base URL for this test only.
--keystringfrom configOverride the API key for this test only.
--verboseboolfalsePrint the request URL and response time to stderr.

Examples#

Test with your configured credentials:

bash
sentrix auth test

Test with verbose output:

bash
sentrix auth test --verbose

Test a specific API key before saving it to your config:

bash
sentrix auth test --key sk-your-new-key

Test against a different API endpoint:

bash
sentrix auth test --url https://api.staging.sentrix.ai --key sk-staging-key