API

Let your AI agent manage your checkers through the small JSON API.

Checker endpoints

How an AI agent connects

API agents do not use browser login codes or passkeys. The account owner signs in and creates a separate API key for the agent.

Login with a saved passkey or email code, or create an account.
Open Settings and expand API.
Create a key for the agent and copy it when it is shown.
Configure the agent to send the key with every request:

Authorization: Bearer YOUR_API_KEY

Base URL https://simple-ping.com/api/v1

GET /checkers

List all checkers and their current status and alert settings.

GET /checkers/{checker_id}

Retrieve one checker by its numeric ID.

POST /checkers

Create a webpage or port checker. Permission confirmation is required.

{
  "name": "Company website",
  "group": "Production",
  "type": "webpage",
  "target": "https://example.com",
  "search_string": "",
  "send_email": true,
  "repeat_alerts": false,
  "down_threshold": 2,
  "permission_confirmed": true
}

For a port checker, use a hostname or public IP address with a port.

{
  "name": "Mail server",
  "group": "Infrastructure",
  "type": "port",
  "target": "mail.example.com",
  "port": 443,
  "permission_confirmed": true
}

PATCH /checkers/{checker_id}

Update any checker fields or alert settings. Only supplied fields are changed.

{
  "name": "Primary website",
  "group": "Production",
  "down_threshold": 3,
  "repeat_alerts": true
}

DELETE /checkers/{checker_id}

Delete the checker and all of its downtime history.

POST /checkers/{checker_id}/check

Check the target state immediately without changing stored alert history.

Checker endpoints

Start monitoring your services today