Documentation

UptimeID is a real-time server monitoring solution. The Go-based agent delivers maximum performance with minimal resource usage, collecting CPU, memory, disk, and network metrics with a footprint of less than 10MB RAM.

Lightweight Go Agent

Single binary, no dependencies. Uses less than 10MB RAM.

Cross-Platform

Supports Linux, macOS, and Windows (amd64, arm64, arm).

Cloud-Based

No database setup or additional infrastructure required.

Real-Time Metrics

5-second interval by default with configurable refresh rates.

Quickstart

1. Create Account

Register at UptimeID to get an account. The Free Plan is sufficient to start with 2 servers, 3 uptime targets and 3 days of data retention.

2. Add System

In the dashboard, click the "Add System" button and name your server. The system will automatically generate an API key and install script.

3. Install Agent

Run the provided install script on your server:

curl -fsSL /api/install | bash -s -- \
  --api-key "YOUR_API_KEY" \
  --api-url "/api/metrics"

4. Monitor!

Once the agent is installed, your server will immediately appear on the dashboard with real-time metrics. You can view details, history graphs, and configure alert thresholds.

Agent Setup

The UptimeID agent is a lightweight Go binary that collects system metrics and sends them to the cloud dashboard. The agent supports Linux, macOS, and Windows.

Automatic Installation (Recommended)

After adding a system in the dashboard, run the provided install script. This script will automatically:

Detect OS and architecture
Download the appropriate binary from GitHub releases
Install to /opt/uptimeid
Setup systemd service (Linux) or launchd (macOS)

curl -fsSL /api/install | bash -s -- \
  --api-key "YOUR_API_KEY" \
  --api-url "/api/metrics"

Docker Compose

agent:
    image: ghcr.io/uptime-id/agent:latest
    restart: unless-stopped
    network_mode: host
    pid: host
    user: "0:0"
    security_opt:
      - apparmor:unconfined
    environment:
      - API_KEY=YOUR_API_KEY
      - API_URL=/api/metrics
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock:ro
      - /run/dbus/system_bus_socket:/run/dbus/system_bus_socket:ro
      - /var/log:/host/var/log:ro                                   
      - /run/log/journal:/run/log/journal:ro                      
      - /etc/machine-id:/etc/machine-id:ro

Security Note

The API key is generated when you add a new system in the dashboard. Keep your API key confidential and never share or commit it to version control.

Claim Server

If you installed the agent without using a specific API Key (e.g. using a temporary token or pre-built image), you need to "Claim" it to connect the server to your account.

How to Claim Server

Ensure the agent is running on the target server.
Check agent logs to get the Claim Token or claim URL.
Open the claim URL in your browser (format: /claim/[token]).
Log in to your UptimeID account if you haven't already.
Confirm the server name and click "Connect Server".

Supported Platforms

OS	Architecture	Binary Name
Linux	amd64 (x86_64)	`uptimeid-agent-linux-amd64`
Linux	arm64 (aarch64)	`uptimeid-agent-linux-arm64`
Linux	arm (armv7)	`uptimeid-agent-linux-arm`
macOS	amd64 (Intel)	`uptimeid-agent-darwin-amd64`
macOS	arm64 (Apple Silicon)	`uptimeid-agent-darwin-arm64`
Windows	amd64 (x86_64)	`uptimeid-agent-windows-amd64.exe`

Service Management (Linux)

# Check status
sudo systemctl status uptimeid-agent

# View logs
sudo journalctl -u uptimeid-agent -f

# Restart agent
sudo systemctl restart uptimeid-agent

# Stop agent
sudo systemctl stop uptimeid-agent

Environment Variables

Agent Configuration

Variable	Description	Required	Default
`API_KEY`	API key from dashboard (generated when adding system)	Yes	-
`API_URL`	Endpoint for sending metrics	Yes	/api/metrics

Environment File Location

When using the install script, the environment file is stored at:

# Linux/macOS
/opt/uptimeid/.env

# File content
API_KEY=your-api-key
API_URL=/api/metrics

Billing & Plans

UptimeID offers three pricing tiers to meet your monitoring needs, from personal hobbyists to enterprise.

Feature	Free	Pro	Enterprise
Server Limit	3 Servers	25 Servers	Unlimited
Uptime Monitors	2 Monitors	20 Monitors	Unlimited
Data Retention	7 Days	30 Days	90 Days
Notification Channels	Limited	All Channels	All + Priority
Docker Monitoring	-	Included	Included

How to Upgrade

If you reach your plan limit (e.g. trying to add a 4th server on Free Plan), the system will automatically offer an upgrade option. You can also visit the Billing menu in the sidebar to view your subscription status.

Account Settings

Manage account preferences and notification configuration via the Settings menu.

Notification Channels

TelegramFree
DiscordPro
SlackPro
*Some channels may be restricted by plan in the future.

Danger Zone

You can permanently delete your account. This action will remove all:

Server data & metrics
Uptime monitors
API keys
Billing history

Uptime Monitoring

In addition to monitoring server resources, UptimeID can monitor the availability (uptime) of your website or HTTP/TCP services from various locations.

HTTP/HTTPS Check

Monitor website URL, API endpoint, with GET/POST/HEAD methods. Can validate status codes (e.g. 200, 201).

TCP Port Check

Monitor services on specific ports (database, redis, game server) to ensure the port is open and reachable.

Target Configuration

NameIdentity name for this monitor.

TargetURL (https://example.com) or Host:Port (1.2.3.4:5432).

IntervalHow often the check is performed (default: 30 seconds).

TimeoutResponse timeout limit before being considered down.

Alerts & Notifications

UptimeID supports notifications to various channels when metrics cross defined thresholds. You can set thresholds in the Settings dialog for each system.

Email

Email notifications to registered address

Discord

Send alerts to Discord webhook

Notifications via Telegram bot

Threshold Settings

In each system, you can set thresholds for:

CPU Usage Threshold (%)
Memory Usage Threshold (%)
Disk Usage Threshold (%)

Alerts will be sent with a cooldown to avoid notification spam.

Docker Monitoring

The Agent automatically detects running Docker containers and collects their information. This feature is available for Pro and Enterprise plans.

Container Information

For each container, the agent collects:

• Container ID and Name
• Image used
• Status (running, stopped, etc.)
• State and created time

Help & Support

If you experience issues or need assistance, you can contact our support team via the Ticket feature.

Creating a Support Ticket

Go to the Support Tickets page in the dashboard.
Click "Create Ticket".
Select the appropriate Subject and describe your issue in detail.
Set Priority (Low, Medium, High) according to urgency.

Our team will reply to your ticket as soon as possible. You will be notified when there is a new reply.