Authentication¶

The Mikrotik CloudPilot API uses a simple, clean JWT authentication system:

Authentication Flow¶

Get API Keys: Register a user to receive API keys
Login: Use either username/password OR API keys to get JWT tokens
Use JWT Tokens: Access all protected endpoints with JWT tokens

POST /users/login/

Request Body:

{
    "username": "your_username",
    "password": "your_password"
}

POST /users/api-key-login/

Request Body:

{
    "public_key": "your_public_api_key",
    "private_key": "your_private_api_key"
}

Both login methods return the same JWT tokens:

{
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
    "refresh_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
    "user_id": 1,
    "username": "your_username"
}

Using JWT Tokens¶

Once you have obtained a JWT token, use it to authenticate all protected requests:

Authorization: Bearer <your_jwt_token>

API Key Management¶

Generate New API Keys¶

POST /users/generate-api-key/
Authorization: Bearer <your_jwt_token>

Get Current API Keys¶

GET /users/api-keys/
Authorization: Bearer <your_jwt_token>

Rotate API Keys¶

POST /users/rotate-api-keys/
Authorization: Bearer <your_jwt_token>

Security Notes¶

JWT Tokens: All protected endpoints require JWT tokens
API Keys: Used only for initial authentication to obtain JWT tokens
Token Expiry: JWT tokens have expiration times for security
Private Keys: Store private API keys securely - they're only shown once

Example Usage¶

# Login with username/password
curl -X POST http://localhost:8000/users/login/ \
  -H "Content-Type: application/json" \
  -d '{
    "username": "your_username",
    "password": "your_password"
  }'

# Login with API keys
curl -X POST http://localhost:8000/users/api-key-login/ \
  -H "Content-Type: application/json" \
  -d '{
    "public_key": "your_public_key",
    "private_key": "your_private_key"
  }'

Use JWT Token for All Operations¶

# Access routers
curl -X GET http://localhost:8000/routers/ \
  -H "Authorization: Bearer <jwt_token>"

# Execute commands
curl -X POST http://localhost:8000/routers/1/execute-command/ \
  -H "Authorization: Bearer <jwt_token>" \
  -H "Content-Type: application/json" \
  -d '{"command": "system/resource"}'

# Manage profile
curl -X GET http://localhost:8000/users/profile/ \
  -H "Authorization: Bearer <jwt_token>"

Error Responses¶

Invalid Credentials¶

{
    "error": "Invalid credentials"
}

Invalid API Keys¶

{
    "error": "Invalid API keys"
}

Missing Fields¶

{
    "error": "Public key and private key are required"
}

Unauthorized Access¶

{
    "detail": "Authentication credentials were not provided."
}