Skip to main content
The Griffin Hub exposes a REST API for managing monitors, viewing runs, querying metrics, and more. The CLI uses this API internally — everything you can do with the CLI, you can also do via the API directly.

​
Base URL

  • Griffin Cloud: https://api.griffin.dev
  • Self-hosted: Your hub’s URL (e.g., http://localhost:3000)

​
Authentication

All API requests (except the health check) require authentication. See Authentication for details.

​
Response format

All responses are JSON. Successful responses return the resource directly: 
{
  "id": "mon_123",
  "name": "health-check",
  "frequency": { "every": 5, "unit": "MINUTE" }
}
Error responses include a status code and message: 
{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Monitor not found"
}

​
Endpoints

​
Monitors

MethodPathDescription
POST/monitorCreate a monitor
GET/monitorList monitors
GET/monitor/by-nameGet monitor by name
PUT/monitor/:idUpdate a monitor
DELETE/monitor/:idDelete a monitor

​
Runs

MethodPathDescription
GET/runsList runs
GET/runs/:idGet a specific run
POST/runs/trigger/:monitorIdTrigger a manual run

​
Metrics

MethodPathDescription
GET/metrics/summaryGet metrics summary
GET/metrics/monitorsList monitors with metrics
GET/metrics/monitors/:monitorIdGet detailed monitor metrics

​
Secrets

MethodPathDescription
GET/secretsList secrets
GET/secrets/:nameGet secret metadata
PUT/secrets/:nameCreate or update a secret
DELETE/secrets/:nameDelete a secret

​
Integrations

MethodPathDescription
GET/integrationsList integrations
POST/integrationsCreate an integration
GET/integrations/:idGet an integration
PATCH/integrations/:idUpdate an integration
DELETE/integrations/:idDelete an integration

​
Notifications

MethodPathDescription
GET/notifications/rulesList notification rules
GET/notifications/eventsList notification events

​
Locations

MethodPathDescription
GET/locationsGet available executor locations

​
Health

MethodPathDescription
GET/Health check (no auth required)