Atria API overview
Atria provides a current REST API, a PowerShell wrapper for selected REST operations, and the legacy XML-based 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 API token | HTTP Basic authentication |
| Documentation | Interactive (Swagger/OpenAPI) | Manual Guides |
REST API (Modern)
The REST API is the default choice for new development. It provides JSON endpoints for customers, users, requests, WorkSpace, metadata, billing, and other supported platform operations.
- Status: Actively developed and recommended.
- Reference: REST API Reference
- Authentication: Create and use an API token
Cortex API (Legacy)
The Cortex API remains available as a compatibility interface for existing XML integrations and provisioning operations that are not available through REST.
- Status: Legacy compatibility API; do not select it for a new integration unless REST lacks the required operation.
- Reference: Cortex API Guide
PowerShell SDK
The Atria.Tools module wraps selected REST endpoints for session management, provisioning-request tracking, and WorkSpace automation. It is not a complete replacement for the REST reference.
- Reference: PowerShell SDK
For guidance that spans APIs and provisioning rules, begin with the Developer overview.