DokumentationProdukteShellBaseSitzungs-APISitzungs-API V1
Kommando ausführen
In API Explorer austestenÖffnet den Explorer mit Methode und Pfad dieses Requests.
Führt ein Kommando in einer offenen Sitzung aus.
Enterprise-Scope. Die Richtlinien des Teams entscheiden: ein verbotenes Kommando wird abgewiesen (403) und steht trotzdem im Protokoll — genau dafür ist es da.
POST https://sessions.api.shellbase.artim-industries.com/v1/sessions/{id}/commands
| Methode | POST |
| Basis | sessions.api.shellbase.artim-industries.com/v1 |
| Scope | sb.sessions.commands:execute |
| Antwort | 200 |
| Zugang | Enterprise-Mitgliedschaft (in der Sandbox frei) |
| Auth | Authorization: Bearer sbapi_… |
Parameter
| Parameter | Ort | Typ | Pflicht | Bedeutung |
|---|---|---|---|---|
id | Pfad | string | ja | Kennung der Sitzung. |
Anfragekörper
| Feld | Typ | Bedeutung |
|---|---|---|
command | string | Das Kommando. Pflicht. |
Felder, die der Vertrag nicht nennt, werden verworfen — ein Client kann keine eigenen Felder unterschieben.
{ "command": "systemctl restart nginx" }
Anfrage
curl -X POST "https://sessions.api.shellbase.artim-industries.com/v1/sessions/{id}/commands" \
-H "Authorization: Bearer sbapi_…" \
-H "Content-Type: application/json" \
-d '{ "command": "systemctl restart nginx" }'
Antwort
| Feld | Typ | Bedeutung |
|---|---|---|
output | string | Ausgabe des Kommandos. |
returnCode | integer | Rückgabewert. |
cwd | string | Arbeitsverzeichnis danach. |
{ "output": "…", "returnCode": 0, "cwd": "/root" }
Fehler
| Status | code | Wann |
|---|---|---|
400 | invalid_request | Ein Pflichtfeld fehlt, ein Typ passt nicht, oder ein Verweis zeigt auf etwas, das es hier nicht gibt. |
401 | invalid_token | Bearer fehlt, ist unbekannt oder abgelaufen. |
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. |
409 | conflict | Der Zustand verbietet die Änderung — der Fehlerkörper nennt den Grund. |
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.