Rootly

使用说明

Integrate Rootly incident management into workflows. Create and manage incidents, alerts, services, severities, and retrospectives.

工具

`rootly_create_incident`

Create a new incident in Rootly with optional severity, services, and teams.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`title`	string	否	The title of the incident (auto-generated if not provided)
`summary`	string	否	A summary of the incident
`severityId`	string	否	Severity ID to attach to the incident
`status`	string	否	Incident status (in_triage, started, detected, acknowledged, mitigated, resolved, closed, cancelled, scheduled, in_progress, completed)
`kind`	string	否	Incident kind (normal, normal_sub, test, test_sub, example, example_sub, backfilled, scheduled, scheduled_sub)
`serviceIds`	string	否	Comma-separated service IDs to attach
`environmentIds`	string	否	Comma-separated environment IDs to attach
`groupIds`	string	否	Comma-separated team/group IDs to attach
`incidentTypeIds`	string	否	Comma-separated incident type IDs to attach
`functionalityIds`	string	否	Comma-separated functionality IDs to attach
`labels`	string	否	Labels as JSON object, e.g. {"platform":"osx","version":"1.29"}
`private`	boolean	否	Create as a private incident (cannot be undone)

输出

参数	类型	描述
`incident`	object	The created incident
↳ `id`	string	Unique incident ID
↳ `sequentialId`	number	Sequential incident number
↳ `title`	string	Incident title
↳ `slug`	string	Incident slug
↳ `kind`	string	Incident kind
↳ `summary`	string	Incident summary
↳ `status`	string	Incident status
↳ `private`	boolean	Whether the incident is private
↳ `url`	string	URL to the incident
↳ `shortUrl`	string	Short URL to the incident
↳ `severityName`	string	Severity name
↳ `severityId`	string	Severity ID
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
↳ `startedAt`	string	Start date
↳ `mitigatedAt`	string	Mitigation date
↳ `resolvedAt`	string	Resolution date
↳ `closedAt`	string	Closed date

`rootly_get_incident`

Retrieve a single incident by ID from Rootly.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`incidentId`	string	是	The ID of the incident to retrieve

输出

参数	类型	描述
`incident`	object	The incident details
↳ `id`	string	Unique incident ID
↳ `sequentialId`	number	Sequential incident number
↳ `title`	string	Incident title
↳ `slug`	string	Incident slug
↳ `kind`	string	Incident kind
↳ `summary`	string	Incident summary
↳ `status`	string	Incident status
↳ `private`	boolean	Whether the incident is private
↳ `url`	string	URL to the incident
↳ `shortUrl`	string	Short URL to the incident
↳ `severityName`	string	Severity name
↳ `severityId`	string	Severity ID
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
↳ `startedAt`	string	Start date
↳ `mitigatedAt`	string	Mitigation date
↳ `resolvedAt`	string	Resolution date
↳ `closedAt`	string	Closed date

`rootly_update_incident`

Update an existing incident in Rootly (status, severity, summary, etc.).

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`incidentId`	string	是	The ID of the incident to update
`title`	string	否	Updated incident title
`summary`	string	否	Updated incident summary
`severityId`	string	否	Updated severity ID
`status`	string	否	Updated status (in_triage, started, detected, acknowledged, mitigated, resolved, closed, cancelled, scheduled, in_progress, completed)
`kind`	string	否	Incident kind (normal, normal_sub, test, test_sub, example, example_sub, backfilled, scheduled, scheduled_sub)
`private`	boolean	否	Set incident as private (cannot be undone)
`serviceIds`	string	否	Comma-separated service IDs
`environmentIds`	string	否	Comma-separated environment IDs
`groupIds`	string	否	Comma-separated team/group IDs
`incidentTypeIds`	string	否	Comma-separated incident type IDs to attach
`functionalityIds`	string	否	Comma-separated functionality IDs to attach
`labels`	string	否	Labels as JSON object, e.g. {"platform":"osx","version":"1.29"}
`mitigationMessage`	string	否	How was the incident mitigated?
`resolutionMessage`	string	否	How was the incident resolved?
`cancellationMessage`	string	否	Why was the incident cancelled?

输出

