Skip to main content
Tools Reference

Atera Tools

Written By Christopher Scaminaci

Last updated 7 days ago

Atera Tools

atera_ · 115 tools · Free 67 · Pro 48 RMM and PSA: customers, contacts, agents, devices, alerts, tickets and billing. The credential is an Atera API key, account-wide with no per-endpoint scoping, against a fixed global host. Paging is a page number with an items-per-page size capped at 50. Devices split into four families - generic, HTTP, SNMP and TCP - and SNMP creation splits again by version. Billing lookups by invoice number return a single record rather than a list.

All connector tools · Atera setup guide

Atera tool groups

Agents

ToolPlanAccessSummary
atera_delete_agentProDestructivePermanently delete (uninstall) an RMM agent by its numeric AgentID (from atera_list_agents).
atera_get_agentFreeRead-onlyGet the full detail of a single RMM agent by its numeric AgentID (from atera_list_agents or atera_list_agents_by_customer).
atera_get_agents_by_machineFreeRead-onlyGet the RMM agent(s) installed on a machine identified by its machine name (hostname).
atera_list_agent_available_patchesFreeRead-onlyList 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_list_agent_installed_patchesFreeRead-onlyList 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_agentsFreeRead-onlyList all RMM agents (monitoring software installed on managed machines) across every customer.
atera_list_agents_by_customerFreeRead-onlyList the RMM agents belonging to a single customer, identified by its numeric CustomerID (from atera_list_customers).

[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).

ParamTypeRequiredDefaultDescription
agentIdintegeryesThe numeric AgentID to delete (from atera_list_agents).

[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.).

ParamTypeRequiredDefaultDescription
agentIdintegeryesThe numeric AgentID (from atera_list_agents).

