Skip to content

app.system_banners

TableRow level security on

Platform-wide in-app banners (A90, Section 4.10): maintenance windows, incidents linked to the status page, plan notices and other notices, scheduled in instants for every shell or one. Written only by the console RPCs (banners.write); read by the shells through api_public.active_system_banners. An ended banner never changes.

Primary key: id

Columns of app.system_banners
ColumnTypeNullableDescription
iduuidNoBanner id, UUID v7.
banner_kindapp.system_banner_kindNoMaintenance, Incident, Plan Notice or Notice.
severityapp.system_banner_severityNoInfo, Warning or Critical.
audienceapp.system_banner_audienceNoEveryone, Atlas, Gateway or Compass.
messagetextNoThe banner text in en-US, plain and direct, up to 300 characters.
message_estextYesThe banner text in es-US; the en-US text shows when it is missing.
link_urltextYesAn https link, such as the status page; required for an incident.
starts_attimestamp with time zoneNoWhen the banner starts showing.
ends_attimestamp with time zoneYesWhen it stops showing, at most 90 days after it starts; null runs until an operator ends it (incidents and notices).
dismissiblebooleanNoWhether a person may hide it on their device; never for a Critical banner.
ended_attimestamp with time zoneYesWhen an operator ended it early.
ended_byuuidYesOperator who ended it early.References app.people.id
created_attimestamp with time zoneNoWhen the row was inserted. Set by the database.
created_byuuidYesPerson who inserted the row, or null for a platform process. Set by the database.References app.people.id
updated_attimestamp with time zoneNoWhen the row last changed. Set by the database.
updated_byuuidYesPerson who last changed the row, or null for a platform process. Set by the database.References app.people.id
deleted_attimestamp with time zoneYesSoft delete time. A row with deleted_at set is ignored by every access helper.