DokumentationProdukteShellBaseRelay-APIRelay-API V1
Relay bearbeiten
In API Explorer austestenÖffnet den Explorer mit Methode und Pfad dieses Requests.
Ändert ein Relay — etwa um es vorübergehend abzuschalten.
PATCH https://relays.api.shellbase.artim-industries.com/v1/relays/{id}
| Methode | PATCH |
| Basis | relays.api.shellbase.artim-industries.com/v1 |
| Scope | sb.relays:update |
| Antwort | 200 |
| Zugang | Developer Mitgliedschaft |
| Auth | Authorization: Bearer sbapi_… |
Parameter
| Parameter | Ort | Typ | Pflicht | Bedeutung |
|---|---|---|---|---|
id | Pfad | string | ja | Kennung des Relays. |
Anfragekörper
| Feld | Typ | Bedeutung |
|---|---|---|
name | string | Neuer Name. |
description | string | Neue Beschreibung. |
localHost | string | Neue lokale Adresse. |
localPort | integer | Neuer Port. |
enabled | boolean | false sperrt es, ohne es zu löschen. |
Felder, die der Vertrag nicht nennt, werden verworfen — ein Client kann keine eigenen Felder unterschieben.
{ "enabled": false }
Anfrage
curl -X PATCH "https://relays.api.shellbase.artim-industries.com/v1/relays/{id}" \
-H "Authorization: Bearer sbapi_…" \
-H "Content-Type: application/json" \
-d '{ "enabled": false }'
Antwort
| Feld | Typ | Bedeutung |
|---|---|---|
id | string | Kennung. |
enabled | boolean | Zustand nach der Änderung. |
{ "id": "…", "name": "Relay Werk Süd", "enabled": false }
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.