参数	类型	描述
`incident`	object	The updated incident
↳ `id`	string	Unique incident ID
↳ `sequentialId`	number	Sequential incident number
↳ `title`	string	Incident title
↳ `slug`	string	Incident slug
↳ `kind`	string	Incident kind
↳ `summary`	string	Incident summary
↳ `status`	string	Incident status
↳ `private`	boolean	Whether the incident is private
↳ `url`	string	URL to the incident
↳ `shortUrl`	string	Short URL to the incident
↳ `severityName`	string	Severity name
↳ `severityId`	string	Severity ID
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
↳ `startedAt`	string	Start date
↳ `mitigatedAt`	string	Mitigation date
↳ `resolvedAt`	string	Resolution date
↳ `closedAt`	string	Closed date

`rootly_list_incidents`

List incidents from Rootly with optional filtering by status, severity, and more.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`status`	string	否	Filter by status (in_triage, started, detected, acknowledged, mitigated, resolved, closed, cancelled, scheduled, in_progress, completed)
`severity`	string	否	Filter by severity slug
`search`	string	否	Search term to filter incidents
`services`	string	否	Filter by service slugs (comma-separated)
`teams`	string	否	Filter by team slugs (comma-separated)
`environments`	string	否	Filter by environment slugs (comma-separated)
`sort`	string	否	Sort order (e.g., -created_at, created_at, -started_at)
`pageSize`	number	否	Number of items per page (default: 20)
`pageNumber`	number	否	Page number for pagination

输出

参数	类型	描述
`incidents`	array	List of incidents
↳ `id`	string	Unique incident ID
↳ `sequentialId`	number	Sequential incident number
↳ `title`	string	Incident title
↳ `slug`	string	Incident slug
↳ `kind`	string	Incident kind
↳ `summary`	string	Incident summary
↳ `status`	string	Incident status
↳ `private`	boolean	Whether the incident is private
↳ `url`	string	URL to the incident
↳ `shortUrl`	string	Short URL to the incident
↳ `severityName`	string	Severity name
↳ `severityId`	string	Severity ID
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
↳ `startedAt`	string	Start date
↳ `mitigatedAt`	string	Mitigation date
↳ `resolvedAt`	string	Resolution date
↳ `closedAt`	string	Closed date
`totalCount`	number	Total number of incidents returned

`rootly_create_alert`

Create a new alert in Rootly for on-call notification and routing.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`summary`	string	是	The summary of the alert
`description`	string	否	A detailed description of the alert
`source`	string	是	The source of the alert (e.g., api, manual, datadog, pagerduty)
`status`	string	否	Alert status on creation (open, triggered)
`serviceIds`	string	否	Comma-separated service IDs to attach
`groupIds`	string	否	Comma-separated team/group IDs to attach
`environmentIds`	string	否	Comma-separated environment IDs to attach
`externalId`	string	否	External ID for the alert
`externalUrl`	string	否	External URL for the alert
`deduplicationKey`	string	否	Alerts sharing the same deduplication key are treated as a single alert

输出

参数	类型	描述
`alert`	object	The created alert
↳ `id`	string	Unique alert ID
↳ `shortId`	string	Short alert ID
↳ `summary`	string	Alert summary
↳ `description`	string	Alert description
↳ `source`	string	Alert source
↳ `status`	string	Alert status
↳ `externalId`	string	External ID
↳ `externalUrl`	string	External URL
↳ `deduplicationKey`	string	Deduplication key
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
↳ `startedAt`	string	Start date
↳ `endedAt`	string	End date

`rootly_list_alerts`

List alerts from Rootly with optional filtering by status, source, and services.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`status`	string	否	Filter by status (open, triggered, acknowledged, resolved)
`source`	string	否	Filter by source (e.g., api, datadog, pagerduty)
`services`	string	否	Filter by service slugs (comma-separated)
`environments`	string	否	Filter by environment slugs (comma-separated)
`groups`	string	否	Filter by team/group slugs (comma-separated)
`pageSize`	number	否	Number of items per page (default: 20)
`pageNumber`	number	否	Page number for pagination

输出

参数	类型	描述
`alerts`	array	List of alerts
↳ `id`	string	Unique alert ID
↳ `shortId`	string	Short alert ID
↳ `summary`	string	Alert summary
↳ `description`	string	Alert description
↳ `source`	string	Alert source
↳ `status`	string	Alert status
↳ `externalId`	string	External ID
↳ `externalUrl`	string	External URL
↳ `deduplicationKey`	string	Deduplication key
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
↳ `startedAt`	string	Start date
↳ `endedAt`	string	End date
`totalCount`	number	Total number of alerts returned

