Gå til indhold
Log ind
API-reference
Ressource

AI Rule

Which new incidents or alerts OneUptime AI investigates and fixes, and how. A rule investigates what it matches (right away, or only if still open after a wait), and fixes it or not, asking first or not. A fix may run the project's runbooks (only the rule's, when it names some), Bash commands on a Runner the rule picks, the tools of the project's external MCP servers (only the rule's, when it names some), and open fix and telemetry pull requests in the project's code repositories (only the rule's, when it names some). With no rule, OneUptime AI investigates every one, and fixes every one while automatic fixing is on. These were auto remediation rules, and investigation rules are AI rules now too.

AI Rule-modellen

Egenskaber

  • Navn
    _id
    Type
    Object ID
    Beskrivelse

    ID of this object

  • Navn
    createdAt
    Type
    Date
    Beskrivelse

    Date and Time when the object was created.

  • Navn
    updatedAt
    Type
    Date
    Beskrivelse

    Date and Time when the object was updated.

  • Navn
    criteria
    Type
    JSON
    Beskrivelse

    Versioned conditions that determine whether this rule matches a resource.

  • Navn
    project
    Type
    Project
    Beskrivelse

    Relation to Project Resource in which this object belongs

  • Navn
    projectId
    Type
    Object ID Påkrævet
    Beskrivelse

    ID of your OneUptime Project in which this object belongs

  • Navn
    name
    Type
    Text Påkrævet
    Beskrivelse

    Name of this AI rule.

  • Navn
    description
    Type
    Long Text
    Beskrivelse

    Description of this AI rule.

  • Navn
    isEnabled
    Type
    Boolean Påkrævet
    Beskrivelse

    Whether this rule is enabled.

  • Navn
    triggerEntityType
    Type
    Text Påkrævet
    Beskrivelse

    Which kind of new signal this rule decides about: Incident or Alert.

  • Navn
    investigates
    Type
    Boolean Påkrævet
    Beskrivelse

    Whether OneUptime AI investigates the incidents or alerts this rule matches. With enabled rules that investigate, only their matches are investigated. Off, the rule only fixes, and does not change which incidents are investigated. The dashboard turns it on for every rule; left out of an API write, it is off.

  • Navn
    onlyIfOpenAfterMinutes
    Type
    Number
    Beskrivelse

    Investigate only incidents or alerts still open this many minutes after they were created: OneUptime AI waits that long, then investigates if it is still open. Leave empty to investigate right away. When several rules match, the shortest wait decides. At most 1440 minutes (a day).

  • Navn
    fixes
    Type
    Boolean Påkrævet
    Beskrivelse

    Whether OneUptime AI fixes the incidents or alerts this rule matches, the way its Execution Mode says. Off, the rule only investigates them. With enabled rules, an incident is fixed only when a rule that fixes matches it. On by default.

  • Navn
    executionMode
    Type
    Text Påkrævet
    Beskrivelse

    How a rule that fixes asks. Suggest asks before fixing: every fix the rule starts waits for one-click human approval. FullAuto fixes without asking: OneUptime AI fixes on its own where the cluster's or resource's AI agent page allows, a runbook it picks from the ones the rule names starts right away (one it picks from all of the project's runbooks still waits for approval), a change through an MCP server the rule names is made right away (through any of the project's MCP servers, it still waits for approval), and a rule that runs its runbooks every time starts them immediately.

  • Navn
    remediationAction
    Type
    Text Påkrævet
    Beskrivelse

    OneUptimeAI (the default): OneUptime AI fixes the matched incident or alert - on the Kubernetes clusters and infrastructure it is linked to, the way each one's AI agent page allows, with the project's runbooks (only the rule's Runbooks when it names some) and with commands on the rule's Runner when it picks one. Runbooks: the rule starts every one of its Runbooks for every match, without OneUptime AI deciding. Whether a person approves first is the rule's Execution Mode.

  • Navn
    aiSelectsRunbook
    Type
    Boolean Påkrævet
    Beskrivelse

    Kept for rules saved before rules were simplified: an AI planning run reads the incident/alert context and picks the most applicable runbook (from the attached candidates, or all enabled runbooks when none are attached), always proposing it for approval, and the rule does nothing else. Every OneUptime AI rule now lets AI pick a runbook on its own, so new rules leave this off.

  • Navn
    aiComposesCommands
    Type
    Boolean Påkrævet
    Beskrivelse

    Kept for rules saved before rules were simplified: the AI investigates the incident/alert and composes Bash commands for the rule's Runner and Command Runners, and the rule does nothing else. Suggest mode proposes a command plan for one-click approval; FullAuto mode may execute commands inline, but only ones matching the command allowlist. A OneUptime AI rule now composes commands on its Runner when it picks one, so new rules leave this off.

  • Navn
    commandAllowlist
    Type
    JSON
    Beskrivelse

    Glob patterns for commands the AI may execute WITHOUT human approval under FullAuto (for example: systemctl restart *). Commands that do not match are proposed for one-click approval instead. Destructive commands are always refused by the built-in policy.

  • Navn
    commandRunners
    Type
    Runner
    Beskrivelse

    Kept for rules saved before rules were simplified: more Runners the AI may target with composed commands, besides the rule's Runner. A Runner runs a rule's commands only when the rule names it.

  • Navn
    monitors
    Type
    Monitor
    Beskrivelse

    Only trigger for incidents/alerts from these monitors. Leave empty to match any monitor.

  • Navn
    incidentSeverities
    Type
    Incident Severity
    Beskrivelse

    Only trigger for incidents with these severities (incident rules only). Leave empty to match any severity.

  • Navn
    alertSeverities
    Type
    Alert Severity
    Beskrivelse

    Only trigger for alerts with these severities (alert rules only). Leave empty to match any severity.

  • Navn
    labels
    Type
    Label
    Beskrivelse

    Only trigger for incidents/alerts that carry at least one of these labels. Leave empty to match any label.

  • Navn
    monitorLabels
    Type
    Label
    Beskrivelse

    Only trigger when the incident/alert's monitor carries at least one of these labels — the natural way to scope rules to environments (e.g. staging vs production). Leave empty to match any monitor label.

  • Navn
    titlePattern
    Type
    Long Text
    Beskrivelse

    Case-insensitive regex matched against the entity's title. Leave empty to match any title.

  • Navn
    descriptionPattern
    Type
    Long Text
    Beskrivelse

    Case-insensitive regex matched against the entity's description. Leave empty to match any description.

  • Navn
    runbooks
    Type
    Runbook
    Beskrivelse

    The runbooks OneUptime AI may pick and run for this rule. Leave empty to let it pick any of the project's runbooks. A rule whose Fix With is Runbooks starts every one of them for every match instead.

  • Navn
    externalMcpServers
    Type
    External MCP Server
    Beskrivelse

    The external MCP servers OneUptime AI may use while it investigates and fixes what this rule matches (an investigation uses only their tools that read). Leave empty to let it use all of the project's MCP servers; changes through them are then always proposed for approval first.

  • Navn
    runner
    Type
    Runner
    Beskrivelse

    The Runner OneUptime AI runs this rule's Bash commands on, inside your network. Empty means none: OneUptime AI runs no commands of its own for the rule. Commands on the affected Kubernetes cluster or host always go through its AI agent.

  • Navn
    runnerId
    Type
    Object ID
    Beskrivelse

    ID of the Runner OneUptime AI runs this rule's Bash commands on: one of the project's own Runners. Empty means none: OneUptime AI runs no commands of its own for the rule. Commands on the affected Kubernetes cluster or host always go through its AI agent.

  • Navn
    codeRepositories
    Type
    Code Repository
    Beskrivelse

    The code repositories OneUptime AI may read while it investigates and fixes what this rule matches, and open the rule's pull requests in. Leave empty to let it use every repository the project has connected.

  • Navn
    llmProvider
    Type
    LLM Provider
    Beskrivelse

    The LLM provider OneUptime AI uses for everything this rule starts: one of the project's providers or a global one. Empty: the project's default provider, else the global one.

  • Navn
    llmProviderId
    Type
    Object ID
    Beskrivelse

    ID of the LLM provider OneUptime AI uses for everything this rule starts. Empty: the project's default provider, else the global one.

  • Navn
    openCodeFixPullRequests
    Type
    Boolean Påkrævet
    Beskrivelse

    When an investigation of an incident or alert this rule matches finds the cause in your code, OneUptime AI opens a pull request with the fix, for review. Nothing is merged. Acts only while fixing new incidents (or alerts) automatically is on. On by default.

  • Navn
    openTelemetryPullRequests
    Type
    Boolean Påkrævet
    Beskrivelse

    When missing logs, traces or metrics stop an investigation of an incident or alert this rule matches, OneUptime AI opens a pull request that adds them, for review. Nothing is merged. Acts only while fixing new incidents (or alerts) automatically is on. On by default.

  • Navn
    verificationWindowMinutes
    Type
    Number
    Beskrivelse

    How long after the runbook starts the subject's monitors get to recover before verification fails. Defaults to 15 minutes.

  • Navn
    autoResolveOnVerifiedRecovery
    Type
    Boolean Påkrævet
    Beskrivelse

    When verification confirms the monitors recovered inside the window, automatically resolve the incident/alert. Off by default — the timeline note is posted either way.

  • Navn
    createdByUser
    Type
    User
    Beskrivelse

    Relation to User who created this object (if this object was created by a User)

  • Navn
    createdByUserId
    Type
    Object ID
    Beskrivelse

    User ID who created this object.

GET eller POST
/api/auto-remediation-rule/get-list

Liste

Dette endpoint giver dig mulighed for at hente en pagineret liste over alle dine AI Rule. Som standard vises maksimalt ti AI Rule pr. side.

Valgfrie forespørgselsparametre

  • Limit
    limit
    Type
    number
    Beskrivelse
    Antal objekter der skal hentes. Som standard 10, du kan øge dette antal op til 100
  • Skip
    skip
    Type
    number
    Beskrivelse
    Antal objekter der skal springes over. Dette kan være nyttigt ved paginering

Valgfri anmodningsbrødtekst

Listeanmodning

POST
/api/auto-remediation-rule/get-list?skip=0&limit=10
Headers
Content-Type: application/json
ApiKey: YOUR_API_KEY
Brødtekst
{
  "select": {
    "fixes": true,
    "investigates": true,
    "openCodeFixPullRequests": true,
    "openTelemetryPullRequests": true,
    "onlyIfOpenAfterMinutes": true
  },
  "query": {
    "executionMode": "Example execution mode"
  },
  "sort": {
    "createdAt": -1
  }
}

Svar

{
    "count": 10,
    "limit": 10,
    "skip": 0,
    "data": [
        {
            "_id": "b67b51cd-c925-407a-9a4e-ed3663d93764",
            "fixes": true,
            "investigates": true,
            "openCodeFixPullRequests": true,
            "openTelemetryPullRequests": true,
            "onlyIfOpenAfterMinutes": 10
        },
        {
            "_id": "04a34599-b89c-4294-b472-f1c4712bb343",
            "fixes": true,
            "investigates": true,
            "openCodeFixPullRequests": true,
            "openTelemetryPullRequests": true,
            "onlyIfOpenAfterMinutes": 10
        },
        {
            "_id": "d7cf8925-c9ee-4e92-bacd-90fd70aa3d33",
            "fixes": true,
            "investigates": true,
            "openCodeFixPullRequests": true,
            "openTelemetryPullRequests": true,
            "onlyIfOpenAfterMinutes": 10
        }
    ]
}
GET eller POST
/api/auto-remediation-rule/:id/get-item

Hent element efter ID

Dette endpoint giver dig mulighed for at hente AI Rule efter ID.

Påkrævede forespørgselsparametre

  • ID
    id
    Type
    text
    Beskrivelse
    Objektets ID

Valgfri anmodningsbrødtekst

  • Select
    select
    Type
    select
    Beskrivelse
    Som standard henter du kun ID'et på objekter. For at hente flere felter skal du vælge dem. For mere information, se venligst, hvordan du vælger her.

Get Item-anmodning

POST
/api/auto-remediation-rule/:id/get-item
Headers
Content-Type: application/json
ApiKey: YOUR_API_KEY
Brødtekst
{
  "select": {
    "fixes": true,
    "investigates": true,
    "openCodeFixPullRequests": true,
    "openTelemetryPullRequests": true,
    "onlyIfOpenAfterMinutes": true
  }
}

Svar

{
    "_id": "b67b51cd-c925-407a-9a4e-ed3663d93764",
    "fixes": true,
    "investigates": true,
    "openCodeFixPullRequests": true,
    "openTelemetryPullRequests": true,
    "onlyIfOpenAfterMinutes": 10
}
POST
/api/auto-remediation-rule/count

Antal

Dette endpoint giver dig mulighed for at hente antallet af alle dine AI Rule.

Valgfri anmodningsbrødtekst

Antalsanmodning

POST
/api/auto-remediation-rule/count
Headers
Content-Type: application/json
ApiKey: YOUR_API_KEY
Brødtekst
{
  "query": {
    "executionMode": "Example execution mode"
  }
}

Svar

{
    "count": 107
}
POST
/api/auto-remediation-rule

Opret AI Rule

Dette endpoint giver dig mulighed for at oprette et nyt objekt.

Anmodningsbrødtekst

  • Data
    data
    Type
    JSON
    Beskrivelse
    Objekt der skal oprettes som JSON

Opret-anmodning

POST
/api/auto-remediation-rule
Headers
Content-Type: application/json
ApiKey: YOUR_API_KEY
Brødtekst
{
  "data": {
    "fixes": true,
    "investigates": true,
    "openCodeFixPullRequests": true,
    "openTelemetryPullRequests": true,
    "onlyIfOpenAfterMinutes": 10
  }
}

Svar

{
    "_id": "b67b51cd-c925-407a-9a4e-ed3663d93764",
    "fixes": true,
    "investigates": true,
    "openCodeFixPullRequests": true,
    "openTelemetryPullRequests": true,
    "onlyIfOpenAfterMinutes": 10
}
PUT
/api/auto-remediation-rule/:id

Opdater efter ID

Dette endpoint giver dig mulighed for at opdatere objektet efter dets ID.

Anmodningsbrødtekst

  • Data
    data
    Type
    JSON
    Beskrivelse
    Objekt der skal opdateres som JSON

Alternative metoder

For klienter, der ikke understøtter PUT-anmodninger, kan du bruge POST eller GET med de samme anmodnings-headers og brødtekst:

POST /api/auto-remediation-rule/:id/update-item

Opdater-anmodning

PUT
/api/auto-remediation-rule/:id
Headers
Content-Type: application/json
ApiKey: YOUR_API_KEY
Brødtekst
{
  "data": {
    "fixes": true,
    "investigates": true,
    "openCodeFixPullRequests": true
  }
}

Svar

{}
DELETE
/api/auto-remediation-rule/:id

Slet efter ID

Dette endpoint giver dig mulighed for at slette objektet efter dets ID.

Alternative metoder

For klienter, der ikke understøtter DELETE-anmodninger, kan du bruge POST eller GET med de samme anmodnings-headers og brødtekst:

POST /api/auto-remediation-rule/:id/delete-item

Slet-anmodning

DELETE
/api/auto-remediation-rule/:id
Headers
Content-Type: application/json
ApiKey: YOUR_API_KEY

Svar

{}

Tilladelser

Dit API-token skal have tilladelser til at oprette, opdatere, læse eller slette denne ressource. Hvis du ikke har tilladelser til at foretage en anmodning, sendes der en 4xx-status som svar.

Læsetilladelser

Påkrævet for at læse AI Rule

  • ProjectOwner
    Project Owner
    Owner of this project. Does everything Project Admin does, and also manages billing and payment methods, sets up SCIM, and can delete the project.
  • ProjectAdmin
    Project Admin
    Admin of this project. Creates, changes and deletes everything in it, including team members and their permissions, API keys, labels, SSO, rules and custom fields, and reads the audit log. Cannot manage billing, set up SCIM or delete the project.
  • ProjectMember
    Project Member
    Member of this project. Creates, changes and deletes monitors, incidents, alerts, status pages, on-call policies, scheduled maintenance, services and infrastructure, and runs runbooks. Project settings take Project Admin: team members and permissions, API keys, labels, SSO, rules, custom fields, states, secrets, dashboards, SLOs, and changing workflows and runbooks. Does not see API keys, the audit log, invoices, secrets, session replays or security data.
  • Viewer
    Viewer
    Reads the project's resources and changes nothing. Does not see API keys, the audit log, invoices, secrets, session replays, security data, or AI conversations, insights and remediation suggestions.
  • ReadAutoRemediationRule
    Read AI Rule
    This permission can read AI Rules in this project.

Opret-tilladelser

Påkrævet for at oprette AI Rule

  • ProjectOwner
    Project Owner
    Owner of this project. Does everything Project Admin does, and also manages billing and payment methods, sets up SCIM, and can delete the project.
  • ProjectAdmin
    Project Admin
    Admin of this project. Creates, changes and deletes everything in it, including team members and their permissions, API keys, labels, SSO, rules and custom fields, and reads the audit log. Cannot manage billing, set up SCIM or delete the project.
  • CreateAutoRemediationRule
    Create AI Rule
    This permission can create AI Rules in this project: which incidents and alerts OneUptime AI investigates and fixes.

Opdater-tilladelser

Påkrævet for at opdatere AI Rule

  • ProjectOwner
    Project Owner
    Owner of this project. Does everything Project Admin does, and also manages billing and payment methods, sets up SCIM, and can delete the project.
  • ProjectAdmin
    Project Admin
    Admin of this project. Creates, changes and deletes everything in it, including team members and their permissions, API keys, labels, SSO, rules and custom fields, and reads the audit log. Cannot manage billing, set up SCIM or delete the project.
  • EditAutoRemediationRule
    Edit AI Rule
    This permission can edit AI Rules in this project.

Slet-tilladelser

Påkrævet for at slette AI Rule

  • ProjectOwner
    Project Owner
    Owner of this project. Does everything Project Admin does, and also manages billing and payment methods, sets up SCIM, and can delete the project.
  • ProjectAdmin
    Project Admin
    Admin of this project. Creates, changes and deletes everything in it, including team members and their permissions, API keys, labels, SSO, rules and custom fields, and reads the audit log. Cannot manage billing, set up SCIM or delete the project.
  • DeleteAutoRemediationRule
    Delete AI Rule
    This permission can delete AI Rules in this project.