Sign in

v1

latestSwagger 2.02026-08-061,9128853.7 MB
Runbooks

Get a Runbook by ID

get/projects/{projectId}/{gitRef}/runbooks/{id}

Path parameters

projectIdstring required
gitRefstring required
idstring required

ID of the Runbook to retrieve

Response

Returns a runbook

CancelQueuedTasksboolean
CancelRunningTasksboolean
DefaultGuidedFailureMode'EnvironmentDefault' | 'Off' | 'On'
Descriptionstring
Environmentsstring[]
EnvironmentScope'All' | 'Specified' | 'FromProjectLifecycles'
FailTargetDiscoveryboolean
ForcePackageDownloadboolean
Idstring
LastModifiedBystring
LastModifiedOnstring date-time
Linksobject
MultiTenancyMode'Untenanted' | 'TenantedOrUntenanted' | 'Tenanted'
Namestring
ProjectIdstring
PublishedRunbookSnapshotIdstring
RunbookProcessIdstring
RunbookTagsstring[]
Slugstring
SpaceIdstring