Skip to content

Authentication

All endpoints require a Bearer token in the Authorization header:

Terminal window
curl -H "Authorization: Bearer your-token" https://app.com/kick/health

Tokens are configured in config/kick.php:

'tokens' => [
env('KICK_TOKEN') => ['*'],
env('KICK_READONLY_TOKEN') => ['health:read', 'stats:read'],
],

Each token maps to an array of scopes.

ScopeEndpoints
*All endpoints
health:readGET /kick/health
stats:readGET /kick/stats
logs:readGET /kick/logs, GET /kick/logs/{file}
queue:readGET /kick/queue, GET /kick/queue/failed
queue:retryPOST /kick/queue/retry/*
artisan:listGET /kick/artisan
artisan:executePOST /kick/artisan
CodeMeaning
401Missing or invalid token
403Token lacks required scope
200Success