---
title: "Get a Runbook by ID"
method: GET
path: "/runbooks/{id}"
tags: ["Runbooks"]
---

# Get a Runbook by ID

`GET /runbooks/{id}`

## Path parameters

- `id` string, required

## Query parameters

- `projectId` string

## Response `200`

Returns a runbook

- RunbookResource
  - `CancelQueuedTasks` boolean
  - `CancelRunningTasks` boolean
  - `ConnectivityPolicy` DeploymentConnectivityPolicy
    - `AllowDeploymentsToNoTargets` boolean
    - `ExcludeUnhealthyTargets` boolean
    - `SkipMachineBehavior` 'None' | 'SkipUnavailableMachines'
    - `TargetRoles` string[]
  - `DefaultGuidedFailureMode` 'EnvironmentDefault' | 'Off' | 'On'
  - `Description` string
  - `Environments` string[]
  - `EnvironmentScope` 'All' | 'Specified' | 'FromProjectLifecycles'
  - `FailTargetDiscovery` boolean
  - `ForcePackageDownload` boolean
  - `Id` string
  - `LastModifiedBy` string
  - `LastModifiedOn` string, date-time
  - `Links` object
  - `MultiTenancyMode` 'Untenanted' | 'TenantedOrUntenanted' | 'Tenanted'
  - `Name` string
  - `ProjectId` string
  - `PublishedRunbookSnapshotId` string
  - `RunbookProcessId` string
  - `RunbookTags` string[]
  - `RunRetentionPolicy` RunbookRetentionPolicy
    - `QuantityToKeep` integer
    - `ShouldKeepForever` boolean
    - `Strategy` string
    - `Unit` 'Days' | 'Items'
  - `Slug` string
  - `SpaceId` string

## Other responses

- `400` — Bad request. Either the payload was not structurally valid or business rules did not permit the operation.
- `404` — Not found. One or more of the entities involved in the operation was not found.

---

[API](https://skmtc.net/octopus/apis/octopus-server-api.md) · [All operations](https://skmtc.net/octopus/apis/octopus-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/octopus/octopus-server-api/versions/bc9158facfc7/schema)