--- title: "Create Incident Label Rule" method: POST path: "/incident-label-rule" tags: ["Incident Label Rule"] --- # Create Incident Label Rule `POST /incident-label-rule` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/incident-label-rule` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to create a new Incident Label Rule ## Request body - object - `data` IncidentLabelRuleCreateSchema, required: Create schema for IncidentLabelRule model. Create - `criteria` object: Versioned conditions that determine whether this rule matches a resource. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `projectId` string, uuid: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [No access - you don't have permission for this operation] - `name` string, required: Name of this incident label rule. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `description` string: Description of this incident label rule. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `isEnabled` boolean: Whether this rule is enabled. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `monitors` object[]: Only trigger for incidents from these monitors. Leave empty to match incidents from any monitor. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `id` string - `incidentSeverities` object[]: Only trigger for incidents with these severities. Leave empty to match incidents of any severity. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `id` string - `incidentLabels` object[]: Only trigger for incidents that already have at least one of these labels. Leave empty to match regardless of incident labels. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `id` string - `monitorLabels` object[]: Only trigger for incidents from monitors that have at least one of these labels. Leave empty to match regardless of monitor labels. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `id` string - `incidentTitlePattern` string: Regex (case-insensitive) matched against the incident title. Leave empty to match any title. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `incidentDescriptionPattern` string: Regex (case-insensitive) matched against the incident description. Leave empty to match any description. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `monitorNamePattern` string: Regex (case-insensitive) matched against any of the incident's monitor names. Leave empty to match any monitor. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `monitorDescriptionPattern` string: Regex (case-insensitive) matched against any of the incident's monitor descriptions. Leave empty to match any description. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `labelsToAdd` object[]: Labels to attach to the incident when this rule matches. Already-attached labels are not duplicated. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `id` string - `inheritLabelsFromMonitors` boolean: When this rule matches, also copy every label of the incident's monitors onto the incident. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `inheritLabelsFromHosts` boolean: When this rule matches, also copy every label of the incident's affected hosts onto the incident. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `inheritLabelsFromKubernetesClusters` boolean: When this rule matches, also copy every label of the incident's affected Kubernetes clusters onto the incident. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `inheritLabelsFromDockerHosts` boolean: When this rule matches, also copy every label of the incident's affected Docker hosts onto the incident. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `inheritLabelsFromPodmanHosts` boolean: When this rule matches, also copy every label of the incident's affected Podman hosts onto the incident. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `inheritLabelsFromServices` boolean: When this rule matches, also copy every label of the incident's affected services onto the incident. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] ## Response `201` Created successfully - object - `data` IncidentLabelRuleReadSchema: Read schema for IncidentLabelRule model. Read - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `criteria` object: Versioned conditions that determine whether this rule matches a resource. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `projectId` string, uuid: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [No access - you don't have permission for this operation] - `name` string, required: Name of this incident label rule. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `description` string: Description of this incident label rule. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `isEnabled` boolean: Whether this rule is enabled. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `monitors` object[]: Only trigger for incidents from these monitors. Leave empty to match incidents from any monitor. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `id` string - `incidentSeverities` object[]: Only trigger for incidents with these severities. Leave empty to match incidents of any severity. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `id` string - `incidentLabels` object[]: Only trigger for incidents that already have at least one of these labels. Leave empty to match regardless of incident labels. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `id` string - `monitorLabels` object[]: Only trigger for incidents from monitors that have at least one of these labels. Leave empty to match regardless of monitor labels. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `id` string - `incidentTitlePattern` string: Regex (case-insensitive) matched against the incident title. Leave empty to match any title. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `incidentDescriptionPattern` string: Regex (case-insensitive) matched against the incident description. Leave empty to match any description. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `monitorNamePattern` string: Regex (case-insensitive) matched against any of the incident's monitor names. Leave empty to match any monitor. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `monitorDescriptionPattern` string: Regex (case-insensitive) matched against any of the incident's monitor descriptions. Leave empty to match any description. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `labelsToAdd` object[]: Labels to attach to the incident when this rule matches. Already-attached labels are not duplicated. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `id` string - `inheritLabelsFromMonitors` boolean: When this rule matches, also copy every label of the incident's monitors onto the incident. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `inheritLabelsFromHosts` boolean: When this rule matches, also copy every label of the incident's affected hosts onto the incident. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `inheritLabelsFromKubernetesClusters` boolean: When this rule matches, also copy every label of the incident's affected Kubernetes clusters onto the incident. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `inheritLabelsFromDockerHosts` boolean: When this rule matches, also copy every label of the incident's affected Docker hosts onto the incident. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `inheritLabelsFromPodmanHosts` boolean: When this rule matches, also copy every label of the incident's affected Podman hosts onto the incident. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `inheritLabelsFromServices` boolean: When this rule matches, also copy every label of the incident's affected services onto the incident. Permissions - Create: [Project Owner, Project Admin, Create Incident Label Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label Rule], Update: [Project Owner, Project Admin, Edit Incident Label Rule] - `createdByUserId` string, uuid: User ID who created this object (if this object was created by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Label 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. - `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)