latestSwagger 2.02026-08-191,9198883.9 MB

b296c3a60aa5

AccessTokens1

Accounts41

ActionTemplates57

ApiKeys5

ApprovalPolicies10

Approvals8

Artifacts21

AuditStream2

Authentication2

AzureDevOps1

Branches21

BuildInformation15

Capabilities2

Certificates49

Channels52

CloudTemplate1

CommunityActionTemplates9

CompliancePolicies8

Configuration5

ConnectionAgents9

Dashboard6

DashboardConfiguration6

DeploymentFreeze8

DeploymentProcesses40

Deployments19

DeploymentSettings18

DeploymentTargets45

DeploymentTargetTags12

Deprecations2

DirectoryServices2

DynamicExtensions3

Environments47

EphemeralEnvironments16

EventRetention5

Events18

ExternalSecurityGroupProviders1

FeaturesConfiguration2

FeatureToggles14

Feeds27

GitHub34

Home2

Icons7

Insights43

IntegratedAuthentication1

Interruptions15

Invitations6

JiraIntegration2

JsonWebKeys1

LDAP2

LetsEncrypt2

LibraryVariableSets27

Licenses5

Lifecycles27

MachinePolicies30

MachineRoles6

Machines3

MaintenanceConfiguration3

Migrations2

Nuget2

Observability32

OctopusServerNodes8

OpenIdConnect1

OpenIDConnect15

OpenTelemetry2

Packages42

ParentEnvironments8

Performance2

Permissions1

PlatformHub46

ProcessTemplates14

Progression18

ProjectGroups21

Projects62

ProjectTemplates1

ProjectTriggers30

Proxies18

RateLimiting3

Releases68

Reporting3

Retention8

RolloutGroups10

RunbookProcesses30

RunbookRuns33

Runbooks115

RunbookSnapshots77

ScheduledJobs6

ScopedUserRoles15

Server3

ServerStatus9

ServerTaskApprovals6

ServiceAccountOidcIdentities5

Signing5

SlackIntegration8

Smtp5

Spaces49

SshKnownHosts3

Subscriptions18

TagSets21

Tasks36

TeamMemberships9

Teams21

Telemetry4

Tenants66

TokenExchange1

Upgrade2

UserPermissions9

UserRoles6

Users15

Variables27

VersionControl2

Web2

WorkerPools33

Workers33

WorkerTaskLeases2

Tasks

Change the state of a task

post/{spaceId}/tasks/{id}/state

Path parameters

spaceIdstring required

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

idstring required

The ID of the task

Request body

Idstring required

The ID of the task

Reasonstring required

The reason for the state change

SpaceIdstring

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

The state to set the task to

Response

Returns the Task resource after the state has been changed in response to a ModifyServerTaskStateCommand

Argumentsobject

Gets or sets any arguments to the task.

CanRerunboolean

If true, then the task can be used as the basis for a new task with the same effect.

Completedstring

Gets or sets a value indicating the completion status of the task. May be "Timed out", "Queued...", "Executing...", or the time at which the task completed for completed tasks.

CompletedTimestring date-time

Gets or sets the date/time that the task completed. Will be null if the task has not yet completed.

Descriptionstring

Gets or sets a short, human-understandable description of this task. An example might be "Manual database backup". This is the name that will be shown in the task list.

Durationstring

Gets or sets a string indicating how long the task took to run.

ErrorMessagestring

Gets or sets a short summary of the errors encountered when the task ran (if any).

EstimatedRemainingQueueDurationSecondsinteger

FinishedSuccessfullyboolean

Gets or sets a value indicating whether the task ran to completion successfully.

HasBeenPickedUpByProcessorboolean

Gets or sets a boolean value indicating whether the Octopus Server is processing this task.

HasPendingInterruptionsboolean

True if the task has any pending interruptions.

HasPendingPreconditionsboolean

True if the task has any pending preconditions.

HasWarningsOrErrorsboolean

True if any warnings or non-fatal errors were recorded in the task log during execution.

Idstring

Gets or sets a unique identifier for this resource.

IsCompletedboolean

Gets or sets a value indicating whether the task has completed (that is, not queued, not running, and not paused; may have finished successfully or failed).

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.

LastUpdatedTimestring date-time

Gets or sets the time that the Octopus server last updated the status of this task. For a running task this should happen at least every couple of minutes.

Linksobject

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

Namestring

Gets or sets the name of the task to create. This name must be one of the list of possible names documented in the create API operation documentation.

PendingInterruptionTypesstring[]

Contains a list of the types of any pending interruptions

PendingPreconditionTypesstring[]

Contains a list of the types of any pending preconditions

ProjectIdstring

If the task belongs to a project (e.g. a deployment), the ID of the project it belongs to

QueueTimestring date-time

Gets or sets the time at which the task was queued.

QueueTimeExpirystring date-time

Gets or sets the time at which the task will timeout if it has not started executing.

ServerNodestring

Gets the ID of the Octopus server that created and will control this task.

SpaceIdstring

StartTimestring date-time

Gets or sets the time at which the task started executing.

Gets or sets the current state of the task.