OpenAPI YAMLOpenAPI JSONProbleme YAMLAPI-Überblick
Diese Gruppe hat 11 Operationen, generiert aus api/openapi.yaml. Filtern Sie nach Pfad, Aktion oder Authentifizierung. Jeder Endpunkt listet seine Eingaben auf; klappen Sie ihn auf, um eine Anfragevorlage und die Antwortcodes zu sehen. Die Vorlagen brauchen Ihre eigenen Werte und einen schemagültigen Anfragekörper.
Großgeschriebene Platzhalter durch Ihre Werte ersetzen. Für eine JSON-Anfrage speichern Sie einen Body, der dem Schema in request.json entspricht. Cookie-Beispiele verwenden ein lokales Cookie-Archiv aus einer authentifizierten Sitzung.
Anwendungen und Operationen
Anwendungen auflisten
Anwendungen neueste zuerst auflisten, maximal 500 pro Seite. Namen sind Bezeichnungen und müssen nicht eindeutig sein; eine Anwendung wird über die ID adressiert. next_cursor ist die Position der zuletzt zurückgegebenen Zeile, solange weitere Zeilen vorhanden sind; geben Sie ihn als after mit denselben Filtern für die nächste Seite zurück. next_cursor ist auf der letzten Seite null.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| ScreenRig-Project | Überschrift | optional | Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch. |
| nach | Abfrage | optional | next_cursor der vorherigen Seite derselben Liste mit denselben Filtern. Wird ausgelassen, beginnt bei der neuesten Zeile. Ein Wert, der kein solcher Cursor ist, ist invalid_request. |
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/applications'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Anwendungen | ApplicationList (application/json) |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
Anwendung hochladen
Streamt ein CLI-erzeugtes tar.gz direkt in eine begrenzte dauerhafte Staging-Umgebung. Metadaten werden in Headern übertragen, sodass das Archiv nie base64-kodiert oder vom Server als JSON materialisiert wird.
Der Proxy vor der API beendet eine Anfrage, die er nicht innerhalb von etwa 100 s beantwortet hat, sodass ein großes Archiv bei langsamer Uplink-Verbindung hier fehlschlägt; POST /api/applications/uploads sendet das Archiv stattdessen direkt an den Objektspeicher.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| ScreenRig-Project | Überschrift | optional | Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch. |
| Idempotency-Key | Überschrift | erforderlich | |
| ScreenRig-Archive-SHA256 | Überschrift | erforderlich | |
| ScreenRig-Expanded-Bytes | Überschrift | erforderlich | |
| ScreenRig-File-Count | Überschrift | erforderlich | |
| ScreenRig-SDK-Version | Überschrift | optional | |
| ScreenRig-Application-Name | Überschrift | optional | ASCII-Anwendungsname; gegenseitig ausschließend mit ScreenRig-Application-Name*. Führende und nachfolgende Leerzeichen werden entfernt. Steuerzeichen und doppelte Headerwerte werden abgelehnt. Der decodierte Name ist auf 120 Unicode-Skalarwerte begrenzt. |
| ScreenRig-Application-Name* | Überschrift | optional | Unicode-Anwendungsname kodiert als RFC 8187 UTF-8'' gefolgt von prozentkodierten UTF-8-Bytes (leere Sprache, exakter UTF-8-Zeichensatz). Gegenseitig ausschließend mit ScreenRig-Application-Name. Ungültige Escape-Sequenzen, ungültiges UTF-8, Steuerzeichen und doppelte Header-Werte werden abgelehnt. Führende und nachfolgende Leerzeichen werden entfernt; der decodierte Name ist auf 120 Unicode-Skalare begrenzt. Keiner der Namensheader darf ein Release-Update umbenennen. Dies vermeidet rohes Unicode in HTTP-Headerwerten. |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Idempotency-Key: REQUEST_ID' --header 'ScreenRig-Archive-SHA256: VALUE' --header 'ScreenRig-Expanded-Bytes: VALUE' --header 'ScreenRig-File-Count: VALUE' --header 'Content-Type: application/gzip' --data-binary '@request.bin' 'https://screenrig.ai/api/applications'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 202 | Upload akzeptiert | Operation akzeptiert (application/json); Header: RateLimit-Policy, RateLimit |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
Anwendungs-Release hochladen
Veröffentlicht eine unveränderliche neue Version einer eigenen Anwendung unter Verwendung derselben gebundenen tar.gz-Upload-Pipeline. If-Match schützt die Anwendungsrevision; Annahme erhöht sie, und erfolgreiche Veröffentlichung erhöht sie erneut, wenn sich latest_ready_release ändert. Name und Anwendungsidentität bleiben erhalten. Bestehende Playlist-Release-Pins werden nicht geändert.
Ein identischer idempotenter Wiederholungsversuch gibt die ursprüngliche Operation auch nach Revisionsänderungen zurück. Der Proxy vor der API beendet eine Anfrage, die er nicht innerhalb von etwa 100 s beantwortet hat, sodass ein großes Archiv bei langsamer Uplink-Verbindung hier fehlschlägt; POST /api/applications/{id}/uploads sendet das Archiv stattdessen direkt an den Objektspeicher.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| ScreenRig-Project | Überschrift | optional | Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch. |
| id | Pfad | erforderlich | |
| If-Match | Überschrift | optional | Optionale positive Ressourcenrevision. Weglassen, um die aktuelle Ressource zu schreiben; eine übergebene veraltete Revision ist revision_conflict. |
| Idempotency-Key | Überschrift | erforderlich | |
| ScreenRig-Archive-SHA256 | Überschrift | erforderlich | |
| ScreenRig-Expanded-Bytes | Überschrift | erforderlich | |
| ScreenRig-File-Count | Überschrift | erforderlich | |
| ScreenRig-SDK-Version | Überschrift | optional |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Idempotency-Key: REQUEST_ID' --header 'ScreenRig-Archive-SHA256: VALUE' --header 'ScreenRig-Expanded-Bytes: VALUE' --header 'ScreenRig-File-Count: VALUE' --header 'Content-Type: application/gzip' --data-binary '@request.bin' 'https://api.screenrig.ai/api/applications/RESOURCE_ID/releases'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 202 | Upload akzeptiert | Operation akzeptiert (application/json); Header: RateLimit-Policy, RateLimit |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
Anwendungs-Upload starten
Erklärt einen direkten Upload eines von der CLI erzeugten tar.gz, das eine neue Anwendung erstellt. Die Antwort ist eine signierte Autorisierung für genau einen Objekt-PUT des Archivs, sodass die Bytes direkt an den Objektspeicher gehen und nie durch die API, deren Proxy eine Anfrage beendet, die er nicht innerhalb von etwa 100 s beantwortet hat.
Senden Sie das Archiv per PUT an upload_url, bestätigen Sie dann mit POST /api/applications/uploads/{id}/commit und warten Sie auf die Operation. Die Anwendung, ihre Version und die empfangende Operation existieren ab dieser Antwort, wie nach POST /api/applications. Ein Upload, der nicht innerhalb von 24 Stunden bestätigt wird, schlägt fehl, und eine Anwendung, die nie eine Version veröffentlicht hat, wird entfernt.
Derselbe Idempotency-Key und derselbe Body beantworten denselben Upload mit einer frisch signierten URL. GET /api/capabilities setzt features.application_direct_uploads, wo diese Routen bedient werden.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| ScreenRig-Project | Überschrift | optional | Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch. |
| Idempotency-Key | Überschrift | erforderlich |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| Name (optional, Zeichenkette) | Name einer neuen Anwendung, gekürzt; höchstens 120 Unicode-Zeichen und keine Steuerzeichen. Ausgelassen oder leer wählt einen generierten Namen. Eine Versionserklärung (POST /api/applications/{id}/uploads) darf keinen tragen. maxLength: 120 |
| sha256 (erforderlich, Zeichenfolge) | SHA-256 der Archiv-Bytes. pattern: "^[0-9a-f]{64}$" |
| compressed_bytes (erforderlich, Ganzzahl) | Größe des Archivs in Bytes. Minimum: 1 Maximum: 104857600 |
| expanded_bytes (erforderlich, Ganzzahl) | Minimum: 1 Maximum: 262144000 |
| file_count (erforderlich, Ganzzahl) | Minimum: 1 Maximum: 5000 |
| sdk_version (optional, string) | maxLength: 64 |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/applications/uploads'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 201 | Signierte Autorisierung für genau einen Objekt-PUT des Archivs. Senden Sie die zurückgegebene Methode und jeden zurückgegebenen Header wörtlich; der PUT muss vor expires_at beginnen, zwei Stunden nach der Erklärung. | ApplicationUploadSession (application/json); Header: Cache-Control, RateLimit-Policy, RateLimit |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
Anwendungs-Release-Upload starten
Erklärt einen direkten Upload einer neuen unveränderlichen Version einer eigenen Anwendung, beantwortet wie POST /api/applications/uploads. If-Match schützt die Anwendungsrevision wie bei POST /api/applications/{id}/releases, und die Annahme erhöht sie. Der Body trägt keinen Namen; eine Version behält den Namen ihrer Anwendung. Bestehende Playlist-Versions-Pins werden nicht geändert.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| ScreenRig-Project | Überschrift | optional | Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch. |
| id | Pfad | erforderlich | |
| If-Match | Überschrift | optional | Optionale positive Ressourcenrevision. Weglassen, um die aktuelle Ressource zu schreiben; eine übergebene veraltete Revision ist revision_conflict. |
| Idempotency-Key | Überschrift | erforderlich |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| Name (optional, Zeichenkette) | Name einer neuen Anwendung, gekürzt; höchstens 120 Unicode-Zeichen und keine Steuerzeichen. Ausgelassen oder leer wählt einen generierten Namen. Eine Versionserklärung (POST /api/applications/{id}/uploads) darf keinen tragen. maxLength: 120 |
| sha256 (erforderlich, Zeichenfolge) | SHA-256 der Archiv-Bytes. pattern: "^[0-9a-f]{64}$" |
| compressed_bytes (erforderlich, Ganzzahl) | Größe des Archivs in Bytes. Minimum: 1 Maximum: 104857600 |
| expanded_bytes (erforderlich, Ganzzahl) | Minimum: 1 Maximum: 262144000 |
| file_count (erforderlich, Ganzzahl) | Minimum: 1 Maximum: 5000 |
| sdk_version (optional, string) | maxLength: 64 |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/applications/RESOURCE_ID/uploads'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 201 | Signierte Autorisierung für genau einen Objekt-PUT des Archivs. Senden Sie die zurückgegebene Methode und jeden zurückgegebenen Header wörtlich; der PUT muss vor expires_at beginnen, zwei Stunden nach der Erklärung. | ApplicationUploadSession (application/json); Header: Cache-Control, RateLimit-Policy, RateLimit |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
Anwendungs-Upload bestätigen
Bestätigt einen direkten Anwendungs-Upload, sobald dessen PUT abgeschlossen ist. Der Server prüft das bereitgestellte Archiv gegen die Erklärung (seine Größe und die SHA-256-Prüfsumme, die der Objektspeicher mit dem PUT genommen hat), kopiert es in seinen eigenen Upload-Bereitstellungsbereich und reiht die Veröffentlichung ein.
Warten Sie mit GET /api/operations/{id} auf die zurückgegebene Operation, bis sie succeeded oder failed ist, wie nach POST /api/applications. Ein Commit vor Abschluss des PUT antwortet invalid_request und ändert nichts, sodass er erneut gesendet werden kann; bereitgestellte Bytes, die von der Erklärung abweichen, lassen den Upload fehlschlagen. Ein wiederholter Commit antwortet dieselbe Operation.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| ScreenRig-Project | Überschrift | optional | Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch. |
| id | Pfad | erforderlich | |
| Idempotency-Key | Überschrift | erforderlich |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| sha256 (erforderlich, Zeichenfolge) | Muster: "^[0-9a-f]{64}$" |
| compressed_bytes (erforderlich, Ganzzahl) | Minimum: 1 Maximum: 104857600 |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/applications/uploads/RESOURCE_ID/commit'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 202 | Das Archiv ist bereitgestellt und seine Veröffentlichung ist eingereiht. | Operation (application/json) |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
Anwendung abrufen
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| ScreenRig-Project | Überschrift | optional | Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch. |
| id | Pfad | erforderlich |
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/applications/RESOURCE_ID'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Anwendung | Anwendung (application/json) |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
Anwendung umbenennen
Ändert den Anzeigenamen einer Anwendung, die dem authentifizierten Projekt gehört. Namen werden getrimmt, enthalten 1 bis 120 Unicode-Zeichen ohne Steuerzeichen und können innerhalb eines Projekts mehrfach vorkommen. Anwendungsidentität, Releases, K/V-Daten und Playlist-Release-Pins bleiben erhalten.
Eine geänderte Bezeichnung erhöht die Anwendungsrevision und löst application.updated aus; dieselbe Bezeichnung ist eine No-Op. If-Match schützt optional die Revision. Ein identischer idempotenter Wiederholungsversuch gibt die ursprüngliche Antwort nach nachfolgenden Metadatenänderungen zurück.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| ScreenRig-Project | Überschrift | optional | Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch. |
| id | Pfad | erforderlich | |
| If-Match | Überschrift | optional | Optionale positive Ressourcenrevision. Weglassen, um die aktuelle Ressource zu schreiben; eine übergebene veraltete Revision ist revision_conflict. |
| Idempotency-Key | Überschrift | optional | Für einen frischen Vorgang weglassen. Geben Sie einen Schlüssel an und verwenden Sie ihn erneut, um Wiederholungen zu deduplizieren; die CLI verwaltet Schlüssel automatisch. |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| Name (erforderlich, Zeichenkette) | Anzeigename nach Kürzung; Steuerungen und leere Namen werden abgelehnt. minLength: 1 maxLength: 120 |
Anfragevorlage und Antworten
curl --request PATCH --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/applications/RESOURCE_ID'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Anwendung umbenannt. | Anwendung (application/json); Header: ETag |
| 412 | revision_conflict – If-Match ist veraltet; die aktuelle Revision ist im Fehlerfeld current_revision enthalten. | Problem (application/problem+json) |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
Anwendung löschen
Tombstones eine Anwendung, die dem authentifizierten Projekt gehört, und alle ihre Releases. Der Projektinhaber ist maßgeblich; eine unbekannte oder fremde Projekt-ID ist not_found. If-Match schützt die Anwendungsrevision. Ein Live-Manifest-Verweis blockiert die Löschung mit application_in_use; es gibt keinen Force-Delete-Pfad.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| ScreenRig-Project | Überschrift | optional | Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch. |
| id | Pfad | erforderlich | |
| If-Match | Überschrift | optional | Optionale positive Ressourcenrevision. Weglassen, um die aktuelle Ressource zu schreiben; eine übergebene veraltete Revision ist revision_conflict. |
| Idempotency-Key | Überschrift | optional | Für einen frischen Vorgang weglassen. Geben Sie einen Schlüssel an und verwenden Sie ihn erneut, um Wiederholungen zu deduplizieren; die CLI verwaltet Schlüssel automatisch. |
Anfragevorlage und Antworten
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/applications/RESOURCE_ID'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 204 | Anwendung und Versionen archiviert. | kein Körper |
| 409 | application_in_use — ein Live-Manifest verweist noch auf eine der Veröffentlichungen der Anwendung. | Problem (application/problem+json) |
| 412 | revision_conflict – If-Match ist veraltet; die aktuelle Revision ist im Fehlerfeld current_revision enthalten. | Problem (application/problem+json) |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
Operation erhalten
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| ScreenRig-Project | Überschrift | optional | Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch. |
| id | Pfad | erforderlich |
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/operations/RESOURCE_ID'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Operation | Operation (application/json) |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
Vorgang abbrechen
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| ScreenRig-Project | Überschrift | optional | Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch. |
| id | Pfad | erforderlich | |
| Idempotency-Key | Überschrift | erforderlich |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Idempotency-Key: REQUEST_ID' 'https://api.screenrig.ai/api/operations/RESOURCE_ID/cancel'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Abgebrochene dauerhafte Operation. Ein aktueller Worker Fence kann sie nicht mehr abschließen. | Operation (application/json) |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |