DokumentationProdukteShellBaseRelay-API
Relay-API V1
Ein Relay ist der Agent, über den ShellBase Server erreicht, die nicht im Netz stehen. Diese API legt Relays an, pflegt sie und zeigt den Verkehr, der durch sie läuft.
Das Agent-Token ist ein Zugangsgeheimnis: wer es hat, meldet einen eigenen Agenten an. Es steht in keiner Liste, sein Abruf ist ein Enterprise-Scope und wird protokolliert.
https://relays.api.shellbase.artim-industries.com/v1
Endpoints
| Request | Methode | Pfad | Scope | Zugang |
|---|---|---|---|---|
| Überblick | GET | / | sb.relays:read | Programm |
| Relays auflisten | GET | /relays | sb.relays:read | Programm |
| Relay lesen | GET | /relays/{id} | sb.relays:read | Programm |
| Verkehr eines Relays | GET | /relays/{id}/traffic | sb.relays.traffic:read | Programm |
| Relay anlegen | POST | /relays | sb.relays:write | Programm |
| Relay bearbeiten | PATCH | /relays/{id} | sb.relays:update | Programm |
| Relay löschen | DELETE | /relays/{id} | sb.relays:delete | Programm |
| Agent-Token lesen | GET | /relays/{id}/agent-token | sb.relays.token:read | Enterprise |
Jeder Request hat seine eigene Seite mit Parametern, Antwortstruktur, Beispiel, Fehlern und Rate Limits.
Scopes
sb.relays:readsb.relays.traffic:readsb.relays:writesb.relays:updatesb.relays:deletesb.relays.token:read