Documentation/API Reference

API Reference

Build with Aerie OS. Complete REST API documentation with SDKs, code examples, and best practices.

📝 Note: This is a placeholder for the API Reference. Full API documentation will be available soon.

API Overview

Aerie OS provides a comprehensive REST API for building custom integrations, automating workflows, and extending the platform.

Base URL

All API requests should be made to:

https://api.aerie-tech.co.uk/v1

Authentication

Aerie OS uses API tokens for authentication. Include your token in the Authorization header:

Authorization: Bearer YOUR_API_TOKEN

To get an API token, go to Settings → API Keys in your workspace.

Core Resources (Coming Soon)

The following API resources will be documented:

  • Devices — List, create, update, and delete devices
  • Tickets — Manage support tickets and incidents
  • Projects — Create and manage projects
  • Clients — Manage client accounts and contacts
  • Users — Team member management
  • Automations — Create and manage automation rules
  • Webhooks — Configure webhooks for real-time events

SDK Support

We provide official SDKs for popular languages:

  • JavaScript / TypeScript — npm package (coming soon)
  • Python — PyPI package (coming soon)
  • Go — Go module (coming soon)

Webhooks

Receive real-time events from Aerie OS. Available events:

  • device.created — New device added
  • device.updated — Device updated
  • ticket.created — New ticket opened
  • ticket.closed — Ticket resolved
  • alert.triggered — Alert generated
  • automation.executed — Automation rule ran

See the Integration Guides for webhook examples.

Rate Limiting

API requests are rate-limited to ensure platform stability.

  • Free plan: 100 requests/minute
  • Pro plan: 1,000 requests/minute
  • Enterprise plan: Custom limits

Error Handling

The API uses standard HTTP status codes. Error responses include a JSON body with details:

{
  "error": "invalid_request",
  "message": "Missing required field: name",
  "status": 400
}

Code Examples

Examples for common API operations will be provided in multiple languages (JavaScript, Python, cURL).

See the Integration Guides for real-world examples.

Getting Help

  • Read the Integration Guides for specific use cases
  • Check the Community Forum for Q&A
  • Email support@aerie-tech.co.uk for technical support
← FeaturesIntegration Guides →