Tasks

Change the state of a task

post/spaces/{spaceIdentifier}/tasks/{id}/state

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/spaces/{spaceIdentifier}/tasks/{id}/state
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Path parameters

spaceIdentifierstring required

Identifier (ID or slug) of the space

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).

State'Queued' | 'Executing' | 'Failed' | 'Canceled' | 'TimedOut' | 'Success' | 'Cancelling' required

The state to set the task to

Example request

{
  "Id": "ServerTasks-1",
  "SpaceId": "Spaces-1"
}

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.

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

Gets or sets the current state of the task.

Example response

{
  "Links": {
    "Self": "/api/..."
  },
  "ProjectId": "Projects-1",
  "SpaceId": "Spaces-1"
}

Changes

No recorded changes to this operation across all 13 revisions of this API.