This script demonstrates how to programmatically cancel queued deployments.
Usage
Provide values for the following
- Octopus URL
- Octopus API Key
- Name of the space to work with
Script
PowerShell (REST API)
$ErrorActionPreference = "Stop";
# Define working variables
$octopusURL = "https://your-octopus-url"
$octopusAPIKey = "API-YOUR-KEY"
$header = @{ "X-Octopus-ApiKey" = $octopusAPIKey }
$spaceName = "default"
# Get space
$space = (Invoke-RestMethod -Method Get -Uri "$octopusURL/api/spaces/all" -Headers $header) | Where-Object {$_.Name -eq $spaceName}
$canContinue = $true
while ($canContinue -eq $true)
{
# Get tasks
$tasks = Invoke-RestMethod -Method Get -Uri "$octopusURL/api/$($space.Id)/tasks?States=Queued&Name=Deploy" -Headers $header
# Loop through tasks
foreach ($task in $tasks.Items)
{
# Cancel task
Invoke-RestMethod -Method Post -Uri "$octopusURL/api/$($space.Id)/tasks/$($task.Id)/cancel" -Headers $header
}
$canContinue = $tasks.NumberOfPages -gt 1
}
C#
// If using .net Core, be sure to add the NuGet package of System.Security.Permissions
#r "path\to\Octopus.Client.dll"
using Octopus.Client;
using Octopus.Client.Model;
// Declare working variables
var octopusURL = "https://your-octopus-url";
var octopusAPIKey = "API-YOUR-KEY";
string spaceName = "default";
// Create repository object
var endpoint = new OctopusServerEndpoint(octopusURL, octopusAPIKey);
var repository = new OctopusRepository(endpoint);
var client = new OctopusClient(endpoint);
try
{
// Get space
var space = repository.Spaces.FindByName(spaceName);
var repositoryForSpace = client.ForSpace(space);
var canContinue = true;
while (canContinue == true)
{
// Get queued deployments
var queuedDeployments = client.List<TaskResource>(repositoryForSpace.Link("Tasks"), new { states = "Queued", name = "Deploy", take = "50", skip = "0"});
// Loop through results
foreach (var task in queuedDeployments.Items)
{
// Cancel deployment
repositoryForSpace.Tasks.Cancel(task);
}
canContinue = queuedDeployments.Items.Count > 0;
}
}
catch (Exception ex)
{
Console.WriteLine(ex.Message);
return;
}
Python3
import json
import requests
octopus_server_uri = 'https://your-octopus-url'
octopus_api_key = 'API-YOUR-KEY'
headers = {'X-Octopus-ApiKey': octopus_api_key}
def get_octopus_resource(uri):
response = requests.get(uri, headers=headers)
response.raise_for_status()
return json.loads(response.content.decode('utf-8'))
def get_by_name(uri, name):
resources = get_octopus_resource(uri)
return next((x for x in resources if x['Name'] == name), None)
space_name = 'Default'
space = get_by_name('{0}/spaces/all'.format(octopus_server_uri), space_name)
results = 1
while results > 0
tasks = get_octopus_resource('{0}/{1}/tasks?States=Queued&Name=Deploy'.format(octopus_server_uri, space['Id']))
queued = [task for task in tasks['Items'] if not task['HasBeenPickedUpByProcessor']]
results = len(queued)
for task in queued:
uri = '{0}/{1}/tasks/{2}/cancel'.format(octopus_server_uri, space['Id'], task['Id'])
response = requests.post(uri, headers=headers)
response.raise_for_status()
Go
package main
import (
"encoding/json"
"fmt"
"log"
"net/http"
"net/url"
"io/ioutil"
"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
)
func main() {
apiURL, err := url.Parse("https://your-octopus-url")
if err != nil {
log.Println(err)
}
APIKey := "API-YOUR-KEY"
spaceName := "Default"
// Get reference to space
space := GetSpace(apiURL, APIKey, spaceName)
canContinue := true
for canContinue {
tasks := GetQueuedTasks(apiURL, APIKey, space)
//fmt.Println(tasks)
for i := 0; i < len(tasks); i++ {
task := tasks[i].(map[string]interface{})
CancelTask(apiURL, APIKey, space, task["Id"].(string))
}
if len(tasks) == 0 {
canContinue = false
}
}
}
func octopusAuth(octopusURL *url.URL, APIKey, space string) *octopusdeploy.Client {
client, err := octopusdeploy.NewClient(nil, octopusURL, APIKey, space)
if err != nil {
log.Println(err)
}
return client
}
func GetSpace(octopusURL *url.URL, APIKey string, spaceName string) *octopusdeploy.Space {
client := octopusAuth(octopusURL, APIKey, "")
spaceQuery := octopusdeploy.SpacesQuery{
Name: spaceName,
}
// Get specific space object
spaces, err := client.Spaces.Get(spaceQuery)
if err != nil {
log.Println(err)
}
for _, space := range spaces.Items {
if space.Name == spaceName {
return space
}
}
return nil
}
func GetQueuedTasks(octopusURL *url.URL, APIKey string, space *octopusdeploy.Space) []interface{} {
// Query api for tasks
tasksApi := octopusURL.String() + "/api/" + space.ID + "/tasks?States=Queued&Name=Deploy"
// Create http client
httpClient := &http.Client{}
// perform request
request, _ := http.NewRequest("GET", tasksApi, nil)
request.Header.Set("X-Octopus-ApiKey", APIKey)
response, err := httpClient.Do(request)
if err != nil {
log.Println(err)
}
responseData, err := ioutil.ReadAll(response.Body)
var f interface{}
jsonErr := json.Unmarshal(responseData, &f)
if jsonErr != nil {
log.Println(err)
}
tasks := f.(map[string]interface{})
// return the tasks
return tasks["Items"].([]interface{})
}
func CancelTask(octopusURL *url.URL, APIKey string, space *octopusdeploy.Space, TaskId string) {
// create http client
httpClient := &http.Client{}
// perform post
tasksApi := octopusURL.String() + "/api/" + space.ID + "/tasks/" + TaskId + "/cancel"
request, _ := http.NewRequest("POST", tasksApi, nil)
request.Header.Set("X-Octopus-ApiKey", APIKey)
response, err := httpClient.Do(request)
fmt.Println(tasksApi)
if err != nil {
log.Println(err)
}
if response.StatusCode == 200 {
fmt.Println("Task " + TaskId + " has been cancelled.")
}
}
Help us continuously improve
Please let us know if you have any feedback about this page.
Page updated on Sunday, January 1, 2023