Skip to main content

Authentication

Most CrossCheck API endpoints require authentication using a token in the Authorization header. This token-based approach ensures secure access to your monitoring infrastructure while keeping integration simple for developers.

Obtain a Token

POST /api/auth/token/

Get an authentication token using your CrossCheck account credentials. This token can be used for all subsequent API requests to manage your monitors, check-ins, and alerts.

Request body:

FieldTypeRequiredDescription
usernamestringYesYour email or username
passwordstringYesYour password

Response (200):

{
"token": "9944b09199c62b941..."
}

Example:

curl -X POST https://crosscheck.app/api/auth/token/ \
-H "Content-Type: application/json" \
-d '{"username":"user@example.com","password":"your-password"}'

Using Your Token

Include your token in the Authorization header for all authenticated requests:

curl https://crosscheck.app/api/flights/ \
-H "Authorization: Token 9944b09199c62b941..."

API Keys vs User Tokens

  • User Token (from this endpoint): Used for managing your account, creating flights, setting up alerts, etc.
  • Flight API Key: Used specifically for check-ins from your monitored services. Each flight has its own API key.

See the API Keys section for managing programmatic access.