Autentisering
API:et använder API-nycklar. Skicka nyckeln i Authorization-headern med prefixet Bearer.
GET /api/v1/sites HTTP/1.1
Host: api.upfinity.app
Authorization: Bearer upf_live_...API-nycklar
- Nycklar börjar med
upf_live_och hör till en organisation. - Upfinity sparar bara en hash av nyckeln. Tappar du bort den skapar du en ny.
- En nyckel kan stängas av eller tas bort under Inställningar › API Keys. En avstängd nyckel svarar 401.
- Inloggningen i appen och mobilappen använder sessioner, inte API-nycklar. De går inte att använda mot
/api/v1.
Scopes
Varje nyckel har ett eller flera scopes. En endpoint som kräver ett scope nyckeln saknar svarar 403.
| Scope | Ger tillgång till |
|---|---|
read:sites | Läsa checkar, deras inställningar och projekt |
write:sites | Skapa, ändra, pausa, återuppta och ta bort checkar |
read:checks | Läsa enskilda kontroller (senaste 30 dagarna) |
read:incidents | Läsa incidenter |
read:stats | Läsa daglig statistik och översikten |
read:probes | Läsa vilka probar som kontrollerar checkarna |
Ge nyckeln så få scopes som möjligt. Ett skript som bara läser status behöver till exempel read:sites och read:stats.
Gränser för antal anrop
- 1 000 anrop per timme och nyckel som standard. Gränsen kan ändras per nyckel.
- 100 anrop per minut och IP-adress, för alla anrop mot Upfinity.
Varje svar har headers som visar läget för nyckeln:
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 997
X-RateLimit-Reset: 1762956000När gränsen nås svarar API:et 429 med Retry-After i sekunder.
Om en nyckel läcker
- Stäng av eller ta bort nyckeln under Inställningar › API Keys.
- Skapa en ny nyckel med samma scopes.
- Byt nyckel i alla system som använde den gamla.