Status page
Publish incidents and maintenance windows to the public status page. Generated from the `notploy` command surface.
Publish incidents and maintenance windows to the public status page.
notploy status exposes 12 commands. They map one-to-one onto the status.* API operations, so anything reachable from the dashboard is reachable from here.
Run notploy status --help to list these commands in your terminal, or
notploy status <command> --help for a single command.
Commands
notploy status add-incident-update
Calls POST /api/trpc/status.addIncidentUpdate.
notploy status add-incident-update --incidentId <value> --message <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--incidentId <value> | string | Yes | — |
--message <value> | string | Yes | — |
--state <value> | string | No | investigating, identified, monitoring, resolved |
--visibility <value> | string | No | public, private |
--profile <name> | string | No | — |
notploy status create-incident
Calls POST /api/trpc/status.createIncident.
notploy status create-incident --pageRef <value> --title <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--pageRef <value> | string | Yes | — |
--title <value> | string | Yes | — |
--description <value> | string | No | — |
--severity <value> | string | No | minor, major, critical |
--state <value> | string | No | investigating, identified, monitoring, resolved |
--visibility <value> | string | No | public, private |
--published [boolean] | boolean | No | — |
--no-published | boolean | No | — |
--componentIds <json> | array | No | — |
--correlationKey <value> | string | No | — |
--updateMessage <value> | string | No | — |
--profile <name> | string | No | — |
notploy status create-maintenance
Calls POST /api/trpc/status.createMaintenance.
notploy status create-maintenance --pageRef <value> --title <value> --startAt <value> --endAt <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--pageRef <value> | string | Yes | — |
--title <value> | string | Yes | — |
--description <value> | string | No | — |
--startAt <value> | string | Yes | — |
--endAt <value> | string | Yes | — |
--timeZone <value> | string | No | — |
--componentIds <json> | array | No | — |
--visibility <value> | string | No | public, private |
--published [boolean] | boolean | No | — |
--no-published | boolean | No | — |
--profile <name> | string | No | — |
notploy status delete-incident
Calls POST /api/trpc/status.deleteIncident.
notploy status delete-incident --incidentId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--incidentId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy status delete-maintenance
Calls POST /api/trpc/status.deleteMaintenance.
notploy status delete-maintenance --maintenanceId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--maintenanceId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy status overview
Calls GET /api/trpc/status.overview.
notploy status overview [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--profile <name> | string | No | — |
notploy status publish-incident
Calls POST /api/trpc/status.publishIncident.
notploy status publish-incident --incidentId <value> --published [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--incidentId <value> | string | Yes | — |
--published [boolean] | boolean | Yes | — |
--visibility <value> | string | No | public, private |
--profile <name> | string | No | — |
notploy status publish-maintenance
Calls POST /api/trpc/status.publishMaintenance.
notploy status publish-maintenance --maintenanceId <value> --published [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--maintenanceId <value> | string | Yes | — |
--published [boolean] | boolean | Yes | — |
--visibility <value> | string | No | public, private |
--profile <name> | string | No | — |
notploy status set-incident-state
Calls POST /api/trpc/status.setIncidentState.
notploy status set-incident-state --incidentId <value> --state <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--incidentId <value> | string | Yes | — |
--state <value> | string | Yes | investigating, identified, monitoring, resolved |
--message <value> | string | No | — |
--profile <name> | string | No | — |
notploy status set-maintenance-state
Calls POST /api/trpc/status.setMaintenanceState.
notploy status set-maintenance-state --maintenanceId <value> --state <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--maintenanceId <value> | string | Yes | — |
--state <value> | string | Yes | scheduled, in_progress, completed, cancelled |
--message <value> | string | No | — |
--profile <name> | string | No | — |
notploy status timeline
Calls GET /api/trpc/status.timeline.
notploy status timeline --incidentId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--incidentId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy status update-incident
Calls POST /api/trpc/status.updateIncident.
notploy status update-incident --incidentId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--incidentId <value> | string | Yes | — |
--title <value> | string | No | — |
--description <value> | string | No | — |
--severity <value> | string | No | minor, major, critical |
--visibility <value> | string | No | public, private |
--componentIds <json> | array | No | — |
--profile <name> | string | No | — |