ONoneuptime
Runbook Execution

Update Runbook Execution

Endpoint to update an existing Runbook Execution

put/runbook-execution/{id}

Request

Path parameters

idstring uuid required

ID of the Runbook Execution to update

Request body

Example request

{
  "data": {}
}

Response

Updated successfully

Example response

{
  "data": {
    "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "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"
    },
    "project": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "runbook": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "runbookId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "runbookNameSnapshot": "Example Text",
    "status": "Example Text",
    "stepExecutions": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "incident": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "incidentId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "alert": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "alertId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "scheduledMaintenance": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "scheduledMaintenanceId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "triggeredByUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "triggeredByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "triggerType": "Example Text",
    "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 provides detailed information."
  }
}

Changes

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