Monitors
live8 operations
Check an endpoint on a schedule: runs, health, uptime and latency.
Your first call
From nothing to an answer, then the setup for a server. The quickstart has the detail.
- 01
Create a token
One click here, or in the console for other scopes and a longer life.
Have a token? Manage tokens in the console - 02
Call the API
Send the token on every call.
GET /v1/meanswers who the API thinks you are. Send it from here with the token from step one, or from a terminal.Request curl https://api.inorbit.hr/v1/me \ -H "Authorization: Bearer $TOKEN"200 OK { "subject": "ak_7f3k…", "kind": "client", "scopes": ["identity:read", "account:read"], "org": "…" }Run it from hereCreate or paste a token above, then send the call from this browser.Every page of the reference has the same token bar and a playground that sends it: fill the fields in, press Send, read the answer. The samples beside it carry the token too.
- 03
For a server, use a key
A server that keeps a secret makes an API key in the console and exchanges it for a token that lives fifteen minutes: the OAuth 2.0 client credentials grant.
curl -u "$KEY_ID:$KEY_SECRET" https://auth.inorbit.hr/oauth2/token \ -d grant_type=client_credentials \ -d audience=iohr-api \ -d scope="identity:read account:read"
Guides
By what you are trying to do. Times are for a first read.
Start here
Four guides, in order: a first call, the credential your code will keep, the command line, a client in your language.
- 1QuickstartYou’ll have a token and a first answer from GET /v1/me, from this page and a terminal.5 minBeginner
- 2AuthenticationYou’ll have a scoped token, or a key your server exchanges for one.15 minBeginner
- 3Command lineYou’ll have iohr installed and signed in, a profile per account, a token for CI.10 minBeginner
- 4SDKsYou’ll have the SDK for your language in a project, making its first call.10 minBeginner
Monitor and alert
Check what matters on a schedule and hear about it where you already listen.
- Monitor an endpointYou’ll have an endpoint checked every minute, with down and recovered events.15 minIntermediate
- DomainsYou’ll have a domain verified with one DNS TXT record, so our cloud may check it.15 minBeginner
- WebhooksYou’ll have a verified webhook receiver, tested end to end with a test inbox.20 minIntermediate
- Server-sent eventsYou’ll have your account's events as a live stream that reconnects when it drops.10 minIntermediate
- MQTTYou’ll have an MQTT 5 client subscribed to your events and making calls.20 minAdvancedrolling out
Respond to incidents
From the first page to the postmortem. The guide is being written with the product.
- Incidents and postmortemspreviewAcknowledge from the phone, impact measured on the monitor. No public API or guide yet; a monitor's down and recovered events are the way in today.guide coming
- StatusYou’ll have the API's own health and readiness checks wired into your monitoring.2 minBeginner
Run the agent
Reach what our cloud cannot: the agent runs in your network and only connects out.
- Installing an agentYou’ll have an agent enrolled in your network, running a check on a private target.30 minAdvancedpreview
- The agentYou’ll have the agent installed by extension, Helm or package, with a policy and checks.30 minAdvancedpreview
- ExtensionsYou’ll have an extension installed, verified and pinned in a lock file.10 minIntermediate
Decisions and Atlas
PRDs, ADRs and RFCs linked to the code, and the map they will feed.
- DecisionsYou’ll have a clear picture of how PRDs, RFCs and ADRs live in Decisions, link and get decided.10 minBeginnerpreview
- Atlas, the mapin developmentAn evidence-backed model of your system. In development; the guide comes with the first release.guide coming
Security and data
Who may call what, what each call costs, and the bounds every client should expect.
- Accounts, teams and keysYou’ll have a clear map of accounts, team roles, invitations and which account a call counts against.5 minBeginner
- Usage and unitsYou’ll have a grip on how units are counted, your monthly allowance and where to see usage.5 minBeginner
- LimitsYou’ll have a client sized to the rate, stream, socket and webhook bounds.5 minIntermediate
Integrations
Connect the tools you already use, and let an assistant act as you.
- ConnectionsYou’ll have an outside app connected, with a scoped, expiring grant for a product or key.15 minIntermediatein part
- MCPYou’ll have an assistant connected to the MCP server, by sign-in or token.5 minBeginner
- Generate an SDK for your accountYou’ll have a client generated for your credentials, pinned in iohr.lock and checked in CI.30 minIntermediate
API essentials
The rules every call follows, whichever way it travels.
- RESTYou’ll have requests that pass the gateway's strict JSON and input rules.5 minBeginner
- WebSocketYou’ll have one socket carrying several calls and streams by name.15 minIntermediate
- Paging, retries and errorsYou’ll have a client that pages every list and retries writes safely.15 minIntermediate
- The iohr command lineYou’ll have iohr installed and verified, with every command at hand.10 minBeginner
- ErrorsYou’ll have errors handled by their stable codes, with the right retry for each.5 minBeginner
API reference
Every route a token may call, by product area, from the live OpenAPI document. Each opens its reference page with a playground.
Incidents
previewno public routes yet
Open, acknowledge and resolve incidents, and write the postmortem.
Not in the public API yet. A monitor's health changes arrive as the events monitor.down and monitor.recovered.
Get told when a monitor goes downDecisions
preview48 operations · Decisions, Corrections
Spaces of PRDs, ADRs and RFCs: documents, versions, reviews, comments and diagrams.
Connections
in part19 operations
Connect outside systems, grant their use to a token or a product, and call their actions.
Agents
preview6 operations
Enroll the agent in your network, revoke it, and run checks through it.
Events and webhooks
live19 operations · Webhooks, Test inboxes, Events
The event catalogue and live stream, webhook endpoints, deliveries and test inboxes.
Account and keys
live15 operations · Identity, Accounts, Usage and units, Domains
Who is calling, the account and its audit log, verified domains, usage and units. Keys are made in the console or with iohr token create.
Extensions
live4 operations
The catalogue iohr ext install reads: listings, versions, scopes and publishers.
Trails
preview4 operations
Consented recordings of how people move through a site, from the browser extension.
Radar
live3 operations
The weekly digests of what changed in Go, Rust and Solidity.