Atera Tools
atera_ · 115 tools · Free 67 · Pro 48
Static X-API-KEY header (account-wide key, no per-endpoint scoping); fixed global base https://app.atera.com/api/v3; page-number pagination (page + itemsInPage, max page size 50); devices split into 4 families (generic/http/snmp/tcp, SNMP create split v1v2/v3); billing get-by-invoice-number is singular; raw JSON passthrough.
Agents
| Tool | Plan | Access | Description |
|---|---|---|---|
atera_delete_agent |
Pro | Destructive | [Atera] Permanently delete (uninstall) an RMM agent by its numeric AgentID (from atera_list_agents). DESTRUCTIVE: this removes the agent from Atera and stops monitoring/management of that machine — the endpoint must be re-enrolled to be managed again. Returns raw Atera JSON (typically an empty body on success). |
atera_get_agent |
Free | Read-only | [Atera] Get the full detail of a single RMM agent by its numeric AgentID (from atera_list_agents or atera_list_agents_by_customer). Returns the raw Atera agent JSON (OS, hardware, monitoring status, customer, last-seen, etc.). |
atera_get_agents_by_machine |
Free | Read-only | [Atera] Get the RMM agent(s) installed on a machine identified by its machine name (hostname). Useful when you know the endpoint's hostname but not its AgentID. Returns raw Atera JSON. Match is by the machine name Atera recorded at agent install time; use atera_list_agents to discover exact names. |
atera_list_agent_available_patches |
Free | Read-only | [Atera] List the patches AVAILABLE (pending/not-yet-installed) for the machine behind an RMM agent, keyed by the agent's deviceGuid (the agent's DeviceGuid string, a GUID — from the DeviceGuid field on atera_get_agent / atera_list_agents, NOT the numeric AgentID). Returns raw Atera JSON. Pair with atera_list_agent_installed_patches for already-installed patches. |
atera_list_agent_installed_patches |
Free | Read-only | [Atera] List the patches already INSTALLED on the machine behind an RMM agent, keyed by the agent's deviceGuid (the agent's DeviceGuid string, a GUID — from the DeviceGuid field on atera_get_agent / atera_list_agents, NOT the numeric AgentID). Returns raw Atera JSON. Pair with atera_list_agent_available_patches for pending/available patches. |
atera_list_agents |
Free | Read-only | [Atera] List all RMM agents (monitoring software installed on managed machines) across every customer. Paginated with page (1-based) + itemsInPage (default 20, max 500 — Atera's documented ceiling for this endpoint). Returns raw Atera JSON {items:[...], totalItemCount, page, itemsInPage, totalPages, nextLink}; walk nextLink or increment page until page > totalPages. Use atera_get_agent for a single agent's full detail, atera_list_agents_by_customer to scope to one customer, or atera_get_agents_by_machine to find agents by machine name. |
atera_list_agents_by_customer |
Free | Read-only | [Atera] List the RMM agents belonging to a single customer, identified by its numeric CustomerID (from atera_list_customers). Paginated with page + itemsInPage (default 20, max 500). Returns the same envelope shape as atera_list_agents, scoped to one customer. |
atera_delete_agent parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
agentId |
integer | yes | The numeric AgentID to delete (from atera_list_agents). |
atera_get_agent parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
agentId |
integer | yes | The numeric AgentID (from atera_list_agents). |
atera_get_agents_by_machine parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
machineName |
string | yes | The machine name (hostname) to look up, e.g. "DESKTOP-ABC123". |
atera_list_agent_available_patches parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
deviceGuid |
string | yes | The agent's DeviceGuid (a GUID string, from the DeviceGuid field on atera_get_agent / atera_list_agents). |
atera_list_agent_installed_patches parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
deviceGuid |
string | yes | The agent's DeviceGuid (a GUID string, from the DeviceGuid field on atera_get_agent / atera_list_agents). |
atera_list_agents parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
itemsInPage |
integer | no | 50 | Results per page (1-500; values above 500 are clamped to Atera's maximum for this endpoint). |
page |
integer | no | 1 | 1-based page number (default 1). |
atera_list_agents_by_customer parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
customerId |
integer | yes | The numeric CustomerID to scope to (from atera_list_customers). | |
itemsInPage |
integer | no | 50 | Results per page (1-500; values above 500 are clamped to Atera's maximum for this endpoint). |
page |
integer | no | 1 | 1-based page number (default 1). |
Devices
| Tool | Plan | Access | Description |
|---|---|---|---|
atera_create_generic_device |
Pro | Write | [Atera] Create a generic monitored device (a device pinged/monitored without a family-specific protocol). Body (fieldsJson) is the Atera generic-device DTO — typically requires the device name, the owning CustomerID (from atera_list_customers), and the host/IP to monitor. Returns raw Atera JSON (the created device, including its new DeviceID). See atera_create_http_device / atera_create_snmp_device_v1v2 / atera_create_snmp_device_v3 / atera_create_tcp_device for protocol-specific families. |
atera_create_http_device |
Pro | Write | [Atera] Create an HTTP monitored device (website/endpoint uptime + content check). Body (fieldsJson) is the Atera HTTP-device DTO — typically requires the device name, owning CustomerID (from atera_list_customers), the URL to monitor, and an optional expected content/pattern. Returns raw Atera JSON (the created device, including its new DeviceID). |
atera_create_snmp_device_v1v2 |
Pro | Write | [Atera] Create an SNMP-monitored device using SNMP v1 or v2c. Body (fieldsJson) is the Atera SNMP v1/v2 DTO — typically requires the device name, owning CustomerID (from atera_list_customers), the host/IP, port, and the SNMP community string. For SNMP v3 (user-based security) use atera_create_snmp_device_v3 instead — the credential model differs. Returns raw Atera JSON (the created device, including its new DeviceID). |
atera_create_snmp_device_v3 |
Pro | Write | [Atera] Create an SNMP-monitored device using SNMP v3 (user-based security model). Body (fieldsJson) is the Atera SNMP v3 DTO — typically requires the device name, owning CustomerID (from atera_list_customers), the host/IP, port, and the v3 security parameters (username, auth protocol/password, privacy protocol/password). For SNMP v1/v2c (community-string based) use atera_create_snmp_device_v1v2 instead. Returns raw Atera JSON (the created device, including its new DeviceID). |
atera_create_tcp_device |
Pro | Write | [Atera] Create a TCP monitored device (port-reachability check on a host). Body (fieldsJson) is the Atera TCP-device DTO — typically requires the device name, owning CustomerID (from atera_list_customers), the host/IP, and one or more TCP ports to monitor. Returns raw Atera JSON (the created device, including its new DeviceID). |
atera_delete_generic_device |
Pro | Destructive | [Atera] Permanently delete a generic monitored device by its numeric DeviceID (from atera_list_generic_devices). DESTRUCTIVE: monitoring of the device stops and its history is removed. Returns raw Atera JSON (typically an empty body on success). |
atera_delete_http_device |
Pro | Destructive | [Atera] Permanently delete an HTTP monitored device by its numeric DeviceID (from atera_list_http_devices). DESTRUCTIVE: monitoring of the URL stops and its history is removed. Returns raw Atera JSON (typically an empty body on success). |
atera_delete_snmp_device |
Pro | Destructive | [Atera] Permanently delete an SNMP monitored device by its numeric DeviceID (from atera_list_snmp_devices). DESTRUCTIVE: monitoring of the device stops and its history is removed. Returns raw Atera JSON (typically an empty body on success). |
atera_delete_tcp_device |
Pro | Destructive | [Atera] Permanently delete a TCP monitored device by its numeric DeviceID (from atera_list_tcp_devices). DESTRUCTIVE: monitoring of the device stops and its history is removed. Returns raw Atera JSON (typically an empty body on success). |
atera_get_generic_device |
Free | Read-only | [Atera] Get a single generic monitored device by its numeric DeviceID (from atera_list_generic_devices). Returns the raw Atera device JSON. |
atera_get_http_device |
Free | Read-only | [Atera] Get a single HTTP monitored device by its numeric DeviceID (from atera_list_http_devices). Returns the raw Atera device JSON. |
atera_get_snmp_device |
Free | Read-only | [Atera] Get a single SNMP monitored device by its numeric DeviceID (from atera_list_snmp_devices). Covers both v1/v2c and v3 devices. Returns the raw Atera device JSON. |
atera_get_tcp_device |
Free | Read-only | [Atera] Get a single TCP monitored device by its numeric DeviceID (from atera_list_tcp_devices). Returns the raw Atera device JSON. |
atera_list_generic_devices |
Free | Read-only | [Atera] List all generic monitored devices. Paginated with page + itemsInPage (default 20, max 500 — Atera's documented ceiling for this endpoint). Returns raw Atera JSON {items:[...], totalItemCount, page, totalPages, nextLink}; walk nextLink or increment page until page > totalPages. |
atera_list_http_devices |
Free | Read-only | [Atera] List all HTTP monitored devices. Paginated with page + itemsInPage (default 20, max 500 — Atera's documented ceiling for this endpoint). Returns raw Atera JSON {items:[...], totalItemCount, page, totalPages, nextLink}; walk nextLink or increment page until page > totalPages. |
atera_list_snmp_devices |
Free | Read-only | [Atera] List all SNMP monitored devices (both v1/v2c and v3). Paginated with page + itemsInPage (default 20, max 500 — Atera's documented ceiling for this endpoint). Returns raw Atera JSON {items:[...], totalItemCount, page, totalPages, nextLink}; walk nextLink or increment page until page > totalPages. |
atera_list_tcp_devices |
Free | Read-only | [Atera] List all TCP monitored devices. Paginated with page + itemsInPage (default 20, max 500 — Atera's documented ceiling for this endpoint). Returns raw Atera JSON {items:[...], totalItemCount, page, totalPages, nextLink}; walk nextLink or increment page until page > totalPages. |
atera_create_generic_device parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Generic-device DTO JSON. Include the device name, owning CustomerID, and the host/IP to monitor per Atera's schema. |
atera_create_http_device parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | HTTP-device DTO JSON. Include the device name, owning CustomerID, the URL to monitor, and any expected content/pattern per Atera's schema. |
atera_create_snmp_device_v1v2 parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | SNMP v1/v2c device DTO JSON. Include the device name, owning CustomerID, host/IP, port, and community string per Atera's schema. |
atera_create_snmp_device_v3 parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | SNMP v3 device DTO JSON. Include the device name, owning CustomerID, host/IP, port, and the v3 security parameters (username, auth + privacy protocol/password) per Atera's schema. |
atera_create_tcp_device parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | TCP-device DTO JSON. Include the device name, owning CustomerID, host/IP, and the TCP port(s) to monitor per Atera's schema. |
atera_delete_generic_device parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
deviceId |
integer | yes | The numeric DeviceID to delete (from atera_list_generic_devices). |
atera_delete_http_device parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
deviceId |
integer | yes | The numeric DeviceID to delete (from atera_list_http_devices). |
atera_delete_snmp_device parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
deviceId |
integer | yes | The numeric DeviceID to delete (from atera_list_snmp_devices). |
atera_delete_tcp_device parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
deviceId |
integer | yes | The numeric DeviceID to delete (from atera_list_tcp_devices). |
atera_get_generic_device parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
deviceId |
integer | yes | The numeric DeviceID (from atera_list_generic_devices). |
atera_get_http_device parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
deviceId |
integer | yes | The numeric DeviceID (from atera_list_http_devices). |
atera_get_snmp_device parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
deviceId |
integer | yes | The numeric DeviceID (from atera_list_snmp_devices). |
atera_get_tcp_device parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
deviceId |
integer | yes | The numeric DeviceID (from atera_list_tcp_devices). |
atera_list_generic_devices parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
itemsInPage |
integer | no | 50 | Results per page (1-500; values above 500 are clamped to Atera's maximum for this endpoint). |
page |
integer | no | 1 | 1-based page number (default 1). |
atera_list_http_devices parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
itemsInPage |
integer | no | 50 | Results per page (1-500; values above 500 are clamped to Atera's maximum for this endpoint). |
page |
integer | no | 1 | 1-based page number (default 1). |
atera_list_snmp_devices parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
itemsInPage |
integer | no | 50 | Results per page (1-500; values above 500 are clamped to Atera's maximum for this endpoint). |
page |
integer | no | 1 | 1-based page number (default 1). |
atera_list_tcp_devices parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
itemsInPage |
integer | no | 50 | Results per page (1-500; values above 500 are clamped to Atera's maximum for this endpoint). |
page |
integer | no | 1 | 1-based page number (default 1). |
Alerts
| Tool | Plan | Access | Description |
|---|---|---|---|
atera_create_alert |
Pro | Write | [Atera] Raise a new alert. Body (fieldsJson) is the Atera alert DTO — typically requires the alert Title/message, Severity, and the source (e.g. the owning DeviceID/AgentID or CustomerID). Returns raw Atera JSON (the created alert, including its new AlertID). |
atera_delete_alert |
Pro | Destructive | [Atera] Permanently delete (clear) an alert by its numeric AlertID (from atera_list_alerts). DESTRUCTIVE: the alert is removed from Atera. Returns raw Atera JSON (typically an empty body on success). |
atera_get_alert |
Free | Read-only | [Atera] Get the full detail of a single alert by its numeric AlertID (from atera_list_alerts). Returns the raw Atera alert JSON (severity, source agent/device, message, timestamps, archived state, etc.). |
atera_list_alerts |
Free | Read-only | [Atera] List monitoring alerts across all agents and devices. Paginated with page + itemsInPage (Atera default 20; this endpoint documents no maximum, so StackJack applies a conservative 50-item safety cap). Optionally filter by alert status (alertStatus). Returns raw Atera JSON {items:[...], totalItemCount, page, totalPages, nextLink}; walk nextLink or increment page until page > totalPages. Use atera_get_alert for a single alert's full detail. |
atera_update_alert |
Pro | Write | [Atera] Update an alert by its numeric AlertID (from atera_list_alerts). Provide a JSON object body with the fields to change (e.g. AlertStatus/archived state, Severity, Title/message). Returns the updated alert as raw Atera JSON. NOTE: PUT /alerts/ is a live-swagger addition (not in the older public mirror) and documented-but-unconfirmed against the keyed spec. |
atera_create_alert parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Alert DTO JSON. Include the title/message, severity, and source (owning device/agent/customer) per Atera's schema. |
atera_delete_alert parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
alertId |
integer | yes | The numeric AlertID to delete (from atera_list_alerts). |
atera_get_alert parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
alertId |
integer | yes | The numeric AlertID (from atera_list_alerts). |
atera_list_alerts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
alertStatus |
string | no | null | Optional alert-status filter (the documented GET /alerts filter field is alertStatus, e.g. Open/Closed). Omit for all statuses. Severity (Information/Warning/Critical) is a RESPONSE field, not a server-side filter. NOTE: alertStatus comes from the stale InoGo swagger mirror and is documented-but-unconfirmed against the live Atera spec; Atera ignores unknown query params, so a wrong value simply returns unfiltered results. |
itemsInPage |
integer | no | 50 | Results per page (default 20; Atera documents no maximum for alerts — StackJack clamps at 50 as a safety cap). |
page |
integer | no | 1 | 1-based page number (default 1). |
atera_update_alert parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
alertId |
integer | yes | The numeric AlertID to update (from atera_list_alerts). | |
fieldsJson |
string | yes | Alert DTO JSON with the fields to change (e.g. AlertStatus, Severity, Title). |
Knowledge Base
| Tool | Plan | Access | Description |
|---|---|---|---|
atera_list_knowledgebase_articles |
Free | Read-only | [Atera] List the knowledge-base articles configured in the Atera account. Paginated with page + itemsInPage (default 20, max 500 — Atera's documented ceiling for this endpoint). Returns raw Atera JSON {items:[...], totalItemCount, page, totalPages, nextLink}; walk nextLink or increment page until page > totalPages. |
atera_list_knowledgebase_articles parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
itemsInPage |
integer | no | 50 | Results per page (1-500; values above 500 are clamped to Atera's maximum for this endpoint). |
page |
integer | no | 1 | 1-based page number (default 1). |
Account
| Tool | Plan | Access | Description |
|---|---|---|---|
atera_get_account |
Free | Read-only | [Atera] Get the Atera account/tenant profile — the top-level account info for the API key in use (account name, plan/edition, and account-level identifiers). Returns the raw Atera account JSON. Takes no parameters; the account is the one the X-API-KEY belongs to. |
Departments
| Tool | Plan | Access | Description |
|---|---|---|---|
atera_create_department |
Pro | Write | [Atera] Create a help-desk department. Provide a JSON object body per Atera's department schema — typically the department Name. Returns the created department with its new id. |
atera_delete_department |
Pro | Destructive | [Atera] Permanently delete a help-desk department by its numeric department id (from atera_list_departments). DESTRUCTIVE: the department is removed; tickets/technicians referencing it may be affected. Returns raw Atera JSON (typically an empty body on success). |
atera_get_department |
Free | Read-only | [Atera] Get a single help-desk department by its numeric department id (from atera_list_departments). Returns the full department record as raw Atera JSON. |
atera_list_departments |
Free | Read-only | [Atera] List the help-desk departments defined in the Atera account. Returns each department's id and name. Paginated with page + itemsInPage (default 20, max 500 — Atera's documented ceiling for this endpoint). Use the returned department id with atera_get_department / atera_update_department / atera_delete_department. |
atera_update_department |
Pro | Write | [Atera] Update a help-desk department by its numeric department id (from atera_list_departments). Provide a JSON object body with the fields to change (e.g. Name). Returns the updated department. |
atera_create_department parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
bodyJson |
string | yes | Department DTO JSON — typically the department Name per Atera's schema. |
atera_delete_department parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
departmentId |
integer | yes | The department id to delete (from atera_list_departments). |
atera_get_department parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
departmentId |
integer | yes | The department id (from atera_list_departments). |
atera_list_departments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
itemsInPage |
integer | no | 50 | Records per page (1-500, default 50; max 500 — Atera's documented ceiling for this endpoint; larger values are clamped to 500). |
page |
integer | no | 1 | Page number to return (1-based, default 1). |
atera_update_department parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
bodyJson |
string | yes | Department DTO JSON with the fields to change (e.g. Name). | |
departmentId |
integer | yes | The department id to update (from atera_list_departments). |
Customers
| Tool | Plan | Access | Description |
|---|---|---|---|
atera_create_customer |
Pro | Write | [Atera] Create a customer (company/organization). Provide a JSON object body — CustomerName is required; optional fields include BusinessNumber, Domain, Address, City, State, Country, Phone, and Notes. Returns the created customer with its new CustomerID. |
atera_create_customer_attachment |
Pro | Write | [Atera] Attach a file to a customer. Provide a JSON object body containing the target CustomerID and the file content (base64-encoded) with its filename, per the Atera attachment schema. This is a request-body upload only — it is NOT a binary download. Returns the created attachment record. |
atera_create_customer_folder |
Pro | Write | [Atera] Create a customer folder (a grouping/organizational folder used to organize customers). Provide a JSON object body describing the folder (e.g. FolderName and, if nesting, the parent folder id). Returns the created folder. |
atera_delete_customer |
Pro | Destructive | [Atera] Permanently delete a customer by CustomerID (from atera_list_customers). This removes the company and cannot be undone — related contacts, contracts, and tickets may be affected. Use with care. |
atera_get_customer |
Free | Read-only | [Atera] Get a single customer by CustomerID (from atera_list_customers). Returns the full customer profile. |
atera_list_customers |
Free | Read-only | [Atera] List the customers (companies/organizations) in your Atera account. Returns each customer's CustomerID, CustomerName, and profile fields (address, contacts count, business number, etc.). Paginated with page + itemsInPage (default 20, max 500 — Atera's documented ceiling for this endpoint). Use the returned CustomerID with atera_get_customer, atera_list_agents_by_customer, atera_list_contracts_by_customer, and atera_create_contact. |
atera_update_customer |
Pro | Write | [Atera] Update a customer by CustomerID (from atera_list_customers). Provide a JSON object body with the fields to change (e.g. CustomerName, Address, Phone, Notes). Returns the updated customer. |
atera_create_customer parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
bodyJson |
string | yes | JSON object body for the new customer. Required: CustomerName. Optional: BusinessNumber, Domain, Address, City, State, Country, Phone, Notes. |
atera_create_customer_attachment parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
bodyJson |
string | yes | JSON object body: the target CustomerID plus the file content (base64) and filename, per Atera's attachment schema. |
atera_create_customer_folder parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
bodyJson |
string | yes | JSON object body describing the folder (e.g. FolderName, optional parent folder id). |
atera_delete_customer parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
customerId |
integer | yes | The CustomerID of the customer to delete (from atera_list_customers). |
atera_get_customer parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
customerId |
integer | yes | The CustomerID of the customer (from atera_list_customers). |
atera_list_customers parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
itemsInPage |
integer | no | 50 | Records per page (1-500, default 50; max 500 — Atera's documented ceiling for this endpoint; larger values are clamped to 500). |
page |
integer | no | 1 | Page number to return (1-based, default 1). |
atera_update_customer parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
bodyJson |
string | yes | JSON object body with the customer fields to change (e.g. CustomerName, Address, City, State, Country, Phone, Notes). | |
customerId |
integer | yes | The CustomerID of the customer to update (from atera_list_customers). |
Contacts
| Tool | Plan | Access | Description |
|---|---|---|---|
atera_create_contact |
Pro | Write | [Atera] Create an end-user contact under a customer. Provide a JSON object body — required: CustomerID (from atera_list_customers) and Email; optional: Firstname, Lastname, Phone, JobTitle, IsContactPerson. Returns the created contact with its new EndUserID. |
atera_delete_contact |
Pro | Destructive | [Atera] Permanently delete an end-user contact by its contact id (EndUserID, from atera_list_contacts). This cannot be undone. Note: this endpoint is documented by a secondary source and pending confirmation against Atera's live authenticated spec; if your account returns a 404/405, the delete-contact operation may not be available on the API. |
atera_get_contact |
Free | Read-only | [Atera] Get a single end-user contact by its contact id (EndUserID, from atera_list_contacts). Returns the full contact profile. |
atera_list_contacts |
Free | Read-only | [Atera] List the end-user contacts across your customers. Returns each contact's EndUserID, CustomerID, Firstname, Lastname, Email, Phone, and JobTitle. Paginated with page + itemsInPage (default 20, max 500 — Atera's documented ceiling for this endpoint). Use the returned EndUserID with atera_get_contact and as the ticket requester (EndUserID) in atera_create_ticket. |
atera_update_contact |
Pro | Write | [Atera] Update an end-user contact by its contact id (EndUserID, from atera_list_contacts). Provide a JSON object body with the fields to change (e.g. Firstname, Lastname, Email, Phone, JobTitle). Returns the updated contact. |
atera_create_contact parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
bodyJson |
string | yes | JSON object body for the new contact. Required: CustomerID, Email. Optional: Firstname, Lastname, Phone, JobTitle, IsContactPerson. |
atera_delete_contact parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contactId |
integer | yes | The contact id (EndUserID) of the contact to delete (from atera_list_contacts). |
atera_get_contact parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contactId |
integer | yes | The contact id (EndUserID) of the contact (from atera_list_contacts). |
atera_list_contacts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
itemsInPage |
integer | no | 50 | Records per page (1-500, default 50; max 500 — Atera's documented ceiling for this endpoint; larger values are clamped to 500). |
page |
integer | no | 1 | Page number to return (1-based, default 1). |
atera_update_contact parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
bodyJson |
string | yes | JSON object body with the contact fields to change (e.g. Firstname, Lastname, Email, Phone, JobTitle). | |
contactId |
integer | yes | The contact id (EndUserID) of the contact to update (from atera_list_contacts). |
Contracts
| Tool | Plan | Access | Description |
|---|---|---|---|
atera_create_contract |
Pro | Write | [Atera] Create a contract (billing agreement) for a customer. Provide a JSON object body per Atera's contract schema — typically requires the owning CustomerID (from atera_list_customers), a ContractName, the ContractType, and rate/period details. Returns the created contract with its new ContractID. NOTE: POST /contracts is a live-swagger addition (the older public mirror is GET-only). |
atera_get_contract |
Free | Read-only | [Atera] Get a single contract by ContractID (from atera_list_contracts or atera_list_contracts_by_customer). Returns the full contract, including its type, rates, and billing period. |
atera_list_contracts |
Free | Read-only | [Atera] List all contracts (billing agreements) in your Atera account. Returns each contract's ContractID, CustomerID, ContractName, ContractType, and rate/period details. Paginated with page + itemsInPage (default 20, max 500 — Atera's documented ceiling for this endpoint). Use atera_list_contracts_by_customer to scope to one customer and atera_get_contract for a single contract's detail. |
atera_list_contracts_by_customer |
Free | Read-only | [Atera] List the contracts for a single customer, identified by CustomerID (from atera_list_customers). Returns the same contract shape as atera_list_contracts, scoped to that customer. Paginated with page + itemsInPage (default 20, max 500 — Atera's documented ceiling for this endpoint). |
atera_update_contract |
Pro | Write | [Atera] Update a contract by ContractID (from atera_list_contracts). Provide a JSON object body with the fields to change (e.g. ContractName, ContractType, rates, billing period). Returns the updated contract. NOTE: PUT /contracts/ is a live-swagger addition (the older public mirror is GET-only). |
atera_create_contract parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
bodyJson |
string | yes | Contract DTO JSON. Typically requires CustomerID, ContractName, ContractType, and rate/period details per Atera's schema. |
atera_get_contract parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contractId |
integer | yes | The ContractID of the contract (from atera_list_contracts). |
atera_list_contracts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
itemsInPage |
integer | no | 50 | Records per page (1-500, default 50; max 500 — Atera's documented ceiling for this endpoint; larger values are clamped to 500). |
page |
integer | no | 1 | Page number to return (1-based, default 1). |
atera_list_contracts_by_customer parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
customerId |
integer | yes | The CustomerID whose contracts to list (from atera_list_customers). | |
itemsInPage |
integer | no | 50 | Records per page (1-500, default 50; max 500 — Atera's documented ceiling for this endpoint; larger values are clamped to 500). |
page |
integer | no | 1 | Page number to return (1-based, default 1). |
atera_update_contract parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
bodyJson |
string | yes | Contract DTO JSON with the fields to change (e.g. ContractName, ContractType, rates, billing period). | |
contractId |
integer | yes | The ContractID of the contract to update (from atera_list_contracts). |
Tickets
| Tool | Plan | Access | Description |
|---|---|---|---|
atera_add_ticket_comment |
Pro | Write | [Atera] Add a comment to a ticket by TicketID (from atera_list_tickets). Provide a JSON object body per Atera's comment schema — typically the comment text/body plus an author and an internal/public flag. Returns the created comment as raw Atera JSON. Read the thread first with atera_get_ticket_comments. |
atera_add_ticket_relation |
Pro | Write | [Atera] Link a ticket to another ticket, by TicketID (from atera_list_tickets) — vendor endpoint POST /tickets//relations. Provide a JSON object body of {"RelatedTicketId": <int64>, "RelationType": "<string>"} (the RelatedTicketId is the other ticket; RelationType is Atera's relation label). Returns raw Atera JSON. Remove a relation with atera_delete_ticket_relation. |
atera_create_ticket |
Pro | Write | [Atera] Create a help-desk ticket. Provide a JSON object body — required: TicketTitle and EndUserID (the requester contact id, from atera_list_contacts); common optional fields: Description, TicketPriority (Low/Medium/High/Critical), TicketType (Incident/Problem/Request/Change), TicketStatus, and TechnicianContactID. Returns the created ticket with its new TicketID. |
atera_delete_ticket |
Pro | Destructive | [Atera] Permanently delete a ticket by TicketID (from atera_list_tickets). This removes the ticket and its comments/time entries and cannot be undone. Use with care. |
atera_delete_ticket_relation |
Pro | Destructive | [Atera] Delete a relation from a ticket by TicketID + the relation's RelationType, vendor endpoint DELETE /tickets//relations/. relationType is the STRING relation label (as returned by the ticket's relations / atera_get_ticket with includeRelations), NOT a numeric id. DESTRUCTIVE: the link between the ticket and the related ticket is removed. Returns raw Atera JSON (typically an empty body on success). |
atera_get_ticket |
Free | Read-only | [Atera] Get a single ticket by TicketID (from atera_list_tickets). Returns the full ticket record. |
atera_get_ticket_billable_duration |
Free | Read-only | [Atera] Get the total billable duration logged against a ticket by TicketID (from atera_list_tickets). Use atera_get_ticket_nonbillable_duration for the non-billable total and atera_get_ticket_workhours for the aggregate. |
atera_get_ticket_billable_workhours_site_duration |
Free | Read-only | [Atera] Get the billable work-hours site-duration for a BATCH of tickets in one call (vendor endpoint POST /tickets/billableworkhourssiteduration — the site-time variant of the batch billable-duration endpoint). Provide a JSON array of up to 50 TicketIDs (from atera_list_tickets), e.g. [123,456]. Returns raw Atera JSON. Read-only despite being a POST (it just accepts the id list in the body). Cf atera_get_ticket_billable_duration / atera_get_ticket_workhours for per-ticket totals. |
atera_get_ticket_comments |
Free | Read-only | [Atera] Get the comment/conversation thread for a ticket by TicketID (from atera_list_tickets). Returns the ordered comments (author, timestamp, body, internal/public flag). |
atera_get_ticket_nonbillable_duration |
Free | Read-only | [Atera] Get the total non-billable duration logged against a ticket by TicketID (from atera_list_tickets). Pairs with atera_get_ticket_billable_duration. |
atera_get_ticket_workhours |
Free | Read-only | [Atera] Get the aggregate work-hours summary for a ticket by TicketID (from atera_list_tickets) — the combined billable + non-billable time. Use atera_list_ticket_workhours_records for the individual time-entry rows. |
atera_list_ticket_attachments |
Free | Read-only | [Atera] List the attachment METADATA (filenames, ids, sizes, upload timestamps) for a ticket by TicketID (from atera_list_tickets). This returns a JSON list of attachment records — it does NOT download raw binary. Returns raw Atera JSON. |
atera_list_ticket_workhours_records |
Free | Read-only | [Atera] List the individual work-hours (time-entry) records for a ticket by TicketID (from atera_list_tickets). Returns each entry's technician, start/end, duration, and billable flag. Use atera_get_ticket_workhours for the rolled-up total. |
atera_list_tickets |
Free | Read-only | [Atera] List help-desk tickets. Returns each ticket's TicketID, Title, TicketStatus, TicketPriority, TicketType, EndUserID, CustomerID, and timestamps. Paginated with page + itemsInPage (Atera caps itemsInPage at 50). Optionally filter by status via ticketStatus (e.g. Open, Pending, Resolved, Closed). Use the returned TicketID with atera_get_ticket, atera_get_ticket_comments, and the ticket duration/work-hours tools. |
atera_list_tickets_billable_duration |
Free | Read-only | [Atera] Get the billable duration for a BATCH of tickets in one call (vendor endpoint POST /tickets/billableduration). Provide a JSON array of up to 50 TicketIDs (from atera_list_tickets), e.g. [123,456,789]. Returns raw Atera JSON keyed by ticket. For one ticket's total use atera_get_ticket_billable_duration instead. This is read-only despite being a POST — it just accepts the id list in the body. |
atera_list_tickets_last_modified |
Free | Read-only | [Atera] List tickets by LAST-ACTIVITY date (most recent activity on/after a date) — distinct from atera_list_tickets_status_modified, which keys off the last STATUS CHANGE. Useful for reporting on recently touched tickets. Paginated with page + itemsInPage (Atera caps itemsInPage at 50). Any date filter is passed by Atera's documented query params; supply via the standard listing conventions. |
atera_list_tickets_status_modified |
Free | Read-only | [Atera] List tickets whose status changed (e.g. resolved/closed tickets by status-change date) — useful for reporting on recently closed work. Paginated with page + itemsInPage (Atera caps itemsInPage at 50). |
atera_update_ticket |
Pro | Write | [Atera] Update a ticket by TicketID (from atera_list_tickets). Provide a JSON object body with the fields to change (e.g. TicketStatus, TicketPriority, TicketType, TicketTitle, TechnicianContactID). Returns the updated ticket. |
atera_add_ticket_comment parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
bodyJson |
string | yes | Comment DTO JSON — typically the comment text/body, author, and internal/public flag per Atera's schema. | |
ticketId |
integer | yes | The TicketID to comment on (from atera_list_tickets). |
atera_add_ticket_relation parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
bodyJson |
string | yes | Relation DTO JSON: {"RelatedTicketId": <int64>, "RelationType": "<string>"}. | |
ticketId |
integer | yes | The TicketID to add a relation to (from atera_list_tickets). |
atera_create_ticket parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
bodyJson |
string | yes | JSON object body for the new ticket. Required: TicketTitle, EndUserID. Optional: Description, TicketPriority, TicketType, TicketStatus, TechnicianContactID. |
atera_delete_ticket parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
ticketId |
integer | yes | The TicketID of the ticket to delete (from atera_list_tickets). |
atera_delete_ticket_relation parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
relationType |
string | yes | The RelationType string label to remove from the ticket. | |
ticketId |
integer | yes | The TicketID whose relation to delete (from atera_list_tickets). |
atera_get_ticket parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
ticketId |
integer | yes | The TicketID of the ticket (from atera_list_tickets). |
atera_get_ticket_billable_duration parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
ticketId |
integer | yes | The TicketID whose billable duration to fetch (from atera_list_tickets). |
atera_get_ticket_billable_workhours_site_duration parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
ticketIdsJson |
string | yes | JSON array of up to 50 TicketIDs (int64), e.g. [123,456] (from atera_list_tickets). |
atera_get_ticket_comments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
ticketId |
integer | yes | The TicketID whose comments to fetch (from atera_list_tickets). |
atera_get_ticket_nonbillable_duration parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
ticketId |
integer | yes | The TicketID whose non-billable duration to fetch (from atera_list_tickets). |
atera_get_ticket_workhours parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
ticketId |
integer | yes | The TicketID whose work-hours summary to fetch (from atera_list_tickets). |
atera_list_ticket_attachments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
ticketId |
integer | yes | The TicketID whose attachments to list (from atera_list_tickets). |
atera_list_ticket_workhours_records parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
ticketId |
integer | yes | The TicketID whose work-hours records to list (from atera_list_tickets). |
atera_list_tickets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
itemsInPage |
integer | no | 50 | Records per page (default 50, max 50 — Atera's ceiling; larger values are clamped to 50). |
page |
integer | no | 1 | Page number to return (1-based, default 1). |
ticketStatus |
string | no | null | Optional status filter (e.g. Open, Pending, Resolved, Closed). Leave null for all statuses. |
atera_list_tickets_billable_duration parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
ticketIdsJson |
string | yes | JSON array of up to 50 TicketIDs (int64), e.g. [123,456,789] (from atera_list_tickets). |
atera_list_tickets_last_modified parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
itemsInPage |
integer | no | 50 | Records per page (default 50, max 50 — Atera's ceiling; larger values are clamped to 50). |
page |
integer | no | 1 | Page number to return (1-based, default 1). |
atera_list_tickets_status_modified parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
itemsInPage |
integer | no | 50 | Records per page (default 50, max 50 — Atera's ceiling; larger values are clamped to 50). |
page |
integer | no | 1 | Page number to return (1-based, default 1). |
atera_update_ticket parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
bodyJson |
string | yes | JSON object body with the ticket fields to change (e.g. TicketStatus, TicketPriority, TicketType, TicketTitle, TechnicianContactID). | |
ticketId |
integer | yes | The TicketID of the ticket to update (from atera_list_tickets). |
Billing
| Tool | Plan | Access | Description |
|---|---|---|---|
atera_get_invoice |
Free | Read-only | [Atera] Get a single invoice by its invoice NUMBER (from atera_list_invoices) — this endpoint is keyed by the human-readable invoice number, not a numeric id. Returns the full invoice with its line items. |
atera_list_invoices |
Free | Read-only | [Atera] List billing invoices. Returns each invoice's number, customer, amount, currency, dates, and status. Paginated with page + itemsInPage (default 20, max 500 — Atera's documented ceiling for this endpoint). Take the invoice NUMBER from a row here and pass it to atera_get_invoice for the full invoice. |
atera_get_invoice parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
invoiceNumber |
string | yes | The invoice NUMBER (not id) of the invoice to fetch (from atera_list_invoices). |
atera_list_invoices parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
itemsInPage |
integer | no | 50 | Records per page (1-500, default 50; max 500 — Atera's documented ceiling for this endpoint; larger values are clamped to 500). |
page |
integer | no | 1 | Page number to return (1-based, default 1). |
Rates
| Tool | Plan | Access | Description |
|---|---|---|---|
atera_create_expense |
Pro | Write | [Atera] Create a billable expense in the rates catalog. Provide a JSON object body — typically an expense name, amount, and category. Returns the created expense with its new ExpenseID. |
atera_create_product |
Pro | Write | [Atera] Create a billable product in the rates catalog. Provide a JSON object body — typically a product name, SKU, unit price, and category. Returns the created product with its new ProductID. |
atera_delete_expense |
Pro | Destructive | [Atera] Permanently delete a billable expense by ExpenseID (from atera_list_expenses). This cannot be undone. Use with care. |
atera_delete_product |
Pro | Destructive | [Atera] Permanently delete a billable product by ProductID (from atera_list_products). This cannot be undone. Use with care. |
atera_get_expense |
Free | Read-only | [Atera] Get a single billable expense by ExpenseID (from atera_list_expenses). Returns the full expense record. |
atera_get_product |
Free | Read-only | [Atera] Get a single billable product by ProductID (from atera_list_products). Returns the full product record. |
atera_list_expenses |
Free | Read-only | [Atera] List the billable expenses in your rates catalog. Returns each expense's ExpenseID, name, amount, and category. Paginated with page + itemsInPage (default 20, max 500 — Atera's documented ceiling for this endpoint). Use the returned ExpenseID with atera_get_expense / atera_update_expense / atera_delete_expense. |
atera_list_products |
Free | Read-only | [Atera] List the billable products in your rates catalog. Returns each product's ProductID, name, SKU, price, and category. Paginated with page + itemsInPage (default 20, max 500 — Atera's documented ceiling for this endpoint). Use the returned ProductID with atera_get_product / atera_update_product / atera_delete_product. |
atera_update_expense |
Pro | Write | [Atera] Update a billable expense by ExpenseID (from atera_list_expenses). Provide a JSON object body with the fields to change (e.g. name, amount, category). Returns the updated expense. |
atera_update_product |
Pro | Write | [Atera] Update a billable product by ProductID (from atera_list_products). Provide a JSON object body with the fields to change (e.g. name, SKU, price, category). Returns the updated product. |
atera_create_expense parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
bodyJson |
string | yes | JSON object body for the new expense (e.g. name, amount, category). |
atera_create_product parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
bodyJson |
string | yes | JSON object body for the new product (e.g. name, SKU, price, category). |
atera_delete_expense parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
expenseId |
integer | yes | The ExpenseID of the expense to delete (from atera_list_expenses). |
atera_delete_product parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
productId |
integer | yes | The ProductID of the product to delete (from atera_list_products). |
atera_get_expense parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
expenseId |
integer | yes | The ExpenseID of the expense (from atera_list_expenses). |
atera_get_product parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
productId |
integer | yes | The ProductID of the product (from atera_list_products). |
atera_list_expenses parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
itemsInPage |
integer | no | 50 | Records per page (1-500, default 50; max 500 — Atera's documented ceiling for this endpoint; larger values are clamped to 500). |
page |
integer | no | 1 | Page number to return (1-based, default 1). |
atera_list_products parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
itemsInPage |
integer | no | 50 | Records per page (1-500, default 50; max 500 — Atera's documented ceiling for this endpoint; larger values are clamped to 500). |
page |
integer | no | 1 | Page number to return (1-based, default 1). |
atera_update_expense parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
bodyJson |
string | yes | JSON object body with the expense fields to change (e.g. name, amount, category). | |
expenseId |
integer | yes | The ExpenseID of the expense to update (from atera_list_expenses). |
atera_update_product parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
bodyJson |
string | yes | JSON object body with the product fields to change (e.g. name, SKU, price, category). | |
productId |
integer | yes | The ProductID of the product to update (from atera_list_products). |
Custom Values
| Tool | Plan | Access | Description |
|---|---|---|---|
atera_get_agent_custom_field |
Free | Read-only | [Atera] Get the value of a named custom field on an agent (installed device). agentId comes from atera_list_agents / atera_get_agent; fieldName is the exact (case-sensitive) name from atera_list_custom_fields. Set it with atera_set_agent_custom_field. |
atera_get_contact_custom_field |
Free | Read-only | [Atera] Get the value of a named custom field on a contact (end user). contactId comes from atera_list_contacts / atera_get_contact; fieldName is the exact (case-sensitive) name from atera_list_custom_fields. Set it with atera_set_contact_custom_field. |
atera_get_contract_custom_field |
Free | Read-only | [Atera] Get the value of a named custom field on a contract. contractId comes from atera_list_contracts / atera_get_contract; fieldName is the exact (case-sensitive) name from atera_list_custom_fields. Set it with atera_set_contract_custom_field. |
atera_get_custom_value |
Free | Read-only | [Atera] Fetch a single custom-value record by its internal row id — a GUID string (the CustomFieldValueID Atera assigns each stored value), NOT a number. Row ids appear in the responses of the atera_get_custom_field tools and in atera_list_custom_fields. Prefer the per-entity atera_get_custom_field tools when you know the entity and field name. |
atera_get_customer_custom_field |
Free | Read-only | [Atera] Get the value of a named custom field on a customer (managed organization). customerId comes from atera_list_customers / atera_get_customer; fieldName is the exact (case-sensitive) name from atera_list_custom_fields. Set it with atera_set_customer_custom_field. |
atera_get_generic_device_custom_field |
Free | Read-only | [Atera] Get the value of a named custom field on a generic monitored device. genericDeviceId comes from atera_list_generic_devices / atera_get_generic_device; fieldName is the exact (case-sensitive) name from atera_list_custom_fields. Set it with atera_set_generic_device_custom_field. |
atera_get_http_device_custom_field |
Free | Read-only | [Atera] Get the value of a named custom field on an HTTP monitored device. httpDeviceId comes from atera_list_http_devices / atera_get_http_device; fieldName is the exact (case-sensitive) name from atera_list_custom_fields. Set it with atera_set_http_device_custom_field. |
atera_get_sla_custom_field |
Free | Read-only | [Atera] Get the value of a named custom field on an SLA. slaId is the SLA's internal id; fieldName is the exact (case-sensitive) name from atera_list_custom_fields (filter that list for SLA-scoped fields). Set it with atera_set_sla_custom_field. |
atera_get_snmp_device_custom_field |
Free | Read-only | [Atera] Get the value of a named custom field on an SNMP monitored device. snmpDeviceId comes from atera_list_snmp_devices / atera_get_snmp_device; fieldName is the exact (case-sensitive) name from atera_list_custom_fields. Set it with atera_set_snmp_device_custom_field. |
atera_get_tcp_device_custom_field |
Free | Read-only | [Atera] Get the value of a named custom field on a TCP monitored device. tcpDeviceId comes from atera_list_tcp_devices / atera_get_tcp_device; fieldName is the exact (case-sensitive) name from atera_list_custom_fields. Set it with atera_set_tcp_device_custom_field. |
atera_get_ticket_custom_field |
Free | Read-only | [Atera] Get the value of a named custom field on a ticket. ticketId comes from atera_list_tickets / atera_get_ticket; fieldName is the exact (case-sensitive) name from atera_list_custom_fields. Set it with atera_set_ticket_custom_field. |
atera_list_agent_custom_fields |
Free | Read-only | [Atera] List ALL custom-field values set on an agent, by agentId (from atera_list_agents). Returns raw Atera JSON. For one named field use atera_get_agent_custom_field. |
atera_list_contact_custom_fields |
Free | Read-only | [Atera] List ALL custom-field values set on a contact, by contactId (from atera_list_contacts). Returns raw Atera JSON. For one named field use atera_get_contact_custom_field. |
atera_list_contract_custom_fields |
Free | Read-only | [Atera] List ALL custom-field values set on a contract, by contractId (from atera_list_contracts). Returns raw Atera JSON. For one named field use atera_get_contract_custom_field. |
atera_list_custom_fields |
Free | Read-only | [Atera] List every custom field defined on the account — the catalog of user-defined fields you can read or set on agents, tickets, customers, contracts, contacts, SLAs and devices. Use this first to discover the exact fieldName (case-sensitive) and which entity type a field applies to before calling any atera_get_custom_field / atera_set_custom_field tool. |
atera_list_customer_custom_fields |
Free | Read-only | [Atera] List ALL custom-field values set on a customer, by customerId (from atera_list_customers). Returns raw Atera JSON. For one named field use atera_get_customer_custom_field. |
atera_list_generic_device_custom_fields |
Free | Read-only | [Atera] List ALL custom-field values set on a generic monitored device, by genericDeviceId (from atera_list_generic_devices). Returns raw Atera JSON. For one named field use atera_get_generic_device_custom_field. |
atera_list_http_device_custom_fields |
Free | Read-only | [Atera] List ALL custom-field values set on an HTTP monitored device, by httpDeviceId (from atera_list_http_devices). Returns raw Atera JSON. For one named field use atera_get_http_device_custom_field. |
atera_list_sla_custom_fields |
Free | Read-only | [Atera] List ALL custom-field values set on an SLA, by slaId. Returns raw Atera JSON. For one named field use atera_get_sla_custom_field. |
atera_list_snmp_device_custom_fields |
Free | Read-only | [Atera] List ALL custom-field values set on an SNMP monitored device, by snmpDeviceId (from atera_list_snmp_devices). Returns raw Atera JSON. For one named field use atera_get_snmp_device_custom_field. |
atera_list_tcp_device_custom_fields |
Free | Read-only | [Atera] List ALL custom-field values set on a TCP monitored device, by tcpDeviceId (from atera_list_tcp_devices). Returns raw Atera JSON. For one named field use atera_get_tcp_device_custom_field. |
atera_list_ticket_custom_fields |
Free | Read-only | [Atera] List ALL custom-field values set on a ticket, by ticketId (from atera_list_tickets). Returns raw Atera JSON. For one named field use atera_get_ticket_custom_field. |
atera_set_agent_custom_field |
Pro | Write | [Atera] Set the value of a named custom field on an agent. agentId from atera_list_agents; fieldName (exact, case-sensitive) from atera_list_custom_fields. bodyJson carries the new value — commonly {"Value": "..."}. Read the current value first with atera_get_agent_custom_field. |
atera_set_contact_custom_field |
Pro | Write | [Atera] Set the value of a named custom field on a contact (end user). contactId from atera_list_contacts; fieldName (exact, case-sensitive) from atera_list_custom_fields. bodyJson carries the new value — commonly {"Value": "..."}. Read the current value first with atera_get_contact_custom_field. |
atera_set_contract_custom_field |
Pro | Write | [Atera] Set the value of a named custom field on a contract. contractId from atera_list_contracts; fieldName (exact, case-sensitive) from atera_list_custom_fields. bodyJson carries the new value — commonly {"Value": "..."}. Read the current value first with atera_get_contract_custom_field. |
atera_set_customer_custom_field |
Pro | Write | [Atera] Set the value of a named custom field on a customer (managed organization). customerId from atera_list_customers; fieldName (exact, case-sensitive) from atera_list_custom_fields. bodyJson carries the new value — commonly {"Value": "..."}. Read the current value first with atera_get_customer_custom_field. |
atera_set_generic_device_custom_field |
Pro | Write | [Atera] Set the value of a named custom field on a generic monitored device. genericDeviceId from atera_list_generic_devices; fieldName (exact, case-sensitive) from atera_list_custom_fields. bodyJson carries the new value — commonly {"Value": "..."}. Read the current value first with atera_get_generic_device_custom_field. |
atera_set_http_device_custom_field |
Pro | Write | [Atera] Set the value of a named custom field on an HTTP monitored device. httpDeviceId from atera_list_http_devices; fieldName (exact, case-sensitive) from atera_list_custom_fields. bodyJson carries the new value — commonly {"Value": "..."}. Read the current value first with atera_get_http_device_custom_field. |
atera_set_sla_custom_field |
Pro | Write | [Atera] Set the value of a named custom field on an SLA. slaId is the SLA's internal id; fieldName (exact, case-sensitive) from atera_list_custom_fields. bodyJson carries the new value — commonly {"Value": "..."}. Read the current value first with atera_get_sla_custom_field. |
atera_set_snmp_device_custom_field |
Pro | Write | [Atera] Set the value of a named custom field on an SNMP monitored device. snmpDeviceId from atera_list_snmp_devices; fieldName (exact, case-sensitive) from atera_list_custom_fields. bodyJson carries the new value — commonly {"Value": "..."}. Read the current value first with atera_get_snmp_device_custom_field. |
atera_set_tcp_device_custom_field |
Pro | Write | [Atera] Set the value of a named custom field on a TCP monitored device. tcpDeviceId from atera_list_tcp_devices; fieldName (exact, case-sensitive) from atera_list_custom_fields. bodyJson carries the new value — commonly {"Value": "..."}. Read the current value first with atera_get_tcp_device_custom_field. |
atera_set_ticket_custom_field |
Pro | Write | [Atera] Set the value of a named custom field on a ticket. ticketId from atera_list_tickets; fieldName (exact, case-sensitive) from atera_list_custom_fields. bodyJson carries the new value — commonly {"Value": "..."}. Read the current value first with atera_get_ticket_custom_field. |
atera_get_agent_custom_field parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
agentId |
integer | yes | Agent id (from atera_list_agents / atera_get_agent). | |
fieldName |
string | yes | Exact custom-field name (case-sensitive) from atera_list_custom_fields. |
atera_get_contact_custom_field parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contactId |
integer | yes | Contact id (from atera_list_contacts / atera_get_contact). | |
fieldName |
string | yes | Exact custom-field name (case-sensitive) from atera_list_custom_fields. |
atera_get_contract_custom_field parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contractId |
integer | yes | Contract id (from atera_list_contracts / atera_get_contract). | |
fieldName |
string | yes | Exact custom-field name (case-sensitive) from atera_list_custom_fields. |
atera_get_custom_value parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
rowId |
string | yes | Internal custom-value row id — a GUID string (CustomFieldValueID), e.g. "9f1c2b3a-0000-4d5e-8a9b-abcdef012345". |
atera_get_customer_custom_field parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
customerId |
integer | yes | Customer id (from atera_list_customers / atera_get_customer). | |
fieldName |
string | yes | Exact custom-field name (case-sensitive) from atera_list_custom_fields. |
atera_get_generic_device_custom_field parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldName |
string | yes | Exact custom-field name (case-sensitive) from atera_list_custom_fields. | |
genericDeviceId |
integer | yes | Generic device id (from atera_list_generic_devices / atera_get_generic_device). |
atera_get_http_device_custom_field parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldName |
string | yes | Exact custom-field name (case-sensitive) from atera_list_custom_fields. | |
httpDeviceId |
integer | yes | HTTP device id (from atera_list_http_devices / atera_get_http_device). |
atera_get_sla_custom_field parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldName |
string | yes | Exact custom-field name (case-sensitive) from atera_list_custom_fields. | |
slaId |
integer | yes | SLA id. |
atera_get_snmp_device_custom_field parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldName |
string | yes | Exact custom-field name (case-sensitive) from atera_list_custom_fields. | |
snmpDeviceId |
integer | yes | SNMP device id (from atera_list_snmp_devices / atera_get_snmp_device). |
atera_get_tcp_device_custom_field parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldName |
string | yes | Exact custom-field name (case-sensitive) from atera_list_custom_fields. | |
tcpDeviceId |
integer | yes | TCP device id (from atera_list_tcp_devices / atera_get_tcp_device). |
atera_get_ticket_custom_field parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldName |
string | yes | Exact custom-field name (case-sensitive) from atera_list_custom_fields. | |
ticketId |
integer | yes | Ticket id (from atera_list_tickets / atera_get_ticket). |
atera_list_agent_custom_fields parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
agentId |
integer | yes | Agent id (from atera_list_agents / atera_get_agent). |
atera_list_contact_custom_fields parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contactId |
integer | yes | Contact id (from atera_list_contacts / atera_get_contact). |
atera_list_contract_custom_fields parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contractId |
integer | yes | Contract id (from atera_list_contracts / atera_get_contract). |
atera_list_customer_custom_fields parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
customerId |
integer | yes | Customer id (from atera_list_customers / atera_get_customer). |
atera_list_generic_device_custom_fields parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
genericDeviceId |
integer | yes | Generic device id (from atera_list_generic_devices / atera_get_generic_device). |
atera_list_http_device_custom_fields parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
httpDeviceId |
integer | yes | HTTP device id (from atera_list_http_devices / atera_get_http_device). |
atera_list_sla_custom_fields parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
slaId |
integer | yes | SLA id. |
atera_list_snmp_device_custom_fields parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
snmpDeviceId |
integer | yes | SNMP device id (from atera_list_snmp_devices / atera_get_snmp_device). |
atera_list_tcp_device_custom_fields parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
tcpDeviceId |
integer | yes | TCP device id (from atera_list_tcp_devices / atera_get_tcp_device). |
atera_list_ticket_custom_fields parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
ticketId |
integer | yes | Ticket id (from atera_list_tickets / atera_get_ticket). |
atera_set_agent_custom_field parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
agentId |
integer | yes | Agent id (from atera_list_agents / atera_get_agent). | |
bodyJson |
string | yes | JSON body carrying the new value, e.g. {"Value": "..."}. | |
fieldName |
string | yes | Exact custom-field name (case-sensitive) from atera_list_custom_fields. |
atera_set_contact_custom_field parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
bodyJson |
string | yes | JSON body carrying the new value, e.g. {"Value": "..."}. | |
contactId |
integer | yes | Contact id (from atera_list_contacts / atera_get_contact). | |
fieldName |
string | yes | Exact custom-field name (case-sensitive) from atera_list_custom_fields. |
atera_set_contract_custom_field parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
bodyJson |
string | yes | JSON body carrying the new value, e.g. {"Value": "..."}. | |
contractId |
integer | yes | Contract id (from atera_list_contracts / atera_get_contract). | |
fieldName |
string | yes | Exact custom-field name (case-sensitive) from atera_list_custom_fields. |
atera_set_customer_custom_field parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
bodyJson |
string | yes | JSON body carrying the new value, e.g. {"Value": "..."}. | |
customerId |
integer | yes | Customer id (from atera_list_customers / atera_get_customer). | |
fieldName |
string | yes | Exact custom-field name (case-sensitive) from atera_list_custom_fields. |
atera_set_generic_device_custom_field parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
bodyJson |
string | yes | JSON body carrying the new value, e.g. {"Value": "..."}. | |
fieldName |
string | yes | Exact custom-field name (case-sensitive) from atera_list_custom_fields. | |
genericDeviceId |
integer | yes | Generic device id (from atera_list_generic_devices / atera_get_generic_device). |
atera_set_http_device_custom_field parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
bodyJson |
string | yes | JSON body carrying the new value, e.g. {"Value": "..."}. | |
fieldName |
string | yes | Exact custom-field name (case-sensitive) from atera_list_custom_fields. | |
httpDeviceId |
integer | yes | HTTP device id (from atera_list_http_devices / atera_get_http_device). |
atera_set_sla_custom_field parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
bodyJson |
string | yes | JSON body carrying the new value, e.g. {"Value": "..."}. | |
fieldName |
string | yes | Exact custom-field name (case-sensitive) from atera_list_custom_fields. | |
slaId |
integer | yes | SLA id. |
atera_set_snmp_device_custom_field parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
bodyJson |
string | yes | JSON body carrying the new value, e.g. {"Value": "..."}. | |
fieldName |
string | yes | Exact custom-field name (case-sensitive) from atera_list_custom_fields. | |
snmpDeviceId |
integer | yes | SNMP device id (from atera_list_snmp_devices / atera_get_snmp_device). |
atera_set_tcp_device_custom_field parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
bodyJson |
string | yes | JSON body carrying the new value, e.g. {"Value": "..."}. | |
fieldName |
string | yes | Exact custom-field name (case-sensitive) from atera_list_custom_fields. | |
tcpDeviceId |
integer | yes | TCP device id (from atera_list_tcp_devices / atera_get_tcp_device). |
atera_set_ticket_custom_field parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
bodyJson |
string | yes | JSON body carrying the new value, e.g. {"Value": "..."}. | |
fieldName |
string | yes | Exact custom-field name (case-sensitive) from atera_list_custom_fields. | |
ticketId |
integer | yes | Ticket id (from atera_list_tickets / atera_get_ticket). |