AI Rule

Get AI Rule

Endpoint to retrieve a single AI Rule by ID

post/auto-remediation-rule/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the AI Rule to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true,
    "triggerEntityType": true,
    "executionMode": true,
    "remediationAction": true
  }
}

Response

Successful response

Example response

{
  "data": {
    "_id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "updatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "deletedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "version": 42,
    "criteria": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Example short text",
    "description": "This is an example of longer text content that might be stored in this field.",
    "isEnabled": true,
    "triggerEntityType": "Incident",
    "investigates": true,
    "onlyIfOpenAfterMinutes": 42,
    "fixes": true,
    "executionMode": "Suggest",
    "remediationAction": "OneUptimeAI",
    "aiSelectsRunbook": true,
    "aiComposesCommands": true,
    "commandAllowlist": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "commandRunners": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "monitors": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "incidentSeverities": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "alertSeverities": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "labels": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "monitorLabels": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "titlePattern": "This is an example of longer text content that might be stored in this field.",
    "descriptionPattern": "This is an example of longer text content that might be stored in this field.",
    "services": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "serviceLabels": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "serviceNamePattern": "This is an example of longer text content that might be stored in this field.",
    "runbooks": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "externalMcpServers": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "runnerId": "123e4567-e89b-12d3-a456-426614174000",
    "codeRepositories": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "llmProviderId": "123e4567-e89b-12d3-a456-426614174000",
    "aiContext": "# Heading\n\nThis is **markdown** content",
    "openCodeFixPullRequests": true,
    "openTelemetryPullRequests": true,
    "verificationWindowMinutes": 42,
    "autoResolveOnVerifiedRecovery": true,
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.