Update Octopus Current Deployed Version Manually

EnchantedBunny · 17 March 2023 12:40

Hi,

There are certain special circumstances where we create a release for a project but we don’t want to run a deployment via Octopus for that release (instead needing to deploy it a different way) however we would still like the dashboard to show the correct deployed version for a given project.

Is it possible to update/set the current deployed version of a project in an env using the REST API without causing it to deploy?
e.g. for project x, version 2.0.0 is deployed in environment ‘development’

Thanks for the help!

paul.calvert · 17 March 2023 12:47

Hi @EnchantedBunny,

Thanks for getting in touch!

A deployment does need to exist for Octopus to display that version on the dashboards.

It feels flaky, but the only way I can see to do this is to initiate a deployment, immediately cancel it, and then use the Edit State option to set it to successful.
e.g.

Regards,
Paul

EnchantedBunny · 17 March 2023 12:51

Hi @paul.calvert,

Thanks for the quick reply!

That makes sense.

So there is now real way we can do this via the REST API?
We would need this to be automated really so doing it manually via the UI may not be possible in this scenario.
After the other process has deployed the release, it would make said REST request back to Octopus to just let it know it has deployed the certain version itself.

paul.calvert · 17 March 2023 13:14

Everything that can be done in the UI uses the REST API, so it is definitely possible to script this.

You can use the browser dev tools to catch the API calls being made when performing the deploy, cancel and state change within the UI to see the specific endpoints and payloads being used which should make creating the script easier.

It would be along the lines of:

POST api/<spaceId>/deployments - need project ID and release ID. Capture TaskId from response
POST api/tasks/<taskId>/cancel - cancels the deployment
POST api/tasks/<taskId>/state - change the state to successful

We have some sample scripts for creating and cancelling deployments that may be useful too.

github.com

OctopusDeploy/OctopusDeploy-Api/blob/master/REST/PowerShell/Deployments/DeployRelease.ps1

$ErrorActionPreference = "Stop";

# Define working variables
$octopusURL = "https://youroctourl"
$octopusAPIKey = "API-YOURAPIKEY"
$headers = @{ "X-Octopus-ApiKey" = $octopusAPIKey }

$spaceName = "Default"
$projectName = "Your Project Name"
$releaseVersion = "0.0.1"
$environmentName = "Development"

# Get space id
$spaces = Invoke-RestMethod -Uri "$octopusURL/api/spaces/all" -Headers $headers -ErrorVariable octoError
$space = $spaces | Where-Object { $_.Name -eq $spaceName }
Write-Host "Using Space named $($space.Name) with id $($space.Id)"

# Get project by name
$projects = Invoke-RestMethod -Uri "$octopusURL/api/$($space.Id)/projects/all" -Headers $headers -ErrorVariable octoError
$project = $projects | Where-Object { $_.Name -eq $projectName }

This file has been truncated. show original

github.com

OctopusDeploy/OctopusDeploy-Api/blob/master/REST/PowerShell/Deployments/CancelDeployment.ps1

##CONFIG##

$OctopusURL = "" #Octopus URL
$OctopusAPIKey = "" #Octopus API Key

$ProjectName = "" #Name of the project that owns the deployment
$EnvironmentName = "" #Name of the environment where the deployment is taking place


##PROCESS##

$header = @{ "X-Octopus-ApiKey" = $OctopusAPIKey }

#Get dashboard to get latest deployments
$dashboard = (Invoke-WebRequest "$OctopusURL/api/dashboard" -Method Get -Headers $header).content | ConvertFrom-Json

#Get the Environment and Project to filter later
$Environment = $dashboard.Environments | ?{$_.name -eq $EnvironmentName}
$Project = $dashboard.Projects | ?{$_.name -eq $ProjectName}

This file has been truncated. show original

EnchantedBunny · 17 March 2023 13:45

Thanks @paul.calvert! This is very helpful!