Skip to content

Platform status

GET /v1/status reports whether each family of endpoints can serve your data right now. Call it when something starts failing, and poll it if you want monitoring that reflects the API rather than a single process.

curl -s -H "Authorization: Bearer $ACCESS_TOKEN" \
  https://api.secutec.com/v1/status
{
  "status": "ok",
  "checked_at": "2026-09-15T14:52:03Z",
  "capabilities": [
    { "name": "threats", "available": true },
    { "name": "assets", "available": true },
    { "name": "dns_blocks", "available": true }
  ]
}

It always returns 200

Including when everything is unavailable. Read status, not the HTTP status code.

This is deliberate. If the endpoint returned 503 when a capability was down, your monitoring could not tell "the platform cannot serve threats" from "the API is unreachable" — and telling those apart is the only reason the endpoint exists. A non-200 from this path means the gateway itself did not answer.

What available actually means

Each capability is probed with a real, minimal read scoped to your organization, using the token you sent. So available: true means your credentials can genuinely fetch that data — not merely that a server somewhere is running.

name Covers
threats /v1/threats, /v1/threats/{id} and the threat writes
assets /v1/assets, /v1/assets/{id}, /v1/assets/{id}/related
dns_blocks /v1/sdns/blocks

All three rows are always present. available: false means calls to that family are likely to fail right now — retry with backoff, and do not treat the data as empty. A delta consumer that records an empty page as "nothing new" during an outage will skip that window permanently; hold your cursor and retry instead.

Use it with whoami

The two endpoints answer different halves of the same question, because /v1/whoami makes no call to anything else:

whoami status What it means
✅ 200 ok Everything is fine; the fault is in your request.
✅ 200 degraded Your credentials are good, the platform is not. Retry with backoff.
❌ 401/403 The credential is the problem. See authentication.
❌ no answer ❌ no answer The gateway is unreachable.

Polling it

Every call re-probes — nothing is cached — and each one reaches every upstream, so a single request to /v1/status costs more than a request to any other endpoint. It counts against your rate limit like everything else.

Poll it on the order of minutes, not seconds. It is a status check, not a heartbeat; polling it aggressively spends the same budget your data calls need. If you only want to know whether your credentials still work, whoami is far cheaper.