[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.

ParamTypeRequiredDefaultDescription
machineNamestringyesThe machine name (hostname) to look up, e.g. "DESKTOP-ABC123".

[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.

ParamTypeRequiredDefaultDescription
deviceGuidstringyesThe agent's DeviceGuid (a GUID string, from the DeviceGuid field on atera_get_agent / atera_list_agents).

[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.

ParamTypeRequiredDefaultDescription
deviceGuidstringyesThe agent's DeviceGuid (a GUID string, from the DeviceGuid field on atera_get_agent / atera_list_agents).

[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.

ParamTypeRequiredDefaultDescription
itemsInPageintegerno50Results per page (1-500; values above 500 are clamped to Atera's maximum for this endpoint).
pageintegerno11-based page number (default 1).

[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.

ParamTypeRequiredDefaultDescription
customerIdintegeryesThe numeric CustomerID to scope to (from atera_list_customers).
itemsInPageintegerno50Results per page (1-500; values above 500 are clamped to Atera's maximum for this endpoint).
pageintegerno11-based page number (default 1).

Devices

ToolPlanAccessSummary
atera_create_generic_deviceProWriteCreate a generic monitored device (a device pinged/monitored without a family-specific protocol).
atera_create_http_deviceProWriteCreate an HTTP monitored device (website/endpoint uptime + content check).
atera_create_snmp_device_v1v2ProWriteCreate an SNMP-monitored device using SNMP v1 or v2c.
atera_create_snmp_device_v3ProWriteCreate an SNMP-monitored device using SNMP v3 (user-based security model).
atera_create_tcp_deviceProWriteCreate a TCP monitored device (port-reachability check on a host).
atera_delete_generic_deviceProDestructivePermanently delete a generic monitored device by its numeric DeviceID (from atera_list_generic_devices).
atera_delete_http_deviceProDestructivePermanently delete an HTTP monitored device by its numeric DeviceID (from atera_list_http_devices).
atera_delete_snmp_deviceProDestructivePermanently delete an SNMP monitored device by its numeric DeviceID (from atera_list_snmp_devices).
atera_delete_tcp_deviceProDestructivePermanently delete a TCP monitored device by its numeric DeviceID (from atera_list_tcp_devices).
atera_get_generic_deviceFreeRead-onlyGet a single generic monitored device by its numeric DeviceID (from atera_list_generic_devices).
atera_get_http_deviceFreeRead-onlyGet a single HTTP monitored device by its numeric DeviceID (from atera_list_http_devices).
atera_get_snmp_deviceFreeRead-onlyGet a single SNMP monitored device by its numeric DeviceID (from atera_list_snmp_devices).
atera_get_tcp_deviceFreeRead-onlyGet a single TCP monitored device by its numeric DeviceID (from atera_list_tcp_devices).
atera_list_generic_devicesFreeRead-onlyList all generic monitored devices.
atera_list_http_devicesFreeRead-onlyList all HTTP monitored devices.
atera_list_snmp_devicesFreeRead-onlyList all SNMP monitored devices (both v1/v2c and v3).
atera_list_tcp_devicesFreeRead-onlyList all TCP monitored devices.

[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.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesGeneric-device DTO JSON. Include the device name, owning CustomerID, and the host/IP to monitor per Atera's schema.

[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).

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesHTTP-device DTO JSON. Include the device name, owning CustomerID, the URL to monitor, and any expected content/pattern per Atera's schema.

[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).

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesSNMP v1/v2c device DTO JSON. Include the device name, owning CustomerID, host/IP, port, and community string per Atera's schema.

[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).

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesSNMP 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 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).

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesTCP-device DTO JSON. Include the device name, owning CustomerID, host/IP, and the TCP port(s) to monitor per Atera's schema.

[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).

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe numeric DeviceID to delete (from atera_list_generic_devices).

[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).

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe numeric DeviceID to delete (from atera_list_http_devices).

[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).

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe numeric DeviceID to delete (from atera_list_snmp_devices).

[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).

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe numeric DeviceID to delete (from atera_list_tcp_devices).

[Atera] Get a single generic monitored device by its numeric DeviceID (from atera_list_generic_devices). Returns the raw Atera device JSON.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe numeric DeviceID (from atera_list_generic_devices).

[Atera] Get a single HTTP monitored device by its numeric DeviceID (from atera_list_http_devices). Returns the raw Atera device JSON.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe numeric DeviceID (from atera_list_http_devices).

[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.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe numeric DeviceID (from atera_list_snmp_devices).

[Atera] Get a single TCP monitored device by its numeric DeviceID (from atera_list_tcp_devices). Returns the raw Atera device JSON.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe numeric DeviceID (from atera_list_tcp_devices).

[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.

ParamTypeRequiredDefaultDescription
itemsInPageintegerno50Results per page (1-500; values above 500 are clamped to Atera's maximum for this endpoint).
pageintegerno11-based page number (default 1).

[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.

ParamTypeRequiredDefaultDescription
itemsInPageintegerno50Results per page (1-500; values above 500 are clamped to Atera's maximum for this endpoint).
pageintegerno11-based page number (default 1).

[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.

ParamTypeRequiredDefaultDescription
itemsInPageintegerno50Results per page (1-500; values above 500 are clamped to Atera's maximum for this endpoint).
pageintegerno11-based page number (default 1).

[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.

ParamTypeRequiredDefaultDescription
itemsInPageintegerno50Results per page (1-500; values above 500 are clamped to Atera's maximum for this endpoint).
pageintegerno11-based page number (default 1).

Alerts

ToolPlanAccessSummary
atera_create_alertProWriteRaise a new alert.
atera_delete_alertProDestructivePermanently delete (clear) an alert by its numeric AlertID (from atera_list_alerts).
atera_get_alertFreeRead-onlyGet the full detail of a single alert by its numeric AlertID (from atera_list_alerts).
atera_list_alertsFreeRead-onlyList monitoring alerts across all agents and devices.
atera_update_alertProWriteUpdate an alert by its numeric AlertID (from atera_list_alerts).

[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).

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesAlert DTO JSON. Include the title/message, severity, and source (owning device/agent/customer) per Atera's schema.

[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).

ParamTypeRequiredDefaultDescription
alertIdintegeryesThe numeric AlertID to delete (from atera_list_alerts).

[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.).

ParamTypeRequiredDefaultDescription
alertIdintegeryesThe numeric AlertID (from atera_list_alerts).

[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.

ParamTypeRequiredDefaultDescription
alertStatusstringnonullOptional 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.
itemsInPageintegerno50Results per page (default 20; Atera documents no maximum for alerts — StackJack clamps at 50 as a safety cap).
pageintegerno11-based page number (default 1).

[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.

ParamTypeRequiredDefaultDescription
alertIdintegeryesThe numeric AlertID to update (from atera_list_alerts).
fieldsJsonstringyesAlert DTO JSON with the fields to change (e.g. AlertStatus, Severity, Title).

Knowledge Base

ToolPlanAccessSummary
atera_list_knowledgebase_articlesFreeRead-onlyList the knowledge-base articles configured in the Atera account.

[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.

ParamTypeRequiredDefaultDescription
itemsInPageintegerno50Results per page (1-500; values above 500 are clamped to Atera's maximum for this endpoint).
pageintegerno11-based page number (default 1).

Account

ToolPlanAccessSummary
atera_get_accountFreeRead-onlyGet the Atera account/tenant profile — the top-level account info for the API key in use (account name, plan/edition, and account-level identifiers).

[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

ToolPlanAccessSummary
atera_create_departmentProWriteCreate a help-desk department.
atera_delete_departmentProDestructivePermanently delete a help-desk department by its numeric department id (from atera_list_departments).
atera_get_departmentFreeRead-onlyGet a single help-desk department by its numeric department id (from atera_list_departments).
atera_list_departmentsFreeRead-onlyList the help-desk departments defined in the Atera account.
atera_update_departmentProWriteUpdate a help-desk department by its numeric department id (from atera_list_departments).

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesDepartment DTO JSON — typically the department Name per Atera's schema.

[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).

ParamTypeRequiredDefaultDescription
departmentIdintegeryesThe department id to delete (from atera_list_departments).

[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.

ParamTypeRequiredDefaultDescription
departmentIdintegeryesThe department id (from atera_list_departments).

[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.

ParamTypeRequiredDefaultDescription
itemsInPageintegerno50Records per page (1-500, default 50; max 500 — Atera's documented ceiling for this endpoint; larger values are clamped to 500).
pageintegerno1Page number to return (1-based, default 1).

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesDepartment DTO JSON with the fields to change (e.g. Name).
departmentIdintegeryesThe department id to update (from atera_list_departments).

Customers

ToolPlanAccessSummary
atera_create_customerProWriteCreate a customer (company/organization).
atera_create_customer_attachmentProWriteAttach a file to a customer.
atera_create_customer_folderProWriteCreate a customer folder (a grouping/organizational folder used to organize customers).
atera_delete_customerProDestructivePermanently delete a customer by CustomerID (from atera_list_customers).
atera_get_customerFreeRead-onlyGet a single customer by CustomerID (from atera_list_customers).
atera_list_customersFreeRead-onlyList the customers (companies/organizations) in your Atera account.
atera_update_customerProWriteUpdate a customer by CustomerID (from atera_list_customers).

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object body for the new customer. Required: CustomerName. Optional: BusinessNumber, Domain, Address, City, State, Country, Phone, Notes.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object body: the target CustomerID plus the file content (base64) and filename, per Atera's attachment schema.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object body describing the folder (e.g. FolderName, optional parent folder id).

[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.

ParamTypeRequiredDefaultDescription
customerIdintegeryesThe CustomerID of the customer to delete (from atera_list_customers).

[Atera] Get a single customer by CustomerID (from atera_list_customers). Returns the full customer profile.

ParamTypeRequiredDefaultDescription
customerIdintegeryesThe CustomerID of the customer (from atera_list_customers).

[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.

ParamTypeRequiredDefaultDescription
itemsInPageintegerno50Records per page (1-500, default 50; max 500 — Atera's documented ceiling for this endpoint; larger values are clamped to 500).
pageintegerno1Page number to return (1-based, default 1).

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object body with the customer fields to change (e.g. CustomerName, Address, City, State, Country, Phone, Notes).
customerIdintegeryesThe CustomerID of the customer to update (from atera_list_customers).

Contacts

ToolPlanAccessSummary
atera_create_contactProWriteCreate an end-user contact under a customer.
atera_delete_contactProDestructivePermanently delete an end-user contact by its contact id (EndUserID, from atera_list_contacts).
atera_get_contactFreeRead-onlyGet a single end-user contact by its contact id (EndUserID, from atera_list_contacts).
atera_list_contactsFreeRead-onlyList the end-user contacts across your customers.
atera_update_contactProWriteUpdate an end-user contact by its contact id (EndUserID, from atera_list_contacts).

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object body for the new contact. Required: CustomerID, Email. Optional: Firstname, Lastname, Phone, JobTitle, IsContactPerson.

[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.

ParamTypeRequiredDefaultDescription
contactIdintegeryesThe contact id (EndUserID) of the contact to delete (from atera_list_contacts).

[Atera] Get a single end-user contact by its contact id (EndUserID, from atera_list_contacts). Returns the full contact profile.

ParamTypeRequiredDefaultDescription
contactIdintegeryesThe contact id (EndUserID) of the contact (from atera_list_contacts).

[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.

ParamTypeRequiredDefaultDescription
itemsInPageintegerno50Records per page (1-500, default 50; max 500 — Atera's documented ceiling for this endpoint; larger values are clamped to 500).
pageintegerno1Page number to return (1-based, default 1).

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object body with the contact fields to change (e.g. Firstname, Lastname, Email, Phone, JobTitle).
contactIdintegeryesThe contact id (EndUserID) of the contact to update (from atera_list_contacts).

Contracts

ToolPlanAccessSummary
atera_create_contractProWriteCreate a contract (billing agreement) for a customer.
atera_get_contractFreeRead-onlyGet a single contract by ContractID (from atera_list_contracts or atera_list_contracts_by_customer).
atera_list_contractsFreeRead-onlyList all contracts (billing agreements) in your Atera account.
atera_list_contracts_by_customerFreeRead-onlyList the contracts for a single customer, identified by CustomerID (from atera_list_customers).
atera_update_contractProWriteUpdate a contract by ContractID (from atera_list_contracts).

[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).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesContract DTO JSON. Typically requires CustomerID, ContractName, ContractType, and rate/period details per Atera's schema.

[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.

ParamTypeRequiredDefaultDescription
contractIdintegeryesThe ContractID of the contract (from atera_list_contracts).

[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.

ParamTypeRequiredDefaultDescription
itemsInPageintegerno50Records per page (1-500, default 50; max 500 — Atera's documented ceiling for this endpoint; larger values are clamped to 500).
pageintegerno1Page number to return (1-based, default 1).

[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).

ParamTypeRequiredDefaultDescription
customerIdintegeryesThe CustomerID whose contracts to list (from atera_list_customers).
itemsInPageintegerno50Records per page (1-500, default 50; max 500 — Atera's documented ceiling for this endpoint; larger values are clamped to 500).
pageintegerno1Page number to return (1-based, default 1).

[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).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesContract DTO JSON with the fields to change (e.g. ContractName, ContractType, rates, billing period).
contractIdintegeryesThe ContractID of the contract to update (from atera_list_contracts).

Tickets

ToolPlanAccessSummary
atera_add_ticket_commentProWriteAdd a comment to a ticket by TicketID (from atera_list_tickets).
atera_add_ticket_relationProWriteLink a ticket to another ticket, by TicketID (from atera_list_tickets) — vendor endpoint POST /tickets//relations.
atera_create_ticketProWriteCreate a help-desk ticket.
atera_delete_ticketProDestructivePermanently delete a ticket by TicketID (from atera_list_tickets).
atera_delete_ticket_relationProDestructiveDelete a relation from a ticket by TicketID + the relation's RelationType, vendor endpoint DELETE /tickets//relations/.
atera_get_ticketFreeRead-onlyGet a single ticket by TicketID (from atera_list_tickets).
atera_get_ticket_billable_durationFreeRead-onlyGet the total billable duration logged against a ticket by TicketID (from atera_list_tickets).
atera_get_ticket_billable_workhours_site_durationFreeRead-onlyGet 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…
atera_get_ticket_commentsFreeRead-onlyGet the comment/conversation thread for a ticket by TicketID (from atera_list_tickets).
atera_get_ticket_nonbillable_durationFreeRead-onlyGet the total non-billable duration logged against a ticket by TicketID (from atera_list_tickets).
atera_get_ticket_workhoursFreeRead-onlyGet the aggregate work-hours summary for a ticket by TicketID (from atera_list_tickets) — the combined billable + non-billable time.
atera_list_ticket_attachmentsFreeRead-onlyList the attachment METADATA (filenames, ids, sizes, upload timestamps) for a ticket by TicketID (from atera_list_tickets).
atera_list_ticket_workhours_recordsFreeRead-onlyList the individual work-hours (time-entry) records for a ticket by TicketID (from atera_list_tickets).
atera_list_ticketsFreeRead-onlyList help-desk tickets.
atera_list_tickets_billable_durationFreeRead-onlyGet the billable duration for a BATCH of tickets in one call (vendor endpoint POST /tickets/billableduration).
atera_list_tickets_last_modifiedFreeRead-onlyList 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.
atera_list_tickets_status_modifiedFreeRead-onlyList tickets whose status changed (e.g. resolved/closed tickets by status-change date) — useful for reporting on recently closed work.
atera_update_ticketProWriteUpdate a ticket by TicketID (from atera_list_tickets).

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesComment DTO JSON — typically the comment text/body, author, and internal/public flag per Atera's schema.
ticketIdintegeryesThe TicketID to comment on (from atera_list_tickets).

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRelation DTO JSON: {"RelatedTicketId": <int64>, "RelationType": "<string>"}.
ticketIdintegeryesThe TicketID to add a relation to (from atera_list_tickets).

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object body for the new ticket. Required: TicketTitle, EndUserID. Optional: Description, TicketPriority, TicketType, TicketStatus, TechnicianContactID.

[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.

ParamTypeRequiredDefaultDescription
ticketIdintegeryesThe TicketID of the ticket to delete (from atera_list_tickets).

[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).

ParamTypeRequiredDefaultDescription
relationTypestringyesThe RelationType string label to remove from the ticket.
ticketIdintegeryesThe TicketID whose relation to delete (from atera_list_tickets).

[Atera] Get a single ticket by TicketID (from atera_list_tickets). Returns the full ticket record.

ParamTypeRequiredDefaultDescription
ticketIdintegeryesThe TicketID of the ticket (from atera_list_tickets).

[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.

ParamTypeRequiredDefaultDescription
ticketIdintegeryesThe TicketID whose billable duration to fetch (from atera_list_tickets).

[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.

ParamTypeRequiredDefaultDescription
ticketIdsJsonstringyesJSON array of up to 50 TicketIDs (int64), e.g. [123,456] (from atera_list_tickets).

[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).

ParamTypeRequiredDefaultDescription
ticketIdintegeryesThe TicketID whose comments to fetch (from atera_list_tickets).

[Atera] Get the total non-billable duration logged against a ticket by TicketID (from atera_list_tickets). Pairs with atera_get_ticket_billable_duration.

ParamTypeRequiredDefaultDescription
ticketIdintegeryesThe TicketID whose non-billable duration to fetch (from atera_list_tickets).

[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.

ParamTypeRequiredDefaultDescription
ticketIdintegeryesThe TicketID whose work-hours summary to fetch (from atera_list_tickets).

[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.

ParamTypeRequiredDefaultDescription
ticketIdintegeryesThe TicketID whose attachments to list (from atera_list_tickets).

[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.

ParamTypeRequiredDefaultDescription
ticketIdintegeryesThe TicketID whose work-hours records to list (from atera_list_tickets).

[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.

ParamTypeRequiredDefaultDescription
itemsInPageintegerno50Records per page (default 50, max 50 — Atera's ceiling; larger values are clamped to 50).
pageintegerno1Page number to return (1-based, default 1).
ticketStatusstringnonullOptional status filter (e.g. Open, Pending, Resolved, Closed). Leave null for all statuses.

[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.

ParamTypeRequiredDefaultDescription
ticketIdsJsonstringyesJSON array of up to 50 TicketIDs (int64), e.g. [123,456,789] (from atera_list_tickets).

[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.

ParamTypeRequiredDefaultDescription
itemsInPageintegerno50Records per page (default 50, max 50 — Atera's ceiling; larger values are clamped to 50).
pageintegerno1Page number to return (1-based, default 1).

[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).

ParamTypeRequiredDefaultDescription
itemsInPageintegerno50Records per page (default 50, max 50 — Atera's ceiling; larger values are clamped to 50).
pageintegerno1Page number to return (1-based, default 1).

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object body with the ticket fields to change (e.g. TicketStatus, TicketPriority, TicketType, TicketTitle, TechnicianContactID).
ticketIdintegeryesThe TicketID of the ticket to update (from atera_list_tickets).

Billing

ToolPlanAccessSummary
atera_get_invoiceFreeRead-onlyGet 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.
atera_list_invoicesFreeRead-onlyList billing invoices.

[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.

ParamTypeRequiredDefaultDescription
invoiceNumberstringyesThe invoice NUMBER (not id) of the invoice to fetch (from atera_list_invoices).

[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.

ParamTypeRequiredDefaultDescription
itemsInPageintegerno50Records per page (1-500, default 50; max 500 — Atera's documented ceiling for this endpoint; larger values are clamped to 500).
pageintegerno1Page number to return (1-based, default 1).

Rates

ToolPlanAccessSummary
atera_create_expenseProWriteCreate a billable expense in the rates catalog.
atera_create_productProWriteCreate a billable product in the rates catalog.
atera_delete_expenseProDestructivePermanently delete a billable expense by ExpenseID (from atera_list_expenses).
atera_delete_productProDestructivePermanently delete a billable product by ProductID (from atera_list_products).
atera_get_expenseFreeRead-onlyGet a single billable expense by ExpenseID (from atera_list_expenses).
atera_get_productFreeRead-onlyGet a single billable product by ProductID (from atera_list_products).
atera_list_expensesFreeRead-onlyList the billable expenses in your rates catalog.
atera_list_productsFreeRead-onlyList the billable products in your rates catalog.
atera_update_expenseProWriteUpdate a billable expense by ExpenseID (from atera_list_expenses).
atera_update_productProWriteUpdate a billable product by ProductID (from atera_list_products).

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object body for the new expense (e.g. name, amount, category).

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object body for the new product (e.g. name, SKU, price, category).

[Atera] Permanently delete a billable expense by ExpenseID (from atera_list_expenses). This cannot be undone. Use with care.

ParamTypeRequiredDefaultDescription
expenseIdintegeryesThe ExpenseID of the expense to delete (from atera_list_expenses).

[Atera] Permanently delete a billable product by ProductID (from atera_list_products). This cannot be undone. Use with care.

ParamTypeRequiredDefaultDescription
productIdintegeryesThe ProductID of the product to delete (from atera_list_products).

[Atera] Get a single billable expense by ExpenseID (from atera_list_expenses). Returns the full expense record.

ParamTypeRequiredDefaultDescription
expenseIdintegeryesThe ExpenseID of the expense (from atera_list_expenses).

[Atera] Get a single billable product by ProductID (from atera_list_products). Returns the full product record.

ParamTypeRequiredDefaultDescription
productIdintegeryesThe ProductID of the product (from atera_list_products).

[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.

ParamTypeRequiredDefaultDescription
itemsInPageintegerno50Records per page (1-500, default 50; max 500 — Atera's documented ceiling for this endpoint; larger values are clamped to 500).
pageintegerno1Page number to return (1-based, default 1).

[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.

ParamTypeRequiredDefaultDescription
itemsInPageintegerno50Records per page (1-500, default 50; max 500 — Atera's documented ceiling for this endpoint; larger values are clamped to 500).
pageintegerno1Page number to return (1-based, default 1).

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object body with the expense fields to change (e.g. name, amount, category).
expenseIdintegeryesThe ExpenseID of the expense to update (from atera_list_expenses).

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object body with the product fields to change (e.g. name, SKU, price, category).
productIdintegeryesThe ProductID of the product to update (from atera_list_products).

Custom Values

ToolPlanAccessSummary
atera_get_agent_custom_fieldFreeRead-onlyGet the value of a named custom field on an agent (installed device).
atera_get_contact_custom_fieldFreeRead-onlyGet the value of a named custom field on a contact (end user).
atera_get_contract_custom_fieldFreeRead-onlyGet the value of a named custom field on a contract.
atera_get_custom_valueFreeRead-onlyFetch a single custom-value record by its internal row id — a GUID string (the CustomFieldValueID Atera assigns each stored value), NOT a number.
atera_get_customer_custom_fieldFreeRead-onlyGet the value of a named custom field on a customer (managed organization).
atera_get_generic_device_custom_fieldFreeRead-onlyGet the value of a named custom field on a generic monitored device.
atera_get_http_device_custom_fieldFreeRead-onlyGet the value of a named custom field on an HTTP monitored device.
atera_get_sla_custom_fieldFreeRead-onlyGet the value of a named custom field on an SLA.
atera_get_snmp_device_custom_fieldFreeRead-onlyGet the value of a named custom field on an SNMP monitored device.
atera_get_tcp_device_custom_fieldFreeRead-onlyGet the value of a named custom field on a TCP monitored device.
atera_get_ticket_custom_fieldFreeRead-onlyGet the value of a named custom field on a ticket.
atera_list_agent_custom_fieldsFreeRead-onlyList ALL custom-field values set on an agent, by agentId (from atera_list_agents).
atera_list_contact_custom_fieldsFreeRead-onlyList ALL custom-field values set on a contact, by contactId (from atera_list_contacts).
atera_list_contract_custom_fieldsFreeRead-onlyList ALL custom-field values set on a contract, by contractId (from atera_list_contracts).
atera_list_custom_fieldsFreeRead-onlyList 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.
atera_list_customer_custom_fieldsFreeRead-onlyList ALL custom-field values set on a customer, by customerId (from atera_list_customers).
atera_list_generic_device_custom_fieldsFreeRead-onlyList ALL custom-field values set on a generic monitored device, by genericDeviceId (from atera_list_generic_devices).
atera_list_http_device_custom_fieldsFreeRead-onlyList ALL custom-field values set on an HTTP monitored device, by httpDeviceId (from atera_list_http_devices).
atera_list_sla_custom_fieldsFreeRead-onlyList ALL custom-field values set on an SLA, by slaId.
atera_list_snmp_device_custom_fieldsFreeRead-onlyList ALL custom-field values set on an SNMP monitored device, by snmpDeviceId (from atera_list_snmp_devices).
atera_list_tcp_device_custom_fieldsFreeRead-onlyList ALL custom-field values set on a TCP monitored device, by tcpDeviceId (from atera_list_tcp_devices).
atera_list_ticket_custom_fieldsFreeRead-onlyList ALL custom-field values set on a ticket, by ticketId (from atera_list_tickets).
atera_set_agent_custom_fieldProWriteSet the value of a named custom field on an agent.
atera_set_contact_custom_fieldProWriteSet the value of a named custom field on a contact (end user).
atera_set_contract_custom_fieldProWriteSet the value of a named custom field on a contract.
atera_set_customer_custom_fieldProWriteSet the value of a named custom field on a customer (managed organization).
atera_set_generic_device_custom_fieldProWriteSet the value of a named custom field on a generic monitored device.
atera_set_http_device_custom_fieldProWriteSet the value of a named custom field on an HTTP monitored device.
atera_set_sla_custom_fieldProWriteSet the value of a named custom field on an SLA.
atera_set_snmp_device_custom_fieldProWriteSet the value of a named custom field on an SNMP monitored device.
atera_set_tcp_device_custom_fieldProWriteSet the value of a named custom field on a TCP monitored device.
atera_set_ticket_custom_fieldProWriteSet the value of a named custom field on a ticket.

[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.

ParamTypeRequiredDefaultDescription
agentIdintegeryesAgent id (from atera_list_agents / atera_get_agent).
fieldNamestringyesExact custom-field name (case-sensitive) from atera_list_custom_fields.

[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.

ParamTypeRequiredDefaultDescription
contactIdintegeryesContact id (from atera_list_contacts / atera_get_contact).
fieldNamestringyesExact custom-field name (case-sensitive) from atera_list_custom_fields.

[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.

ParamTypeRequiredDefaultDescription
contractIdintegeryesContract id (from atera_list_contracts / atera_get_contract).
fieldNamestringyesExact custom-field name (case-sensitive) from atera_list_custom_fields.

[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.

ParamTypeRequiredDefaultDescription
rowIdstringyesInternal custom-value row id — a GUID string (CustomFieldValueID), e.g. "9f1c2b3a-0000-4d5e-8a9b-abcdef012345".

[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.

ParamTypeRequiredDefaultDescription
customerIdintegeryesCustomer id (from atera_list_customers / atera_get_customer).
fieldNamestringyesExact custom-field name (case-sensitive) from atera_list_custom_fields.

[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.

ParamTypeRequiredDefaultDescription
fieldNamestringyesExact custom-field name (case-sensitive) from atera_list_custom_fields.
genericDeviceIdintegeryesGeneric device id (from atera_list_generic_devices / atera_get_generic_device).

[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.

ParamTypeRequiredDefaultDescription
fieldNamestringyesExact custom-field name (case-sensitive) from atera_list_custom_fields.
httpDeviceIdintegeryesHTTP device id (from atera_list_http_devices / atera_get_http_device).

[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.

ParamTypeRequiredDefaultDescription
fieldNamestringyesExact custom-field name (case-sensitive) from atera_list_custom_fields.
slaIdintegeryesSLA id.

[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.

ParamTypeRequiredDefaultDescription
fieldNamestringyesExact custom-field name (case-sensitive) from atera_list_custom_fields.
snmpDeviceIdintegeryesSNMP device id (from atera_list_snmp_devices / atera_get_snmp_device).

[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.

ParamTypeRequiredDefaultDescription
fieldNamestringyesExact custom-field name (case-sensitive) from atera_list_custom_fields.
tcpDeviceIdintegeryesTCP device id (from atera_list_tcp_devices / atera_get_tcp_device).

[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.

ParamTypeRequiredDefaultDescription
fieldNamestringyesExact custom-field name (case-sensitive) from atera_list_custom_fields.
ticketIdintegeryesTicket id (from atera_list_tickets / atera_get_ticket).

[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.

ParamTypeRequiredDefaultDescription
agentIdintegeryesAgent id (from atera_list_agents / atera_get_agent).

[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.

ParamTypeRequiredDefaultDescription
contactIdintegeryesContact id (from atera_list_contacts / atera_get_contact).

[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.

ParamTypeRequiredDefaultDescription
contractIdintegeryesContract id (from atera_list_contracts / atera_get_contract).

[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 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.

ParamTypeRequiredDefaultDescription
customerIdintegeryesCustomer id (from atera_list_customers / atera_get_customer).

[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.

ParamTypeRequiredDefaultDescription
genericDeviceIdintegeryesGeneric device id (from atera_list_generic_devices / atera_get_generic_device).

[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.

ParamTypeRequiredDefaultDescription
httpDeviceIdintegeryesHTTP device id (from atera_list_http_devices / atera_get_http_device).

[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.

ParamTypeRequiredDefaultDescription
slaIdintegeryesSLA id.

[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.

ParamTypeRequiredDefaultDescription
snmpDeviceIdintegeryesSNMP device id (from atera_list_snmp_devices / atera_get_snmp_device).

[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.

ParamTypeRequiredDefaultDescription
tcpDeviceIdintegeryesTCP device id (from atera_list_tcp_devices / atera_get_tcp_device).

[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.

ParamTypeRequiredDefaultDescription
ticketIdintegeryesTicket id (from atera_list_tickets / atera_get_ticket).

[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.

ParamTypeRequiredDefaultDescription
agentIdintegeryesAgent id (from atera_list_agents / atera_get_agent).
bodyJsonstringyesJSON body carrying the new value, e.g. {"Value": "..."}.
fieldNamestringyesExact custom-field name (case-sensitive) from atera_list_custom_fields.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON body carrying the new value, e.g. {"Value": "..."}.
contactIdintegeryesContact id (from atera_list_contacts / atera_get_contact).
fieldNamestringyesExact custom-field name (case-sensitive) from atera_list_custom_fields.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON body carrying the new value, e.g. {"Value": "..."}.
contractIdintegeryesContract id (from atera_list_contracts / atera_get_contract).
fieldNamestringyesExact custom-field name (case-sensitive) from atera_list_custom_fields.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON body carrying the new value, e.g. {"Value": "..."}.
customerIdintegeryesCustomer id (from atera_list_customers / atera_get_customer).
fieldNamestringyesExact custom-field name (case-sensitive) from atera_list_custom_fields.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON body carrying the new value, e.g. {"Value": "..."}.
fieldNamestringyesExact custom-field name (case-sensitive) from atera_list_custom_fields.
genericDeviceIdintegeryesGeneric device id (from atera_list_generic_devices / atera_get_generic_device).

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON body carrying the new value, e.g. {"Value": "..."}.
fieldNamestringyesExact custom-field name (case-sensitive) from atera_list_custom_fields.
httpDeviceIdintegeryesHTTP device id (from atera_list_http_devices / atera_get_http_device).

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON body carrying the new value, e.g. {"Value": "..."}.
fieldNamestringyesExact custom-field name (case-sensitive) from atera_list_custom_fields.
slaIdintegeryesSLA id.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON body carrying the new value, e.g. {"Value": "..."}.
fieldNamestringyesExact custom-field name (case-sensitive) from atera_list_custom_fields.
snmpDeviceIdintegeryesSNMP device id (from atera_list_snmp_devices / atera_get_snmp_device).

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON body carrying the new value, e.g. {"Value": "..."}.
fieldNamestringyesExact custom-field name (case-sensitive) from atera_list_custom_fields.
tcpDeviceIdintegeryesTCP device id (from atera_list_tcp_devices / atera_get_tcp_device).

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON body carrying the new value, e.g. {"Value": "..."}.
fieldNamestringyesExact custom-field name (case-sensitive) from atera_list_custom_fields.
ticketIdintegeryesTicket id (from atera_list_tickets / atera_get_ticket).