Introduction to Atria APIs
Atria provides two primary interfaces for developers to interact with the platform: the modern REST API and the legacy Cortex API.
Which API should I use?
For most modern integrations, we recommend using the REST API.
| Feature | REST API | Cortex API (Legacy) |
|---|---|---|
| Technology | JSON over HTTPS | XML over HTTPS |
| Best For | Modern web apps, billing, custom portals | Provisioning (Legacy workflows) |
| Authentication | Bearer Tokens (OAuth2) | Basic Authentication |
| Documentation | Interactive (Swagger/OpenAPI) | Manual Guides |
REST API (Modern)
The REST API is our primary focus for new development. It provides a standard, secure way to manage customers, users, services, and billing data.
- Status: Actively developed and recommended.
- Reference: REST API Guide
Cortex API (Legacy)
The Cortex API is functionally complete for many provisioning tasks and remains supported for backward compatibility.
- Status: Maintained, but planned for eventual replacement by the REST API.
- Reference: Cortex API Guide
PowerShell SDK
For automation tasks, we provide a PowerShell module (Atria.Tools) that wraps the REST API, making it easier to script common tasks without manually building HTTP requests.
- Reference: PowerShell SDK