Alertas: referencia de la API, endpoints y ejemplos

OpenAPI YAML OpenAPI JSON problemas YAML Resumen de la API

Este grupo tiene 6 operaciones, generadas a partir de api/openapi.yaml. Filtre por ruta, acción o autenticación. Cada endpoint indica sus entradas; despliéguelo para ver una plantilla de solicitud y los códigos de respuesta. Las plantillas necesitan sus propios valores y un cuerpo válido según el esquema.

Reemplace los marcadores en mayúsculas con sus valores. Para una solicitud JSON, guarde un cuerpo que coincida con el esquema en request.json. Los ejemplos de cookies usan un frasco de cookies local de una sesión autenticada.

Alertas: problemas abiertos de las pantallas, reconocimiento, aplazamiento y silenciamientos

GET/api/alerts¶

Listar alertas

Lista las alertas de pantalla del proyecto: una por pantalla y condición mientras dura (open), y las que terminaron dentro de la retención de eventos del plan (resolved).

Una alerta se abre cuando llega el evento de su condición (screen.offline, un cambio de salud display_disconnected, temperature_high u on_battery, screen.storage_shortfall, un screen.manifest_upgrade atascado, un screen.status_changed de nivel error, un screen.glass_changed con veredicto detenido, en blanco o congelado) y se resuelve con el evento que pone fin a su condición; crashing es un aviso, no una alerta. counts.attention cuenta las alertas abiertas que no están reconocidas, pospuestas ni silenciadas, el número que muestra el panel.

Una pantalla que se reinicia por un reinicio que envió el backend no abre ninguna alerta screen_offline o display_disconnected hasta que el reinicio termina o pasan diez minutos desde que se envió; una condición que sigue vigente entonces abre su alerta en ese momento. Las alertas abiertas van primero, las más nuevas primero; pase next_cursor de vuelta como antes para la página siguiente.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: listAlerts

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
formato	consulta	opcional	json (por defecto) devuelve el informe como JSON. csv, xlsx y pdf devuelven las mismas filas como archivo adjunto (cada página de un informe paginado, hasta 50000 filas).
estado	consulta	opcional
screen_id	consulta	opcional
before	consulta	opcional	next_cursor de la página anterior.
límite	consulta	opcional

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/alerts'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Una página de alertas.	AlertList (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

GET/api/alerts/{id}¶

Obtener alerta

Una alerta.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: getAlert

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/alerts/RESOURCE_ID'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	La alerta.	Alert (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

POST/api/alerts/{id}/acknowledge¶

Reconocer alerta

Reconoce una alerta abierta: alguien se está ocupando de ella. Sin until, sigue reconocida hasta que se resuelve; con until (como máximo 30 días en el futuro), se pospone y vuelve a necesitar atención en ese instante si sigue abierta. Mientras está reconocida o pospuesta, se omite el aviso de una notificación sobre ella que aún está en su tiempo de espera (acknowledged).

Un reconocimiento posterior reemplaza al anterior. Agrega screen.alert_acknowledged. Una alerta resuelta es alert_not_open.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: AlertAcknowledge
ID de operación: acknowledgeAlert

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido
Idempotency-Key	encabezado	opcional	Omitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.

Campos del cuerpo de la solicitud

Campo	Descripción
until (opcional, string)	Posponer hasta este instante, como máximo 30 días en el futuro. Si se omite: reconocida hasta que la alerta se resuelve. format: "date-time"

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

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'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	La alerta reconocida.	Alert (application/json)
409	alert_not_open.	Problema (application/problem+json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

GET/api/alert-mutes¶

Listar silenciamientos de alertas

Lista los silenciamientos del proyecto que no han terminado, primero el que termina antes (como máximo 50).

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: listAlertMutes

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/alert-mutes'

Respuestas

Estado	Significado	Cuerpo y encabezados
200	Los silenciamientos vigentes del proyecto.	AlertMuteList (application/json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

POST/api/alert-mutes¶

Crear silenciamiento de alertas

Silencia pantallas por mantenimiento hasta un instante que esté como máximo 30 días en el futuro: las pantallas nombradas en screen_ids y toda pantalla que lleve alguna de las etiquetas de tags en el momento en que corresponde enviar un aviso. Sus alertas siguen abriéndose y resolviéndose, marcadas como muted, pero nunca necesitan atención; se omiten los avisos de todas las notificaciones sobre ellas (muted).

Una organización tiene como máximo 50 silenciamientos vigentes en todos sus proyectos (alert_mute_limit_reached). Agrega alert_mute.created.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: AlertMuteWrite
ID de operación: createAlertMute

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
Idempotency-Key	encabezado	opcional	Omitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.

Campos del cuerpo de la solicitud

Campo	Descripción
screen_ids (opcional, array)
etiquetas (opcional, ScreenTags)	Etiquetas de selector de flota, de 0 a 16 etiquetas únicas exactas, cada una que coincide con la gramática de etiquetas de medios. En ScreenPatch el arreglo reemplaza todo el conjunto y un arreglo vacío lo borra; una etiqueta duplicada o malformada es invalid_request. Cambiar etiquetas aumenta la revisión de pantalla (If-Match la protege) y añade screen.updated con details.tags; nunca cambia la revisión del manifiesto. Las etiquetas nunca están en el manifiesto en tiempo de ejecución ni en la autorización.
until (obligatorio, string)	Como máximo 30 días en el futuro. format: "date-time"
note (opcional, string)	maxLength: 200

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

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'

Respuestas

Estado	Significado	Cuerpo y encabezados
201	Creado.	AlertMute (application/json)
409	alert_mute_limit_reached o idempotency_mismatch.	Problema (application/problem+json)
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)

ELIMINAR/api/alert-mutes/{id}¶

Eliminar silenciamiento de alertas

Termina un silenciamiento ahora y agrega alert_mute.deleted.

Autenticación: projectBearer O dashboardSession
Cuerpo de la solicitud: ninguno
ID de operación: deleteAlertMute

Parámetros

Nombre	Enviar	¿Requerido?	Descripción
ScreenRig-Project	encabezado	opcional	Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
id	ruta	requerido
Idempotency-Key	encabezado	opcional	Omitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.

Plantilla y respuestas de solicitud

shell · plantilla de solicitud

curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/alert-mutes/RESOURCE_ID'

Respuestas

Estado	Significado	Cuerpo y encabezados
204	Terminado.	sin cuerpo
predeterminado	Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.	Problema (application/problem+json)