`rootly_add_incident_event`

Add a timeline event to an existing incident in Rootly.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`incidentId`	string	是	The ID of the incident to add the event to
`event`	string	是	The summary/description of the event
`visibility`	string	否	Event visibility (internal or external)

输出

参数	类型	描述
`eventId`	string	The ID of the created event
`event`	string	The event summary
`visibility`	string	Event visibility (internal or external)
`occurredAt`	string	When the event occurred
`createdAt`	string	Creation date
`updatedAt`	string	Last update date

`rootly_list_services`

List services from Rootly with optional search filtering.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`search`	string	否	Search term to filter services
`pageSize`	number	否	Number of items per page (default: 20)
`pageNumber`	number	否	Page number for pagination

输出

参数	类型	描述
`services`	array	List of services
↳ `id`	string	Unique service ID
↳ `name`	string	Service name
↳ `slug`	string	Service slug
↳ `description`	string	Service description
↳ `color`	string	Service color
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
`totalCount`	number	Total number of services returned

`rootly_list_severities`

List severity levels configured in Rootly.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`search`	string	否	Search term to filter severities
`pageSize`	number	否	Number of items per page (default: 20)
`pageNumber`	number	否	Page number for pagination

输出

参数	类型	描述
`severities`	array	List of severity levels
↳ `id`	string	Unique severity ID
↳ `name`	string	Severity name
↳ `slug`	string	Severity slug
↳ `description`	string	Severity description
↳ `severity`	string	Severity level (critical, high, medium, low)
↳ `color`	string	Severity color
↳ `position`	number	Display position
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
`totalCount`	number	Total number of severities returned

`rootly_list_teams`

List teams (groups) configured in Rootly.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`search`	string	否	Search term to filter teams
`pageSize`	number	否	Number of items per page (default: 20)
`pageNumber`	number	否	Page number for pagination

输出

参数	类型	描述
`teams`	array	List of teams
↳ `id`	string	Unique team ID
↳ `name`	string	Team name
↳ `slug`	string	Team slug
↳ `description`	string	Team description
↳ `color`	string	Team color
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
`totalCount`	number	Total number of teams returned

`rootly_list_environments`

List environments configured in Rootly.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`search`	string	否	Search term to filter environments
`pageSize`	number	否	Number of items per page (default: 20)
`pageNumber`	number	否	Page number for pagination

输出

参数	类型	描述
`environments`	array	List of environments
↳ `id`	string	Unique environment ID
↳ `name`	string	Environment name
↳ `slug`	string	Environment slug
↳ `description`	string	Environment description
↳ `color`	string	Environment color
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
`totalCount`	number	Total number of environments returned

`rootly_list_incident_types`

List incident types configured in Rootly.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`search`	string	否	Filter incident types by name
`pageSize`	number	否	Number of items per page (default: 20)
`pageNumber`	number	否	Page number for pagination

输出

参数	类型	描述
`incidentTypes`	array	List of incident types
↳ `id`	string	Unique incident type ID
↳ `name`	string	Incident type name
↳ `slug`	string	Incident type slug
↳ `description`	string	Incident type description
↳ `color`	string	Incident type color
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
`totalCount`	number	Total number of incident types returned

`rootly_list_functionalities`

List functionalities configured in Rootly.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`search`	string	否	Search term to filter functionalities
`pageSize`	number	否	Number of items per page (default: 20)
`pageNumber`	number	否	Page number for pagination

输出

参数	类型	描述
`functionalities`	array	List of functionalities
↳ `id`	string	Unique functionality ID
↳ `name`	string	Functionality name
↳ `slug`	string	Functionality slug
↳ `description`	string	Functionality description
↳ `color`	string	Functionality color
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
`totalCount`	number	Total number of functionalities returned

`rootly_list_retrospectives`

List incident retrospectives (post-mortems) from Rootly.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`status`	string	否	Filter by status (draft, published)
`search`	string	否	Search term to filter retrospectives
`pageSize`	number	否	Number of items per page (default: 20)
`pageNumber`	number	否	Page number for pagination

输出

