DokumentationProdukteShellBaseRelay-APIRelay-API V1
Verkehr eines Relays
In API Explorer austestenÖffnet den Explorer mit Methode und Pfad dieses Requests.
Sitzungen und Kommandos, die über dieses Relay liefen.
GET https://relays.api.shellbase.artim-industries.com/v1/relays/{id}/traffic
| Methode | GET |
| Basis | relays.api.shellbase.artim-industries.com/v1 |
| Scope | sb.relays.traffic:read |
| Antwort | 200 |
| Zugang | Developer Mitgliedschaft |
| Auth | Authorization: Bearer sbapi_… |
Parameter
| Parameter | Ort | Typ | Pflicht | Bedeutung |
|---|---|---|---|---|
id | Pfad | string | ja | Kennung des Relays. |
limit | Query | integer | nein | Einträge je Seite, 1–200. Standard 50. |
offset | Query | integer | nein | Wie viele Einträge übersprungen werden. Standard 0. |
Anfrage
curl "https://relays.api.shellbase.artim-industries.com/v1/relays/{id}/traffic" \
-H "Authorization: Bearer sbapi_…"
Antwort
| Feld | Typ | Bedeutung |
|---|---|---|
relayId | string | Kennung des Relays. |
sessions | array | Sitzungen mit Server, Konto, Dauer und Kommandozahl. |
commands | array | Die Kommandos daraus, mit Status. |
{
"relayId": "…",
"sessions": [ { "sessionId": "…", "server": "db-01", "user": "Mila Berger", "active": false, "commandCount": 5 } ],
"commands": [ { "sessionId": "…", "command": "df -h", "status": "allowed" } ]
}
Fehler
| Status | code | Wann |
|---|---|---|
401 | invalid_token | Bearer fehlt, ist unbekannt oder abgelaufen. Verlängern über https://api.artim-industries.com/v1/oauth/token. |
403 | missing_scope | Das Token trägt den Scope dieses Endpunkts nicht. |
404 | not_found | Der Eintrag gehört nicht zum freigegebenen Team — oder die Anfrage kam auf der falschen Subdomain an. |
422 | invalid_request | Ein Parameter hat den falschen Typ oder liegt außerhalb des erlaubten Bereichs. |
429 | rate_limited | Kontingent erschöpft, siehe Retry-After. |
Jede Fehlerantwort trägt dieselbe Hülle: error.code benennt den Fehler, error.message sagt in einem Satz, was fehlt.
Rate Limits
Das Limit gilt pro Team, nicht pro Token.
| Zugang | Produktion | Sandbox |
|---|---|---|
| Hobby | 60 Anfragen/Minute | ohne Limit |
| Developer Mitgliedschaft | 10.000 Anfragen/Minute | ohne Limit |
Bei 429 sagt der Retry-After-Header, wie lange du warten sollst.