Skip to main content
POST
Register a black-hole agent install
Black Hole desktop-agent install. Auth0 only (ingest:write). The organization must be allowlisted or this 404s. See Black Hole.

Authorizations

Authorization
string
header
required

Auth0 access token for a signed-in user. Send Authorization: Bearer <token>. The SPA and desktop agent use this. Prefer an organisation API key for server-to-server integrations.

Body

application/json

POST /api/v2/ingest/agents/ body (CONTRACT §2.1).

hostname
string
required
Required string length: 1 - 255
os
string
required
Required string length: 1 - 50
app_version
string
required
Required string length: 1 - 50

Response

201 body for agent registration.

agent_id
string
required
min_poll_seconds
integer
required