Developers
CockpitShop API Reference
Access your CockpitShop module configuration and status data programmatically via our REST API.
Authentication
The CockpitShop API uses API key authentication. Generate an API key from your account portal under Settings → API Keys. Include the key in all requests as a header:
Authorization: Bearer YOUR_API_KEY
Base URL
https://api.cockpitshop.org/v1
Endpoints
GET /modules
Returns a list of all active modules and their connection status.
GET /modules/{id}/status
Returns the current connection status, last sync time and any active errors for a specific module.
POST /modules/{id}/sync
Triggers a manual data sync for the specified module.
GET /properties
Returns all Dirs21 properties connected to your CockpitShop account.
Rate Limits
API requests are limited to 100 requests per minute per API key. Exceeding this limit returns HTTP 429. All API responses include X-RateLimit-Remaining and X-RateLimit-Reset headers.