API Reference¶

Base URL: https://api.noctuary.io

All API requests must be authenticated. Responses are JSON. Timestamps are ISO 8601 (UTC).

Authentication¶

See Authentication for details on API keys and how to authenticate requests.

Method	Path	Auth	Description
`GET`	`/health`	None	Service health check
`POST`	`/v1/agents/register`	Ingest key	Register an agent
`POST`	`/v1/agents/{id}/heartbeat`	Ingest key	Agent heartbeat
`GET`	`/v1/agents`	Any key	List agents
`GET`	`/v1/agents/{id}`	Any key	Get agent + event log
`POST`	`/v1/events`	Ingest key	Ingest a ContextEvent
`GET`	`/v1/incidents`	Any key	List incidents
`GET`	`/v1/incidents/{id}`	Any key	Get incident detail
`PUT`	`/v1/incidents/{id}/feedback`	Any key	Record engineer feedback
`GET`	`/v1/services`	Any key	List services
`GET`	`/v1/services/{id}/context`	Any key	Get service state window
`POST`	`/v1/api-keys`	Any key	Create an API key
`GET`	`/v1/api-keys`	Any key	List API keys
`DELETE`	`/v1/api-keys/{id}`	Any key	Revoke an API key
`GET`	`/v1/integrations`	Any key	List integrations
`POST`	`/v1/integrations`	Any key	Create an integration
`PUT`	`/v1/integrations/{id}`	Any key	Update integration config
`DELETE`	`/v1/integrations/{id}`	Any key	Delete an integration
`POST`	`/v1/integrations/{id}/rotate-token`	Any key	Rotate webhook token
`POST`	`/webhooks/pagerduty/{token}`	Token in URL	PagerDuty inbound webhook

Code	Meaning
`200 OK`	Request succeeded
`201 Created`	Resource created
`204 No Content`	Request succeeded, no body
`400 Bad Request`	Invalid request body or parameters
`401 Unauthorized`	Missing or invalid API key
`403 Forbidden`	Valid key but insufficient permissions
`404 Not Found`	Resource does not exist
`500 Internal Server Error`	Server-side error