参数	类型	描述
`retrospectives`	array	List of retrospectives
↳ `id`	string	Unique retrospective ID
↳ `title`	string	Retrospective title
↳ `status`	string	Status (draft or published)
↳ `url`	string	URL to the retrospective
↳ `startedAt`	string	Incident start date
↳ `mitigatedAt`	string	Mitigation date
↳ `resolvedAt`	string	Resolution date
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
`totalCount`	number	Total number of retrospectives returned

`rootly_delete_incident`

Delete an incident by ID from Rootly.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`incidentId`	string	是	The ID of the incident to delete

输出

参数	类型	描述
`success`	boolean	Whether the deletion succeeded
`message`	string	Result message

`rootly_get_alert`

Retrieve a single alert by ID from Rootly.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`alertId`	string	是	The ID of the alert to retrieve

输出

参数	类型	描述
`alert`	object	The alert details
↳ `id`	string	Unique alert ID
↳ `shortId`	string	Short alert ID
↳ `summary`	string	Alert summary
↳ `description`	string	Alert description
↳ `source`	string	Alert source
↳ `status`	string	Alert status
↳ `externalId`	string	External ID
↳ `externalUrl`	string	External URL
↳ `deduplicationKey`	string	Deduplication key
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
↳ `startedAt`	string	Start date
↳ `endedAt`	string	End date

`rootly_update_alert`

Update an existing alert in Rootly.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`alertId`	string	是	The ID of the alert to update
`summary`	string	否	Updated alert summary
`description`	string	否	Updated alert description
`source`	string	否	Updated alert source
`serviceIds`	string	否	Comma-separated service IDs to attach
`groupIds`	string	否	Comma-separated team/group IDs to attach
`environmentIds`	string	否	Comma-separated environment IDs to attach
`externalId`	string	否	Updated external ID
`externalUrl`	string	否	Updated external URL
`deduplicationKey`	string	否	Updated deduplication key

输出

参数	类型	描述
`alert`	object	The updated alert
↳ `id`	string	Unique alert ID
↳ `shortId`	string	Short alert ID
↳ `summary`	string	Alert summary
↳ `description`	string	Alert description
↳ `source`	string	Alert source
↳ `status`	string	Alert status
↳ `externalId`	string	External ID
↳ `externalUrl`	string	External URL
↳ `deduplicationKey`	string	Deduplication key
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
↳ `startedAt`	string	Start date
↳ `endedAt`	string	End date

`rootly_acknowledge_alert`

Acknowledge an alert in Rootly.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`alertId`	string	是	The ID of the alert to acknowledge

输出

参数	类型	描述
`alert`	object	The acknowledged alert
↳ `id`	string	Unique alert ID
↳ `shortId`	string	Short alert ID
↳ `summary`	string	Alert summary
↳ `description`	string	Alert description
↳ `source`	string	Alert source
↳ `status`	string	Alert status
↳ `externalId`	string	External ID
↳ `externalUrl`	string	External URL
↳ `deduplicationKey`	string	Deduplication key
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
↳ `startedAt`	string	Start date
↳ `endedAt`	string	End date

`rootly_resolve_alert`

Resolve an alert in Rootly.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`alertId`	string	是	The ID of the alert to resolve
`resolutionMessage`	string	否	Message describing how the alert was resolved
`resolveRelatedIncidents`	boolean	否	Whether to also resolve related incidents

输出

参数	类型	描述
`alert`	object	The resolved alert
↳ `id`	string	Unique alert ID
↳ `shortId`	string	Short alert ID
↳ `summary`	string	Alert summary
↳ `description`	string	Alert description
↳ `source`	string	Alert source
↳ `status`	string	Alert status
↳ `externalId`	string	External ID
↳ `externalUrl`	string	External URL
↳ `deduplicationKey`	string	Deduplication key
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
↳ `startedAt`	string	Start date
↳ `endedAt`	string	End date

`rootly_create_action_item`

Create a new action item for an incident in Rootly.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`incidentId`	string	是	The ID of the incident to add the action item to
`summary`	string	是	The title of the action item
`description`	string	否	A detailed description of the action item
`kind`	string	否	The kind of action item (task, follow_up)
`priority`	string	否	Priority level (high, medium, low)
`status`	string	否	Action item status (open, in_progress, cancelled, done)
`assignedToUserId`	string	否	The user ID to assign the action item to
`dueDate`	string	否	Due date for the action item

输出

参数	类型	描述
`actionItem`	object	The created action item
↳ `id`	string	Unique action item ID
↳ `summary`	string	Action item title
↳ `description`	string	Action item description
↳ `kind`	string	Action item kind (task, follow_up)
↳ `priority`	string	Priority level
↳ `status`	string	Action item status
↳ `dueDate`	string	Due date
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date

`rootly_list_action_items`

List action items for an incident in Rootly.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`incidentId`	string	是	The ID of the incident to list action items for
`pageSize`	number	否	Number of items per page (default: 20)
`pageNumber`	number	否	Page number for pagination

输出

参数	类型	描述
`actionItems`	array	List of action items
↳ `id`	string	Unique action item ID
↳ `summary`	string	Action item title
↳ `description`	string	Action item description
↳ `kind`	string	Action item kind (task, follow_up)
↳ `priority`	string	Priority level
↳ `status`	string	Action item status
↳ `dueDate`	string	Due date
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
`totalCount`	number	Total number of action items returned

`rootly_list_users`

List users from Rootly with optional search and email filtering.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`search`	string	否	Search term to filter users
`email`	string	否	Filter users by email address
`pageSize`	number	否	Number of items per page (default: 20)
`pageNumber`	number	否	Page number for pagination

输出

参数	类型	描述
`users`	array	List of users
↳ `id`	string	Unique user ID
↳ `email`	string	User email address
↳ `firstName`	string	User first name
↳ `lastName`	string	User last name
↳ `fullName`	string	User full name
↳ `timeZone`	string	User time zone
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
`totalCount`	number	Total number of users returned

`rootly_list_on_calls`

List current on-call entries from Rootly with optional filtering.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`scheduleIds`	string	否	Comma-separated schedule IDs to filter by
`escalationPolicyIds`	string	否	Comma-separated escalation policy IDs to filter by
`userIds`	string	否	Comma-separated user IDs to filter by
`serviceIds`	string	否	Comma-separated service IDs to filter by

输出

参数	类型	描述
`onCalls`	array	List of on-call entries
↳ `id`	string	Unique on-call entry ID
↳ `userId`	string	ID of the on-call user
↳ `userName`	string	Name of the on-call user
↳ `scheduleId`	string	ID of the associated schedule
↳ `scheduleName`	string	Name of the associated schedule
↳ `escalationPolicyId`	string	ID of the associated escalation policy
↳ `startTime`	string	On-call start time
↳ `endTime`	string	On-call end time
`totalCount`	number	Total number of on-call entries returned

`rootly_list_schedules`

List on-call schedules from Rootly with optional search filtering.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`search`	string	否	Search term to filter schedules
`pageSize`	number	否	Number of items per page (default: 20)
`pageNumber`	number	否	Page number for pagination

输出

参数	类型	描述
`schedules`	array	List of schedules
↳ `id`	string	Unique schedule ID
↳ `name`	string	Schedule name
↳ `description`	string	Schedule description
↳ `allTimeCoverage`	boolean	Whether schedule provides 24/7 coverage
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
`totalCount`	number	Total number of schedules returned

`rootly_list_escalation_policies`

List escalation policies from Rootly with optional search filtering.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`search`	string	否	Search term to filter escalation policies
`pageSize`	number	否	Number of items per page (default: 20)
`pageNumber`	number	否	Page number for pagination

输出

参数	类型	描述
`escalationPolicies`	array	List of escalation policies
↳ `id`	string	Unique escalation policy ID
↳ `name`	string	Escalation policy name
↳ `description`	string	Escalation policy description
↳ `repeatCount`	number	Number of times to repeat escalation
↳ `groupIds`	array	Associated group IDs
↳ `serviceIds`	array	Associated service IDs
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
`totalCount`	number	Total number of escalation policies returned

`rootly_list_causes`

List causes from Rootly with optional search filtering.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`search`	string	否	Search term to filter causes
`pageSize`	number	否	Number of items per page (default: 20)
`pageNumber`	number	否	Page number for pagination

输出

参数	类型	描述
`causes`	array	List of causes
↳ `id`	string	Unique cause ID
↳ `name`	string	Cause name
↳ `slug`	string	Cause slug
↳ `description`	string	Cause description
↳ `position`	number	Cause position
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
`totalCount`	number	Total number of causes returned

`rootly_list_playbooks`

List playbooks from Rootly with pagination support.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`pageSize`	number	否	Number of items per page (default: 20)
`pageNumber`	number	否	Page number for pagination

输出

参数	类型	描述
`playbooks`	array	List of playbooks
↳ `id`	string	Unique playbook ID
↳ `title`	string	Playbook title
↳ `summary`	string	Playbook summary
↳ `externalUrl`	string	External URL
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
`totalCount`	number	Total number of playbooks returned

`rootly_mitigate_incident`

Transition a Rootly incident to the mitigated state.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`incidentId`	string	是	The ID of the incident to mitigate
`mitigationMessage`	string	否	How was the incident mitigated?

输出

参数	类型	描述
`incident`	object	The mitigated incident
↳ `id`	string	Unique incident ID
↳ `sequentialId`	number	Sequential incident number
↳ `title`	string	Incident title
↳ `slug`	string	Incident slug
↳ `kind`	string	Incident kind
↳ `summary`	string	Incident summary
↳ `status`	string	Incident status
↳ `private`	boolean	Whether the incident is private
↳ `url`	string	URL to the incident
↳ `shortUrl`	string	Short URL to the incident
↳ `severityName`	string	Severity name
↳ `severityId`	string	Severity ID
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
↳ `startedAt`	string	Start date
↳ `mitigatedAt`	string	Mitigation date
↳ `resolvedAt`	string	Resolution date
↳ `closedAt`	string	Closed date

`rootly_resolve_incident`

Transition a Rootly incident to the resolved state.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`incidentId`	string	是	The ID of the incident to resolve
`resolutionMessage`	string	否	How was the incident resolved?

输出

参数	类型	描述
`incident`	object	The resolved incident
↳ `id`	string	Unique incident ID
↳ `sequentialId`	number	Sequential incident number
↳ `title`	string	Incident title
↳ `slug`	string	Incident slug
↳ `kind`	string	Incident kind
↳ `summary`	string	Incident summary
↳ `status`	string	Incident status
↳ `private`	boolean	Whether the incident is private
↳ `url`	string	URL to the incident
↳ `shortUrl`	string	Short URL to the incident
↳ `severityName`	string	Severity name
↳ `severityId`	string	Severity ID
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
↳ `startedAt`	string	Start date
↳ `mitigatedAt`	string	Mitigation date
↳ `resolvedAt`	string	Resolution date
↳ `closedAt`	string	Closed date

`rootly_assign_incident_role`

Assign an incident role (e.g. commander) to a user on a Rootly incident.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`incidentId`	string	是	The ID of the incident
`userId`	string	是	The ID of the user to assign (use List Users to find IDs)
`incidentRoleId`	string	是	The ID of the incident role (use List Incident Roles to find IDs)

输出

参数	类型	描述
`incident`	object	The incident after the role assignment
↳ `id`	string	Unique incident ID
↳ `sequentialId`	number	Sequential incident number
↳ `title`	string	Incident title
↳ `slug`	string	Incident slug
↳ `kind`	string	Incident kind
↳ `summary`	string	Incident summary
↳ `status`	string	Incident status
↳ `private`	boolean	Whether the incident is private
↳ `url`	string	URL to the incident
↳ `shortUrl`	string	Short URL to the incident
↳ `severityName`	string	Severity name
↳ `severityId`	string	Severity ID
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
↳ `startedAt`	string	Start date
↳ `mitigatedAt`	string	Mitigation date
↳ `resolvedAt`	string	Resolution date
↳ `closedAt`	string	Closed date

`rootly_unassign_incident_role`

Remove an incident role assignment from a user on a Rootly incident.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`incidentId`	string	是	The ID of the incident
`userId`	string	是	The ID of the user to unassign (use List Users to find IDs)
`incidentRoleId`	string	是	The ID of the incident role to remove (use List Incident Roles to find IDs)

输出

参数	类型	描述
`incident`	object	The incident after the role was unassigned
↳ `id`	string	Unique incident ID
↳ `sequentialId`	number	Sequential incident number
↳ `title`	string	Incident title
↳ `slug`	string	Incident slug
↳ `kind`	string	Incident kind
↳ `summary`	string	Incident summary
↳ `status`	string	Incident status
↳ `private`	boolean	Whether the incident is private
↳ `url`	string	URL to the incident
↳ `shortUrl`	string	Short URL to the incident
↳ `severityName`	string	Severity name
↳ `severityId`	string	Severity ID
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
↳ `startedAt`	string	Start date
↳ `mitigatedAt`	string	Mitigation date
↳ `resolvedAt`	string	Resolution date
↳ `closedAt`	string	Closed date

`rootly_add_subscribers`

Subscribe users to a Rootly incident so they receive updates.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`incidentId`	string	是	The ID of the incident
`userIds`	string	是	Comma-separated user IDs to subscribe (use List Users to find IDs)

输出

参数	类型	描述
`incident`	object	The incident after subscribers were added
↳ `id`	string	Unique incident ID
↳ `sequentialId`	number	Sequential incident number
↳ `title`	string	Incident title
↳ `slug`	string	Incident slug
↳ `kind`	string	Incident kind
↳ `summary`	string	Incident summary
↳ `status`	string	Incident status
↳ `private`	boolean	Whether the incident is private
↳ `url`	string	URL to the incident
↳ `shortUrl`	string	Short URL to the incident
↳ `severityName`	string	Severity name
↳ `severityId`	string	Severity ID
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
↳ `startedAt`	string	Start date
↳ `mitigatedAt`	string	Mitigation date
↳ `resolvedAt`	string	Resolution date
↳ `closedAt`	string	Closed date

`rootly_remove_subscribers`

Unsubscribe users from a Rootly incident.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`incidentId`	string	是	The ID of the incident
`userIds`	string	是	Comma-separated user IDs to unsubscribe (use List Users to find IDs)

输出

参数	类型	描述
`incident`	object	The incident after subscribers were removed
↳ `id`	string	Unique incident ID
↳ `sequentialId`	number	Sequential incident number
↳ `title`	string	Incident title
↳ `slug`	string	Incident slug
↳ `kind`	string	Incident kind
↳ `summary`	string	Incident summary
↳ `status`	string	Incident status
↳ `private`	boolean	Whether the incident is private
↳ `url`	string	URL to the incident
↳ `shortUrl`	string	Short URL to the incident
↳ `severityName`	string	Severity name
↳ `severityId`	string	Severity ID
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
↳ `startedAt`	string	Start date
↳ `mitigatedAt`	string	Mitigation date
↳ `resolvedAt`	string	Resolution date
↳ `closedAt`	string	Closed date

`rootly_create_status_page_event`

Post a public status page update for a Rootly incident.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`incidentId`	string	是	The ID of the incident
`event`	string	是	The status page update message to publish
`statusPageId`	string	否	The ID of the status page to post to
`status`	string	否	Status to set (investigating, identified, monitoring, resolved, scheduled, in_progress, completed)
`notifySubscribers`	boolean	否	Whether to notify status page subscribers
`shouldTweet`	boolean	否	Whether to post the update to the linked Twitter/X account

输出

参数	类型	描述
`statusPageEvent`	object	The created status page event
↳ `id`	string	Unique status page event ID
↳ `event`	string	The published update message
↳ `statusPageId`	string	Status page ID
↳ `status`	string	Status that was set
↳ `notifySubscribers`	boolean	Whether subscribers were notified
↳ `shouldTweet`	boolean	Whether the update was tweeted
↳ `startedAt`	string	When the event started
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date

`rootly_update_action_item`

Update a Rootly incident action item (status, priority, assignee, etc.).

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`actionItemId`	string	是	The ID of the action item to update
`summary`	string	否	Updated action item title
`description`	string	否	Updated description
`kind`	string	否	The kind of action item (task, follow_up)
`priority`	string	否	Priority level (high, medium, low)
`status`	string	否	Action item status (open, in_progress, cancelled, done)
`assignedToUserId`	string	否	The user ID to assign the action item to
`dueDate`	string	否	Due date for the action item

输出

参数	类型	描述
`actionItem`	object	The updated action item
↳ `id`	string	Unique action item ID
↳ `summary`	string	Action item title
↳ `description`	string	Action item description
↳ `kind`	string	Action item kind (task, follow_up)
↳ `priority`	string	Priority level
↳ `status`	string	Action item status
↳ `dueDate`	string	Due date
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date

`rootly_delete_action_item`

Delete a Rootly incident action item.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`actionItemId`	string	是	The ID of the action item to delete

