Full list of ServerTask statusses

[alex.yates]

I assume this is relevant to both Server and Cloud?

I want to use the API to find the current status of a Runbook Run. I’ve created the following PowerShell script and it works pretty well:

https://gist.github.com/Alex-Yates/656f6ec59051787e44e6c12a7109b8cd

I would like to know the full list of possible statusses and I cannot find it documented anywhere. I found this old forum post which was a great start:

API - Item state

Hi, I’m currently using the API to create a dashboard. I’ve noticed that when requesting /api/dashboard it returns an Items array (https://github.com/OctopusDeploy/OctopusDeploy-Api/wiki/DashboardItems) where each item has a state property. I noticed that this property changes during the deployment process and some other properties display as null. Just wondering do you have any documentation that describes each state and the properties that are available? Mike

However, it seems a bit ambiguouis. For example, “Canceling” is spelled differently in different replies from the same author, and it’s hard to repro to check the right spelling since it only ever occurs for a split second. The initial responses also missed “Queued”, so I’m curious if any other statusses have been missed.

I would really appreciate it if someone could provide some clarity or, even better, direct me to some docs. Thanks!

[paul.calvert]

Hi Alex,

Thanks for getting in touch!

Unfortunately, there hasn’t been any additional documentation for this created since the post you found.
I had a dig into the code and we have a TaskState enum list that I would hope includes all possible states.

TaskState {
    Queued = "Queued",
    Executing = "Executing",
    Failed = "Failed",
    Canceled = "Canceled",
    TimedOut = "TimedOut",
    Success = "Success",
    Cancelling = "Cancelling",
}

Regards,
Paul

[alex.yates]

That’s exactly what I needed. Thank you!