create-monitor

Create Atera Monitor

Create a threshold-based monitor for an agent including HTTP, TCP, or SNMP monitoring.

Prerequisites

• Valid Atera API key configured
• Agent must exist and be online
• User must have monitor creation permissions

Steps

1. Validate agent exists

   curl -s -X GET "https://app.atera.com/api/v3/agents/{agent_id}" \
     -H "X-API-KEY: $ATERA_API_KEY" \
     -H "Accept: application/json"
   

   • Verify agent exists
   • Capture device and customer info

2. Validate monitor parameters

   • Check monitor_type is valid (HTTP, TCP, SNMP)
   • Validate target format based on type
   • Set defaults for optional parameters

3. Create the monitor Based on monitor_type:

   For HTTP:

   curl -s -X POST "https://app.atera.com/api/v3/agents/{agent_id}/monitors/http" \
     -H "X-API-KEY: $ATERA_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "Name": "<name>",
       "URL": "<target>",
       "Interval": <interval>,
       "AlertSeverity": "<alert_severity>"
     }'
   

   For TCP:

   curl -s -X POST "https://app.atera.com/api/v3/agents/{agent_id}/monitors/tcp" \
     -H "X-API-KEY: $ATERA_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "Name": "<name>",
       "Port": <target>,
       "Interval": <interval>,
       "AlertSeverity": "<alert_severity>"
     }'
   

   For SNMP:

   curl -s -X POST "https://app.atera.com/api/v3/agents/{agent_id}/monitors/snmp" \
     -H "X-API-KEY: $ATERA_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "Name": "<name>",
       "OID": "<target>",
       "Threshold": "<threshold>",
       "Interval": <interval>,
       "AlertSeverity": "<alert_severity>"
     }'
   

4. Return monitor confirmation

   • Monitor ID
   • Monitor configuration summary
   • Agent and customer info

Parameters