OpenAPI YAMLOpenAPI JSONproblèmes YAMLVue d’ensemble de l’API
Ce groupe compte 6 opérations, générées à partir de api/openapi.yaml. Filtrez par chemin, action ou authentification. Chaque point de terminaison liste ses entrées ; développez-le pour voir un modèle de requête et les codes de réponse. Les modèles demandent vos propres valeurs et un corps conforme au schéma.
Remplacez les espaces réservés en majuscules par vos valeurs. Pour une requête JSON, enregistrez un corps correspondant au schéma dans request.json. Les exemples de cookies utilisent un pot à cookies local issu d’une session authentifiée.
Alertes : problèmes d’écran ouverts, acquittement, report et mises en sourdine
Lister les alertes
Liste les alertes d’écran du projet : une par écran et par condition tant qu’elle dure (open), et celles qui ont pris fin pendant la rétention d’événements du forfait (resolved).
Une alerte s’ouvre lorsque l’événement de sa condition arrive (screen.offline, un changement d’état de santé display_disconnected, temperature_high ou on_battery, screen.storage_shortfall, un screen.manifest_upgrade bloqué, un screen.status_changed de niveau erreur, un screen.glass_changed dont le verdict est bloqué, vide ou figé) et se résout à l’événement qui met fin à sa condition ; crashing est un avis, pas une alerte. counts.attention compte les alertes ouvertes qui ne sont ni acquittées, ni reportées, ni en sourdine, le nombre que le tableau de bord affiche.
Un écran qui redémarre à cause d’un redémarrage envoyé par le backend n’ouvre aucune alerte screen_offline ou display_disconnected avant la fin du redémarrage ou dix minutes après son envoi ; une condition qui tient toujours à ce moment ouvre alors son alerte. Les alertes ouvertes viennent d’abord, les plus récentes en premier ; renvoyez next_cursor comme avant pour la page suivante.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| ScreenRig-Project | en-tête | optionnel | Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton. |
| format | requête | optionnel | json (par défaut) renvoie le rapport en JSON. csv, xlsx et pdf renvoient les mêmes lignes en pièce jointe (chaque page d'un rapport paginé, jusqu'à 50000 lignes). |
| état | requête | optionnel | |
| screen_id | requête | optionnel | |
| avant | requête | optionnel | next_cursor de la page précédente. |
| limite | requête | optionnel |
Modèle de requête et réponses
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/alerts'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | Une page d’alertes. | AlertList (application/json) |
| par défaut | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
Obtenir l’alerte
Une alerte.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| ScreenRig-Project | en-tête | optionnel | Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton. |
| id | chemin | obligatoire |
Modèle de requête et réponses
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/alerts/RESOURCE_ID'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | L’alerte. | Alert (application/json) |
| par défaut | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
Acquitter l’alerte
Acquitte une alerte ouverte : quelqu’un s’en occupe. Sans until, elle reste acquittée jusqu’à sa résolution; avec until (au plus 30 jours plus tard), elle est reportée et demande de nouveau de l’attention à cet instant si elle est encore ouverte. Tant qu’elle est acquittée ou reportée, l’avis d’une notification à son sujet qui est encore en délai d’attente est ignoré (acknowledged).
Un acquittement ultérieur remplace le précédent. Ajoute screen.alert_acknowledged. Une alerte résolue donne alert_not_open.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| ScreenRig-Project | en-tête | optionnel | Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton. |
| id | chemin | obligatoire | |
| Idempotency-Key | en-tête | optionnel | Omettre pour une opération fraîche. Fournissez et réutilisez une clé pour dédupliquer les tentatives ; le CLI gère les clés automatiquement. |
Champs du corps de la requête
| Champ | Description |
|---|---|
| until (optionnel, string) | Reporter jusqu’à cet instant, au plus 30 jours plus tard. Absent : acquittée jusqu’à la résolution de l’alerte. format: "date-time" |
Modèle de requête et réponses
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/alerts/RESOURCE_ID/acknowledge'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | L’alerte acquittée. | Alert (application/json) |
| 409 | alert_not_open. | Problème (application/problem+json) |
| par défaut | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
Lister les mises en sourdine d’alertes
Liste les mises en sourdine du projet qui ne sont pas terminées, celles qui finissent le plus tôt d’abord (au plus 50).
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| ScreenRig-Project | en-tête | optionnel | Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton. |
Modèle de requête et réponses
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/alert-mutes'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | Les mises en sourdine en cours du projet. | AlertMuteList (application/json) |
| par défaut | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
Créer une mise en sourdine d’alertes
Met des écrans en sourdine pour la maintenance jusqu’à un instant au plus 30 jours plus tard : les écrans nommés par screen_ids, et chaque écran portant l’une des étiquettes de tags au moment où un avis est dû. Leurs alertes continuent de s’ouvrir et de se résoudre, marquées muted, mais ne demandent jamais d’attention; les avis de chaque notification à leur sujet sont ignorés (muted).
Une organisation compte au plus 50 mises en sourdine en cours, tous projets confondus (alert_mute_limit_reached). Ajoute alert_mute.created.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| ScreenRig-Project | en-tête | optionnel | Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton. |
| Idempotency-Key | en-tête | optionnel | Omettre pour une opération fraîche. Fournissez et réutilisez une clé pour dédupliquer les tentatives ; le CLI gère les clés automatiquement. |
Champs du corps de la requête
| Champ | Description |
|---|---|
| screen_ids (optionnel, array) | |
| étiquettes (optionnelles, ScreenTags) | Étiquettes de sélection de flotte, de 0 à 16 étiquettes exactes uniques, chacune correspondant à la grammaire des étiquettes médias. Sur ScreenPatch, le tableau remplace l’ensemble complet et un tableau vide le vide ; une étiquette en double ou mal formée est invalid_request. Modifier les étiquettes augmente la révision de l’écran (If-Match la protège) et ajoute screen.updated avec details.tags ; cela ne modifie jamais la révision du manifeste. Les étiquettes ne figurent jamais dans le manifeste d’exécution ni dans l’autorisation. |
| until (obligatoire, string) | Au plus 30 jours plus tard. format: "date-time" |
| note (facultatif, string) | maxLength : 200 |
Modèle de requête et réponses
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/alert-mutes'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 201 | Créé. | AlertMute (application/json) |
| 409 | alert_mute_limit_reached ou idempotency_mismatch. | Problème (application/problem+json) |
| par défaut | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
Supprimer la mise en sourdine d’alertes
Met fin à une mise en sourdine maintenant et ajoute alert_mute.deleted.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| ScreenRig-Project | en-tête | optionnel | Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton. |
| id | chemin | obligatoire | |
| Idempotency-Key | en-tête | optionnel | Omettre pour une opération fraîche. Fournissez et réutilisez une clé pour dédupliquer les tentatives ; le CLI gère les clés automatiquement. |
Modèle de requête et réponses
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/alert-mutes/RESOURCE_ID'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 204 | Terminée. | pas de corps |
| par défaut | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |