Skip to content

jonth93/acsmon-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ACS Monitor — Open-Source API Clients

Official client libraries for ACS Monitor — the network and infrastructure monitoring platform from Anglia Computer Solutions.

ACS Monitor monitors SNMP devices, service endpoints (HTTP/S, TCP, SSH, SMTP, ping, DNS), receives SNMP traps and webhook alerts, runs on-demand network diagnostics, and pushes rich alerts to email, SMS, Slack and webhooks. Free for installations of up to 100 monitored resources — see acsmon.com for tiers and pricing.

Pick your language

Language / runtime Repository Install
PHP 8.1+ (raw) acsmon-php-client composer require acsmon/api-client
Laravel 10/11/12 acsmon-laravel-client composer require acsmon/laravel-client
Node.js 18+ (zero-dep) acsmon-nodejs-client npm install acsmon-api-client
Python 3.9+ acsmon-python-client pip install acsmon-client
bash + curl acsmon-bash Copy the scripts

What's in this repo

  • AI.md — single-read reference for AI coding agents (Claude, ChatGPT, Cursor, Copilot, Aider, etc.) so they can produce correct API client code without trawling every language repo.
  • This README — overview, language picker, and a top-level endpoint reference.

The actual client code lives in the language-specific repos linked above.

Endpoint cheat sheet

POST   /api/v1/auth/login                        { email, password } -> { token }
POST   /api/v1/auth/logout

GET    /api/v1/devices                           ?search=&group=
GET    /api/v1/devices/{id}
POST   /api/v1/devices/{id}/poll
GET    /api/v1/devices/{id}/metrics
GET    /api/v1/devices/{id}/alerts

GET    /api/v1/monitors
POST   /api/v1/monitors                          { name, type, host, port, ... }
POST   /api/v1/monitors/{id}/check
GET    /api/v1/monitors/{id}/results
GET    /api/v1/monitors/{id}/uptime

GET    /api/v1/alert-events                      ?severity=&status=
POST   /api/v1/alert-events/{id}/acknowledge
POST   /api/v1/alert-events/{id}/resolve

GET    /api/v1/system/health

All list endpoints support pagination (?per_page=N&page=N), sorting (?sort=column, prefix - for descending), and filtering (?filter[field]=value).

Authentication

The ACS Monitor API uses bearer-token authentication:

  1. POST /api/v1/auth/login with { email, password }
  2. Server returns { token } — a personal access token
  3. Send the token as Authorization: Bearer <token> on every other call
  4. (Optional) POST /api/v1/auth/logout to revoke the token when done

Tokens live until logout (or the user is deleted). For long-running integrations, issue a dedicated API user from Settings → Users in your ACS Monitor install and keep the token in your secrets store.

Common environment variables

Every client honours the same three env vars:

export ACSMON_BASE_URL=https://monitoring.example.com
export [email protected]
export ACSMON_PASSWORD='your-strong-password'
# or, if you already have a long-lived token:
export ACSMON_TOKEN='1|abc...'

Common integration recipes

These libraries are everything you need to build:

  • PagerDuty / Opsgenie / Splunk On-Call bridges — turn ACS Monitor alert events into incidents in your existing on-call tool.
  • CMDB / asset-database sync — keep your CMDB in step with the devices ACS Monitor is actually polling.
  • Custom dashboards — pull live status into Grafana, Power BI, or a bespoke status page.
  • Scheduled reports — generate weekly uptime summaries from the /monitors/{id}/uptime endpoint and email them to stakeholders.
  • Self-service tooling — give support teams a "trigger a re-poll" button or chatbot command without granting them full UI access.
  • CI/CD verification — after deploying an app, hit /monitors/{id}/check to immediately confirm it's healthy.

Licensing

All client libraries are MIT-licensed and free to ship inside your own products without restriction. The ACS Monitor application they connect to is licensed commercial software with a free 100-device tier — see acsmon.com.


© Anglia Computer Solutions Ltd. — Visit acsmon.com for the latest builds, documentation and licensing.

About

Documentation hub for ACS Monitor's REST API client libraries — endpoint reference, authentication, and AI-agent guide.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors