--- title: "Get Runbook Rule" method: POST path: "/runbook-rule/{id}/get-item" tags: ["Runbook Rule"] --- # Get Runbook Rule `POST /runbook-rule/{id}/get-item` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/runbook-rule/{id}/get-item` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to retrieve a single Runbook Rule by ID ## Path parameters - `id` string, uuid, required ## Request body - object - `select` RunbookRuleSelectSchema: Select schema for RunbookRule. Set fields to true to include them in the response. - `_id` boolean - `createdAt` boolean - `updatedAt` boolean - `deletedAt` boolean - `criteria` boolean - `projectId` boolean - `name` boolean - `description` boolean - `isEnabled` boolean - `triggerEntityType` boolean - `monitors` MonitorRelationSelectSchema: What a select may name of the Monitor records a relation holds: set a field to true to include it. - `_id` boolean - `createdAt` boolean - `updatedAt` boolean - `deletedAt` boolean - `projectId` boolean - `name` boolean - `monitorTemplateId` boolean - `autoProvisionedNetworkDeviceId` boolean - `networkAlertPolicyId` boolean - `monitorType` boolean - `currentMonitorStatusId` boolean - `monitorSteps` boolean - `incidentSeverities` IncidentSeverityRelationSelectSchema: What a select may name of the IncidentSeverity records a relation holds: set a field to true to include it. - `_id` boolean - `createdAt` boolean - `updatedAt` boolean - `deletedAt` boolean - `projectId` boolean - `name` boolean - `color` boolean - `order` boolean - `isArchived` boolean - `alertSeverities` AlertSeverityRelationSelectSchema: What a select may name of the AlertSeverity records a relation holds: set a field to true to include it. - `_id` boolean - `createdAt` boolean - `updatedAt` boolean - `deletedAt` boolean - `projectId` boolean - `name` boolean - `color` boolean - `order` boolean - `isArchived` boolean - `labels` LabelRelationSelectSchema: What a select may name of the Label records a relation holds: set a field to true to include it. - `_id` boolean - `createdAt` boolean - `updatedAt` boolean - `deletedAt` boolean - `name` boolean - `projectId` boolean - `color` boolean - `isArchived` boolean - `monitorLabels` LabelRelationSelectSchema: What a select may name of the Label records a relation holds: set a field to true to include it. - `_id` boolean - `createdAt` boolean - `updatedAt` boolean - `deletedAt` boolean - `name` boolean - `projectId` boolean - `color` boolean - `isArchived` boolean - `titlePattern` boolean - `descriptionPattern` boolean - `monitorNamePattern` boolean - `monitorDescriptionPattern` boolean - `runbooks` RunbookRelationSelectSchema: What a select may name of the Runbook records a relation holds: set a field to true to include it. - `_id` boolean - `createdAt` boolean - `updatedAt` boolean - `deletedAt` boolean - `projectId` boolean - `name` boolean - `createdByUserId` boolean ## Response `200` Successful response - object - `data` RunbookRule - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Create Runbook Rule, Runbook Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Rule], Update: [Project Owner, Project Admin, Edit Runbook Rule, Runbook Admin] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Create Runbook Rule, Runbook Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Rule], Update: [Project Owner, Project Admin, Edit Runbook Rule, Runbook Admin] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Create Runbook Rule, Runbook Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Rule], Update: [Project Owner, Project Admin, Edit Runbook Rule, Runbook Admin] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Create Runbook Rule, Runbook Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Rule], Update: [Project Owner, Project Admin, Edit Runbook Rule, Runbook Admin] - `version` number: Object version - `criteria` object: Versioned conditions that determine whether this rule matches a resource. Permissions - Create: [Project Owner, Project Admin, Create Runbook Rule, Runbook Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Rule], Update: [Project Owner, Project Admin, Edit Runbook Rule, Runbook Admin] - `projectId` string, uuid, required: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Create Runbook Rule, Runbook Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Rule], Update: [No access - you don't have permission for this operation] - `name` string, required: Name of this runbook rule. Permissions - Create: [Project Owner, Project Admin, Create Runbook Rule, Runbook Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Rule], Update: [Project Owner, Project Admin, Edit Runbook Rule, Runbook Admin] - `description` string: Description of this runbook rule. Permissions - Create: [Project Owner, Project Admin, Create Runbook Rule, Runbook Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Rule], Update: [Project Owner, Project Admin, Edit Runbook Rule, Runbook Admin] - `isEnabled` boolean, required: Whether this rule is enabled. Permissions - Create: [Project Owner, Project Admin, Create Runbook Rule, Runbook Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Rule], Update: [Project Owner, Project Admin, Edit Runbook Rule, Runbook Admin] - `triggerEntityType` 'Incident' | 'Alert' | 'ScheduledMaintenance', required: Entity type that triggers this rule on creation: Incident, Alert, or ScheduledMaintenance. Permissions - Create: [Project Owner, Project Admin, Create Runbook Rule, Runbook Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Rule], Update: [No access - you don't have permission for this operation] - `monitors` object[]: Only match incidents and scheduled maintenance events that affect, and alerts raised by, at least one of these monitors. Leave empty to match any monitor. Permissions - Create: [Project Owner, Project Admin, Create Runbook Rule, Runbook Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Rule], Update: [Project Owner, Project Admin, Edit Runbook Rule, Runbook Admin] - `_id` string, uuid: Unique identifier for the entity - `incidentSeverities` object[]: Only match incidents with one of these severities. Incident rules only. Leave empty to match any severity. Permissions - Create: [Project Owner, Project Admin, Create Runbook Rule, Runbook Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Rule], Update: [Project Owner, Project Admin, Edit Runbook Rule, Runbook Admin] - `_id` string, uuid: Unique identifier for the entity - `alertSeverities` object[]: Only match alerts with one of these severities. Alert rules only. Leave empty to match any severity. Permissions - Create: [Project Owner, Project Admin, Create Runbook Rule, Runbook Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Rule], Update: [Project Owner, Project Admin, Edit Runbook Rule, Runbook Admin] - `_id` string, uuid: Unique identifier for the entity - `labels` object[]: Only match incidents, alerts or scheduled maintenance events that carry at least one of these labels. Leave empty to match regardless of their labels. Permissions - Create: [Project Owner, Project Admin, Create Runbook Rule, Runbook Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Rule], Update: [Project Owner, Project Admin, Edit Runbook Rule, Runbook Admin] - `_id` string, uuid: Unique identifier for the entity - `monitorLabels` object[]: Only match when a monitor of the incident, alert or scheduled maintenance event carries at least one of these labels. Leave empty to match regardless of monitor labels. Permissions - Create: [Project Owner, Project Admin, Create Runbook Rule, Runbook Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Rule], Update: [Project Owner, Project Admin, Edit Runbook Rule, Runbook Admin] - `_id` string, uuid: Unique identifier for the entity - `titlePattern` string: Case-insensitive regex matched against the entity's title. Leave empty to match any title. Permissions - Create: [Project Owner, Project Admin, Create Runbook Rule, Runbook Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Rule], Update: [Project Owner, Project Admin, Edit Runbook Rule, Runbook Admin] - `descriptionPattern` string: Case-insensitive regex matched against the entity's description. Leave empty to match any description. Permissions - Create: [Project Owner, Project Admin, Create Runbook Rule, Runbook Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Rule], Update: [Project Owner, Project Admin, Edit Runbook Rule, Runbook Admin] - `monitorNamePattern` string: Case-insensitive regex matched against the names of the monitors of the incident, alert or scheduled maintenance event. Leave empty to match any monitor name. Permissions - Create: [Project Owner, Project Admin, Create Runbook Rule, Runbook Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Rule], Update: [Project Owner, Project Admin, Edit Runbook Rule, Runbook Admin] - `monitorDescriptionPattern` string: Case-insensitive regex matched against the descriptions of the monitors of the incident, alert or scheduled maintenance event. Leave empty to match any monitor description. Permissions - Create: [Project Owner, Project Admin, Create Runbook Rule, Runbook Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Rule], Update: [Project Owner, Project Admin, Edit Runbook Rule, Runbook Admin] - `runbooks` object[]: Runbooks to start when this rule matches. Each runbook produces its own execution. Permissions - Create: [Project Owner, Project Admin, Create Runbook Rule, Runbook Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Rule], Update: [Project Owner, Project Admin, Edit Runbook Rule, Runbook Admin] - `_id` string, uuid: Unique identifier for the entity - `createdByUserId` string, uuid: User ID who created this object. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Rule], Update: [No access - you don't have permission for this operation] ## Other responses - `400`: Bad request. This response indicates that the request was malformed or contained invalid data. - `401`: Unauthorized. This response indicates that the request requires user authentication. - `402`: Payment Required. This response indicates that the request requires payment or a valid subscription. - `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it. - `404`: Not found. The record does not exist, belongs to another project, or is one you may not read - the same answer for each. - `405`: Project not found. This response indicates that the requested project does not exist or is not accessible. - `408`: Request Timeout. This response indicates that the server timed out waiting for the request. - `415`: Unable to reach server. This response indicates that the server is currently unreachable or down. - `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource. - `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. --- [API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)