ONoneuptime
Runbook Execution

Get Runbook Execution

Endpoint to retrieve a single Runbook Execution by ID

post/runbook-execution/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the Runbook Execution to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "runbookNameSnapshot": true,
    "status": true,
    "triggerType": 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,
    "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.