Your address
Requests go to your own organization’s address, the one you sign in at:Make a key
In RescueConsole, open Settings → Advanced & security → API keys and create one. You choose:- A label, so you know later what it is for.
- What it may do: for each area, read, write or admin. A key can never be given more than you can do yourself.
- An expiry date, if you want one.
rc_live_ and is shown once. Copy it then; it cannot be shown again. If it is lost or leaked, revoke it on the same page and make another.
Send it
Put the key in theAuthorization header of every request:
GET /api/status/notice, which says only what the public status page says.
Try it on these pages
Every endpoint page has a playground that sends a real request and shows you the real answer.1
Choose your address
Set organization to the first part of the address you sign in at. For
https://contoso.rescueconsole.com, that is contoso.2
Paste your key
Paste the whole key,
rc_live_ and all, into the Authorization field. You do not type Bearer; the playground adds it.3
Fill in what the request needs, and send it
The answer appears beneath: the status, and the body exactly as your own software would receive it.
What a key can reach
Everything else is closed to a key on purpose: signing in, members and roles, your organization’s settings, billing, and API keys themselves. A key can never make another key.
Lists
Lists answer inresults. A long list answers one page at a time:
offset, while has_more is true. Not every list pages, and not every one that pages gives a total: each endpoint’s page says what it answers, its default limit, and the most it will give at once.
When something is wrong
An error is a status code and one sentence you can show to a person:Yes, no, and not assessed
Many answers about an animal have three states, not two:1 (yes), 0 (no) and null (not assessed). Send null to clear an answer. Never send 0 to mean “we do not know”: it is read as a no, on applications and on listing sites.