输出

参数	类型	描述
`success`	boolean	Whether the action item was deleted
`message`	string	Result message

`rootly_snooze_alert`

Snooze a Rootly alert for a set number of minutes.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`alertId`	string	是	The ID of the alert to snooze
`delayMinutes`	number	是	Number of minutes to snooze the alert

输出

参数	类型	描述
`alert`	object	The snoozed alert
↳ `id`	string	Unique alert ID
↳ `shortId`	string	Short alert ID
↳ `summary`	string	Alert summary
↳ `description`	string	Alert description
↳ `source`	string	Alert source
↳ `status`	string	Alert status
↳ `externalId`	string	External ID
↳ `externalUrl`	string	External URL
↳ `deduplicationKey`	string	Deduplication key
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
↳ `startedAt`	string	Start date
↳ `endedAt`	string	End date

`rootly_escalate_alert`

Escalate a Rootly alert, optionally to a specific escalation policy or level.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`alertId`	string	是	The ID of the alert to escalate
`escalationPolicyId`	string	否	Escalation policy ID to escalate to (use List Escalation Policies to find IDs)
`escalationPolicyLevel`	number	否	Escalation policy level to escalate to

输出

参数	类型	描述
`alert`	object	The escalated alert
↳ `id`	string	Unique alert ID
↳ `shortId`	string	Short alert ID
↳ `summary`	string	Alert summary
↳ `description`	string	Alert description
↳ `source`	string	Alert source
↳ `status`	string	Alert status
↳ `externalId`	string	External ID
↳ `externalUrl`	string	External URL
↳ `deduplicationKey`	string	Deduplication key
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
↳ `startedAt`	string	Start date
↳ `endedAt`	string	End date

`rootly_list_incident_events`

List the timeline events for a Rootly incident.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`incidentId`	string	是	The ID of the incident
`pageSize`	number	否	Number of items per page (default: 20)
`pageNumber`	number	否	Page number for pagination

输出

参数	类型	描述
`events`	array	List of incident timeline events
↳ `id`	string	Unique event ID
↳ `event`	string	The event description
↳ `visibility`	string	Event visibility (internal or external)
↳ `occurredAt`	string	When the event occurred
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
`totalCount`	number	Total number of events returned

`rootly_run_workflow`

Trigger a Rootly automation workflow, optionally scoped to an incident or alert.

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`workflowId`	string	是	The ID of the workflow to run
`incidentId`	string	否	Incident ID to run the workflow against
`alertId`	string	否	Alert ID to run the workflow against
`immediate`	boolean	否	Run immediately (true) or respect the workflow wait time (false). Default true
`checkConditions`	boolean	否	Whether to evaluate the workflow conditions before running. Default false

输出

参数	类型	描述
`workflowRun`	object	The triggered workflow run
↳ `id`	string	Unique workflow run ID
↳ `workflowId`	string	ID of the workflow that ran
↳ `status`	string	Run status (queued, started, completed, completed_with_errors, failed, canceled)
↳ `statusMessage`	string	Status detail message
↳ `triggeredBy`	string	What triggered the run (system, user, workflow)
↳ `incidentId`	string	Associated incident ID
↳ `alertId`	string	Associated alert ID
↳ `startedAt`	string	When the run started
↳ `completedAt`	string	When the run completed
↳ `failedAt`	string	When the run failed
↳ `canceledAt`	string	When the run was canceled

`rootly_list_incident_roles`

List incident roles configured in Rootly (e.g. commander, scribe).

输入

参数	类型	必填	描述
`apiKey`	string	是	Rootly API key
`search`	string	否	Search term to filter incident roles
`pageSize`	number	否	Number of items per page (default: 20)
`pageNumber`	number	否	Page number for pagination

输出

参数	类型	描述
`incidentRoles`	array	List of incident roles
↳ `id`	string	Unique incident role ID
↳ `name`	string	Role name
↳ `slug`	string	Role slug
↳ `summary`	string	Role summary
↳ `description`	string	Role description
↳ `position`	number	Display position
↳ `optional`	boolean	Whether the role is optional
↳ `enabled`	boolean	Whether the role is enabled
↳ `createdAt`	string	Creation date
↳ `updatedAt`	string	Last update date
`totalCount`	number	Total number of incident roles returned

Rootly

On this page