latestSwagger 2.02026-08-191,9198883.9 MB

b296c3a60aa5

Tasks

List all of the tasks in the supplied Octopus Deploy Space. The results will be sorted from newest to oldest.

get/{spaceId}/tasks

Path parameters

spaceIdstring required

Query parameters

activeboolean

Set to true for tasks that have not finished (New, Queued, Executing or Cancelling), or false for tasks that have

batchstring
descriptionstring

Text to match within a task's description, such as a project or release name. This is a partial match, not an exact one

environmentstring

The ID of an environment, to return only tasks against that environment. This is an ID such as 'Environments-1', not an environment name

fromCompletedDatestring date-time
fromQueueDatestring date-time
fromStartDatestring date-time
hasPendingInterruptionsboolean
hasPendingPreconditionsboolean
hasWarningsOrErrorsboolean
idsstring[]

Task IDs to return, such as 'ServerTasks-1'

namestring[]

Task type names to match exactly, such as 'Deploy' or 'RunbookRun'. Use ListServerTaskTypes to get the supported values

nodestring

The ID of the Octopus Server node a task ran on, to return only tasks from that node

partialNamestring

A partial task type name, to match tasks whose type name includes it

projectstring

The ID of a project, to return only tasks against that project. This is an ID such as 'Projects-1', not a project name

runbookstring

The ID of a runbook, to return only runs of that runbook

runningboolean

Set to true for tasks currently in progress (Executing or Cancelling), or false for tasks that are not

skipinteger

Number of items to skip. Defaults to zero

statesstring[]

Task states to match. One or more of New, Queued, Executing, Cancelling, Success, Failed, Canceled, TimedOut

takeinteger

Number of items to take. Defaults to 30

tenantstring

The ID of a tenant, to return only tasks against that tenant. This is an ID such as 'Tenants-1', not a tenant name

tenantTagstring

A tenant tag in canonical form, such as 'Regions/EMEA', to return only tasks against tenants carrying it

toCompletedDatestring date-time
toQueueDatestring date-time
toStartDatestring date-time

Response

Holds a TaskResourceCollection generated in response to a ListServerTasksRequest

Idstring

Gets or sets a unique identifier for this resource.

ItemsPerPageinteger
ItemTypestring
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.

LastPageNumberinteger
Linksobject

Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.

NumberOfPagesinteger
TotalResultsinteger