---
title: "Get a list of Runbooks"
method: GET
path: "/{spaceId}/runbooks/all"
tags: ["Runbooks"]
---

# Get a list of Runbooks

`GET /{spaceId}/runbooks/all`

## Request

- Base URL: `https://demo.octopus.app/api`
- URL: `https://demo.octopus.app/api/{spaceId}/runbooks/all`
- Auth: one of:
  - API key in header `X-Octopus-ApiKey`
  - API key in query parameter `ApiKey`
  - API key in header `X-NuGet-ApiKey`

Lists all of the Runbooks in the supplied Space. The results will be sorted alphabetically by name.

## Path parameters

- `spaceId` string, required

## Query parameters

- `ids` string[]
- `projectIds` string[]

## Response `200`

Requested list of Runbooks

- 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: Gets or sets a unique identifier for this resource.
  - `LastModifiedBy` string: Gets or sets the username of the user who last modified this resource.
  - `LastModifiedOn` string, date-time: Gets or sets the date/time that this resource was last modified.
  - `Links` object: Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
  - `MultiTenancyMode` 'Untenanted' | 'TenantedOrUntenanted' | 'Tenanted'
  - `Name` string
  - `ProjectId` string
  - `PublishedRunbookSnapshotId` string
  - `RunbookProcessId` string
  - `RunbookTags` string[]: List of tags assigned to this runbook
  - `RunRetentionPolicy` RunbookRetentionPolicy
    - `QuantityToKeep` integer
    - `ShouldKeepForever` boolean
    - `Strategy` string
    - `Unit` 'Days' | 'Items'
  - `Slug` string
  - `SpaceId` string

## Other responses

- `304`: Not Modified
- `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.dev/octopus/apis/octopus-server-api.md) - [All operations](https://skmtc.dev/octopus/apis/octopus-server-api/llms.txt) - [OpenAPI document](https://skmtc.dev/octopus/apis/octopus-server-api/revisions/fe937c07da34?raw)