Sign in

v1

latestSwagger 2.02026-08-061,9128853.7 MB
RunbookRuns

Gets a list of Runbook Runs

Lists all of the runbookRuns in the supplied Octopus Deploy Space, from projects, snapshots and environments accessible by the current user. The results will be sorted from most recent to least recent runbookRun.

get/projects/{projectId}/runbookRuns

Path parameters

projectIdstring required

Query parameters

environmentsstring[]

Environment Ids to filter results to only Runbook Runs with the given Environment Ids

idsstring[]

Runbook Run Ids to filter results to only Runbook Runs with the given Ids

partialNamestring

A partial name, to limit the set of Runbook Runs to those with a name that includes the partial name

projectsstring[]

Project Ids to filter results to only Runbook Runs with the given Project Ids

runbooksstring[]

Runbook Ids to filter results to only Runbooks with the given Ids

skipinteger

Number of items to skip. Defaults to zero

takeinteger

Number of items to take. Defaults to 30

taskState'Queued' | 'Executing' | 'Failed' | 'Canceled' | 'TimedOut' | 'Success' | 'Cancelling'

Task State to filter results to only Deployments with the given Task State

tenantsstring[]

Tenant Ids to filter results to only Runbook Runs with the given Tenant Ids

Response

The requested list of Runbook Runs

Idstring
ItemsPerPageinteger
ItemTypestring
LastModifiedBystring
LastModifiedOnstring date-time
LastPageNumberinteger
Linksobject
NumberOfPagesinteger
TotalResultsinteger