atera-api-patterns

# Atera API Patterns ## Overview The Atera REST API (v3) provides access to all major entities in the RMM/PSA platform. This skill covers authentication, pagination, rate limiting, error handling, and performance optimization patterns. ## Authentication ### X-API-KEY Header Authentication Atera uses a simple API key authentication via the `X-API-KEY` header: ```http GET /api/v3/tickets X-API-KEY: YOUR_API_KEY Content-Type: application/json Accept: application/json ``` **Required Headers:** | Header | Value | Description | |--------|-------|-------------| | `X-API-KEY` | `{your_api_key}` | API key from Atera portal | | `Content-Type` | `application/json` | For POST/PUT requests | | `Accept` | `application/json` | Optional, for explicit format | ### Obtaining API Key 1. Log into Atera portal 2. Navigate to **Admin** > **API** 3. Generate or copy your API key 4. Store securely (treat as a password) ### Environment Variable Setup ```bash export ATERA_API_KEY="your-api-key-here" ``` ## Base URL All API requests use the following base URL. Atera requires HTTPS; plain HTTP is rejected. ``` https://app.atera.com/api/v3 ``` ## Pagination ### OData-Style Pagination Atera uses OData-style pagination with `page` and `itemsInPage` parameters: ```http GET /api/v3/tickets?page=1&itemsInPage=50 X-API-KEY: {api_key} ``` **Pagination Parameters:** | Parameter | Type | Default | Max | Description | |-----------|------|---------|-----|-------------| | `page` | int | 1 | - | ...