DokumentationProdukteShellBaseSitzungs-APISitzungs-API V1
Sitzung öffnen
In API Explorer austestenÖffnet den Explorer mit Methode und Pfad dieses Requests.
Öffnet eine SSH-Sitzung auf einem Server des Teams.
Enterprise-Scope. Der Aufruf verbindet wirklich: ist der Server offline oder das Relay nicht angemeldet, endet er mit 400 bzw. 503. Die Server-Berechtigung des Kontos wird geprüft wie in der Anwendung, und der Beginn steht im Protokoll.
POST https://sessions.api.shellbase.artim-industries.com/v1/servers/{id}/sessions
| Methode | POST |
| Basis | sessions.api.shellbase.artim-industries.com/v1 |
| Scope | sb.sessions:write |
| Antwort | 201 |
| Zugang | Enterprise-Mitgliedschaft (in der Sandbox frei) |
| Auth | Authorization: Bearer sbapi_… |
Parameter
| Parameter | Ort | Typ | Pflicht | Bedeutung |
|---|---|---|---|---|
id | Pfad | string | ja | Kennung des Servers. |
Anfragekörper
Dieser Endpunkt braucht keinen Körper.
Anfrage
curl -X POST "https://sessions.api.shellbase.artim-industries.com/v1/servers/{id}/sessions" \
-H "Authorization: Bearer sbapi_…"
Antwort
| Feld | Typ | Bedeutung |
|---|---|---|
id | string | Kennung der neuen Sitzung. |
server | string | Name des Servers. |
host | string | Adresse des Servers. |
active | boolean | true — sie läuft. |
startedAt | string | Beginn. |
{ "id": "…", "server": "web-01", "host": "10.0.3.13", "active": true, "startedAt": "2026-08-18T12:00:00" }
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.