Server Chief API v1
Server Chief API v1
Query and manage the authenticated team's Server Chief inventory: servers, packages, vulnerabilities, sites, certificates, package sources, tags and agent releases.
Tags
Servers
Endpoints for managing the servers in the team inventory.
Packages
Endpoints for searching the packages installed across the team's servers.
Sites
Endpoints for finding sites (virtual hosts) and their certificates across the team's servers.
Certificates
Endpoints for the TLS certificates of sites and services across the team's servers, their renewal tooling and issues.
Applications
Endpoints for the web applications the sites of the team's servers serve: WordPress with its plugins and themes, Laravel, Symfony and other Composer or npm projects, and the vulnerabilities of their packages.
Vulnerabilities
Endpoints for finding which servers security advisories affect, and the advisories themselves.
Metrics
Endpoints for the host metrics agents send every minute: CPU, load, memory, swap, file systems, disk I/O, network, TCP and processes.
Alerts
Endpoints for the metric alert rules of the team and the alerts they raise. Rules are checked every minute and notify the team when a metric of a server stays above or below a threshold.
Tags
Endpoints for managing team tags and sharing them read-only with other teams.
Agent releases
Endpoints for the agent releases servers are updated to.
Webhooks
Endpoints for the team's webhook endpoints and the events and deliveries sent to them. Webhooks send a signed request to an endpoint when something happens in the team, see the webhooks guide for verifying them.
Webhook events
Requests sent to your webhook endpoints when something happens. Each page shows the headers and body of the request, and the response your endpoint should give.
Security Schemes
ctp
Chief Tools personal access token.
http
openid
OpenID Connect
openIdConnect
ctt
Chief Tools team access token.
http
Webhooks
server.created
A server was added and waits for its agent.
POST
server.enrolled
A server's agent enrolled for the first time.
POST
server.updated
A server's name, metadata, location or settings changed.
POST
server.deleted
A server was removed.
POST
server.offline
A server stopped checking in.
POST
server.online
An offline server checks in again.
POST
server.reboot_stalled
A server did not come back after a reboot.
POST
alert.fired
A metric alert rule fired.
POST
alert.resolved
A firing alert resolved.
POST
metrics.stalled
An online server stopped delivering metrics.
POST
metrics.resumed
A server delivers metrics again.
POST
server.storage_unhealthy
A RAID array or ZFS pool degraded, or a disk failed.
POST
server.storage_healthy
A server's storage is healthy again.
POST
webhook_endpoint.test
A test event sent from the dashboard.
POST