Runbooks

Get a list of Runbooks

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

get/{spaceId}/runbooks/all

Request

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

Path parameters

spaceIdstring required

The ID of the space containing the resource(s).

Query parameters

idsstring[]

A list of Runbook resource ids used to filter a query.

projectIdsstring[]

A list of Project ids used to filter a query.

Response

Requested list of Runbooks

CancelQueuedTasksboolean
CancelRunningTasksboolean
DefaultGuidedFailureMode'EnvironmentDefault' | 'Off' | 'On'
Descriptionstring
Environmentsstring[]
EnvironmentScope'All' | 'Specified' | 'FromProjectLifecycles'
FailTargetDiscoveryboolean
ForcePackageDownloadboolean
Idstring

Gets or sets a unique identifier for this resource.

LastModifiedBystring

Gets or sets the username of the user who last modified this resource.

LastModifiedOnstring date-time

Gets or sets the date/time that this resource was last modified.

Linksobject

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'
Namestring
ProjectIdstring
PublishedRunbookSnapshotIdstring
RunbookProcessIdstring
RunbookTagsstring[]

List of tags assigned to this runbook

Slugstring
SpaceIdstring

Example response

[
  {
    "Environments": [
      "Environments-1",
      "..."
    ],
    "Links": {
      "Self": "/api/..."
    },
    "ProjectId": "Projects-1",
    "SpaceId": "Spaces-1"
  }
]

Changes

No recorded changes to this operation across all 13 revisions of this API.