---
title: "Get Runbook Execution"
method: POST
path: "/runbook-execution/{id}/get-item"
tags: ["Runbook Execution"]
---

# Get Runbook Execution

`POST /runbook-execution/{id}/get-item`

## Request

- Base URL: `https://oneuptime.com/api`
- URL: `https://oneuptime.com/api/runbook-execution/{id}/get-item`
- Auth: API key in header `APIKey`
- TypeScript: <https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/docs/runbook-execution/:id/get-item/post.ts> (a function with typed inputs; its response is checked against the schema)

Endpoint to retrieve a single Runbook Execution by ID

## Path parameters

- `id` string, uuid, required

## Request body

- object
  - `select` RunbookExecutionSelectSchema: Select schema for RunbookExecution. Set fields to true to include them in the response.
    - `_id` boolean
    - `createdAt` boolean
    - `updatedAt` boolean
    - `deletedAt` boolean
    - `projectId` boolean
    - `runbookId` boolean
    - `runbookNameSnapshot` boolean
    - `status` boolean
    - `stepExecutions` boolean
    - `incidentId` boolean
    - `alertId` boolean
    - `scheduledMaintenanceId` boolean
    - `triggeredByUserId` boolean
    - `triggerType` boolean
    - `triggerDetails` boolean
    - `inputs` boolean
    - `startedAt` boolean
    - `completedAt` boolean
    - `failureReason` boolean

## Response `200`

Successful response

- object
  - `data` RunbookExecution
    - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Create Runbook Execution, Project Member, Runbook Admin, Runbook Member], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Execution], Update: [Project Owner, Project Admin, Edit Runbook Execution, Runbook Admin]
    - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Create Runbook Execution, Project Member, Runbook Admin, Runbook Member], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Execution], Update: [Project Owner, Project Admin, Edit Runbook Execution, Runbook Admin]
    - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Create Runbook Execution, Project Member, Runbook Admin, Runbook Member], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Execution], Update: [Project Owner, Project Admin, Edit Runbook Execution, Runbook Admin]
    - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Create Runbook Execution, Project Member, Runbook Admin, Runbook Member], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Execution], Update: [Project Owner, Project Admin, Edit Runbook Execution, Runbook Admin]
    - `version` number: Object version
    - `projectId` string, uuid, required: ID of your OneUptime Project in which this object belongs. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Execution], Update: [No access - you don't have permission for this operation]
    - `runbookId` string, uuid, required: ID of the Runbook this execution belongs to. Permissions - Create: [Project Owner, Project Admin, Create Runbook Execution, Project Member, Runbook Admin, Runbook Member], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Execution], Update: [No access - you don't have permission for this operation]
    - `runbookNameSnapshot` string, required: Name of the runbook at the time this execution was created (preserved even if the runbook is later renamed or deleted). Permissions - Create: [Project Owner, Project Admin, Create Runbook Execution, Project Member, Runbook Admin, Runbook Member], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Execution], Update: [No access - you don't have permission for this operation]
    - `status` 'Scheduled' | 'Running' | 'WaitingForManualStep' | 'Completed' | 'Failed' | 'Cancelled', required: Current status of this runbook execution. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Execution], Update: [No access - you don't have permission for this operation]
    - `stepExecutions` object: Per-step execution state. Each entry mirrors a step from the runbook with status, output, and timestamps. Permissions - Create: [Project Owner, Project Admin, Create Runbook Execution, Project Member, Runbook Admin, Runbook Member], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Execution], Update: [No access - you don't have permission for this operation]
    - `incidentId` string, uuid: ID of the incident that triggered or hosts this runbook execution. Permissions - Create: [Project Owner, Project Admin, Create Runbook Execution, Project Member, Runbook Admin, Runbook Member], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Execution], Update: [No access - you don't have permission for this operation]
    - `alertId` string, uuid: ID of the alert that triggered or hosts this runbook execution. Permissions - Create: [Project Owner, Project Admin, Create Runbook Execution, Project Member, Runbook Admin, Runbook Member], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Execution], Update: [No access - you don't have permission for this operation]
    - `scheduledMaintenanceId` string, uuid: ID of the scheduled maintenance event that triggered this runbook execution. Permissions - Create: [Project Owner, Project Admin, Create Runbook Execution, Project Member, Runbook Admin, Runbook Member], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Execution], Update: [No access - you don't have permission for this operation]
    - `triggeredByUserId` string, uuid: ID of the User who triggered this runbook execution. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Execution], Update: [No access - you don't have permission for this operation]
    - `triggerType` 'Manual' | 'Rule' | 'AutoRemediation' | 'AI' | 'Schedule' | 'Webhook' | 'SecurityPlaybook': What started this run: "Manual" (a person, or the API), "Rule" (a runbook rule), "AutoRemediation", "AI" (OneUptime AI), "Schedule" (the runbook's schedule) or "Webhook" (a call to the runbook's webhook URL). Empty for runs started before it was recorded. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Execution], Update: [No access - you don't have permission for this operation]
    - `triggerDetails` object: More about what started this run: for a scheduled run, the time it was due (scheduledFor) and whether it made up for times OneUptime missed (isCatchUp) or waited for the run before it (waitedForPreviousRun); for a webhook call, the address it came from (callerIp). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Execution], Update: [No access - you don't have permission for this operation]
    - `inputs` object: The values this run was started with: the JSON body of the webhook call that started it. Steps read them as data - Bash as ONEUPTIME_INPUT_<NAME> environment variables, JavaScript as args.inputs - never as script text. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Execution], Update: [No access - you don't have permission for this operation]
    - `startedAt` object: Time at which this runbook execution started. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Execution], Update: [Project Owner, Project Admin, Edit Runbook Execution, Runbook Admin]
    - `completedAt` object: Time at which this runbook execution completed. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Execution], Update: [Project Owner, Project Admin, Edit Runbook Execution, Runbook Admin]
    - `failureReason` string: Reason this runbook execution failed (if it did). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Runbook Admin, Runbook Member, Runbook Viewer, Read Runbook Execution], Update: [Project Owner, Project Admin, Edit Runbook Execution, Runbook Admin]

## Other responses

- `400`: Bad request. This response indicates that the request was malformed or contained invalid data.
- `401`: Unauthorized. This response indicates that the request requires user authentication.
- `402`: Payment Required. This response indicates that the request requires payment or a valid subscription.
- `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it.
- `404`: Not found. The record does not exist, belongs to another project, or is one you may not read - the same answer for each.
- `405`: Project not found. This response indicates that the requested project does not exist or is not accessible.
- `408`: Request Timeout. This response indicates that the server timed out waiting for the request.
- `415`: Unable to reach server. This response indicates that the server is currently unreachable or down.
- `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource.
- `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

---

[API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)