AI Rule

List AI Rule

Endpoint to list all AI Rule items

post/auto-remediation-rule/get-list

Request

Request body

limitnumber

Maximum number of items to return. Defaults to 10.

skipnumber

Number of items to skip for pagination. Defaults to 0.

Example request

{
  "query": {
    "createdAt": {
      "_type": "GreaterThan",
      "value": "2026-01-01T00:00:00.000Z"
    },
    "criteria": {
      "key": "value"
    }
  },
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true,
    "triggerEntityType": true,
    "executionMode": true,
    "remediationAction": true
  },
  "sort": {
    "createdAt": "DESC"
  }
}

Response

Successful response

countnumber

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.