ONoneuptime
Runbook Execution

List Runbook Execution

Endpoint to list all Runbook Execution items

post/runbook-execution/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"
    },
    "runbookNameSnapshot": {
      "_type": "Search",
      "value": "example"
    }
  },
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "runbookNameSnapshot": true,
    "status": true,
    "triggerType": 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,
      "projectId": "123e4567-e89b-12d3-a456-426614174000",
      "runbookId": "123e4567-e89b-12d3-a456-426614174000",
      "runbookNameSnapshot": "Example short text",
      "status": "Scheduled",
      "stepExecutions": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "incidentId": "123e4567-e89b-12d3-a456-426614174000",
      "alertId": "123e4567-e89b-12d3-a456-426614174000",
      "scheduledMaintenanceId": "123e4567-e89b-12d3-a456-426614174000",
      "triggeredByUserId": "123e4567-e89b-12d3-a456-426614174000",
      "triggerType": "Webhook",
      "triggerDetails": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "inputs": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "startedAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "completedAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "failureReason": "This is an example of longer text content that might be stored in this field."
    }
  ]
}

Changes

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