Skip to content

[IR-6585] docs: support --services and --types on incidents #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kwent merged 2 commits into from
Nov 5, 2026
Merged

[IR-6585] docs: support --services and --types on incidents #84

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
26ecc5e
[AC1][AC2][AC3][AC4] docs: document incident association flags on cre…
kwent Nov 4, 2026
0839c60
docs: reference rootly pulse create --services in incident associations
kwent Nov 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,9 @@ rootly incidents create --title="API degradation" --field="customer_impact=Check
rootly incidents update <id> --status=mitigated
rootly incidents update <id> --scheduled-until=2025-06-20T13:00:00Z
rootly incidents update <id> --field="customer_impact=Checkout restored"
rootly incidents create --title="Checkout errors" --services=api-gateway,payments --types=customer-impacting
rootly incidents update INC-123 --services=api-gateway --teams=platform
rootly incidents update INC-123 --types= # Clears the incident types
rootly incidents delete <id>

# Alerts
Expand Down Expand Up @@ -161,6 +164,26 @@ rootly incidents create --title="Release" \
--field="regions=EU West"
```

### Incident Associations

`incidents create` and `incidents update` can link an incident to other Rootly records. Each flag takes comma-separated slugs or IDs, like `rootly pulse create --services`:

| Flag | Links | API attribute |
|------|-------|---------------|
| `--services` | Services | `service_ids` |
| `--types` | Incident types | `incident_type_ids` |
| `--functionalities` | Functionalities | `functionality_ids` |
| `--environments` | Environments | `environment_ids` |
| `--teams` | Teams | `group_ids` |
| `--causes` | Causes | `cause_ids` |

On `update`, only the flags you pass are sent. Each one replaces the incident's current list, and an empty value (`--services=`) clears it. `update` accepts a sequential ID such as `INC-123` as well as a UUID or slug.

```bash
rootly incidents create --title="Checkout errors" --services=api-gateway,payments --types=customer-impacting
rootly incidents update INC-123 --services=api-gateway --teams=platform
```

### Status-Page Templates and Maintenance Statuses

List a status page's templates with `rootly status-pages templates list --status-page=<id>`. The command supports `--page`, `--page-size`, and the standard `--format` output flag.
Expand Down
Loading