ONoneuptime
Runbook

Get Runbook

Endpoint to retrieve a single Runbook by ID

post/runbook/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the Runbook to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true,
    "scheduleCron": true,
    "scheduleTimezone": true,
    "scheduleOverlapPolicy": true,
    "scheduleMissedRunPolicy": 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",
    "name": "Database failover runbook",
    "slug": "example-slug-value",
    "description": "Steps the on-call responder should follow when the primary database is unreachable.",
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "deletedByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "isEnabled": true,
    "steps": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "labels": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "isScheduleEnabled": true,
    "scheduleCron": "0 9 * * 1-5",
    "scheduleTimezone": "Europe/London",
    "scheduleOverlapPolicy": "Skip",
    "scheduleMissedRunPolicy": "RunOnce",
    "scheduleNextRunAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "scheduleQueuedRunAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "isWebhookEnabled": true
  }
}

Changes

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