Runbooks

Get a Runbook by ID

get/spaces/{spaceIdentifier}/projects/{projectId}/runbooks/{id}

Request

Base URL
https://demo.octopus.app/api
Auth
- API key in header X-Octopus-ApiKey
- or API key in query parameter ApiKey
- or API key in header X-NuGet-ApiKey
TypeScript
https://skmtc.dev/octopus/apis/octopus-server-api/docs/spaces/:spaceIdentifier/projects/:projectId/runbooks/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

spaceIdentifierstring required

Identifier (ID or slug) of the space

projectIdstring required

idstring required

ID of the Runbook to retrieve

Response

Returns a runbook

AgentAccess'Allowed' | 'Blocked'

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 16 revisions of this API.