Is there a way to query the deployment history on a deployment target

dong_xue · 15 August 2022 21:56

hi there,

I wonder if there is a way to query the deployment history on a deployment target programmatically just like on UI.

What I would like to achieve in my bootstrapping script is to know if the current deployment target is a new one or not by looking at the number of previous deployments on it.

Thank you for your input.

Dong

Kenneth_Bates · 16 August 2022 00:06

Hi Dong,

Thanks for getting in touch! Great question, and I’m sure we can come to a good option though which one might depend on a bit more details about what exactly you’re after. I’ll throw a couple resources down below where one might be helpful, otherwise I’d be more than happy to consider this further after learning a bit more about your goals/requirements.

We have an available API script in our sample script repo to retrieve recent deployments to a machine which might help with part of the answer.

github.com

OctopusDeploy/OctopusDeploy-Api/blob/master/REST/PowerShell/Targets/Get-RecentDeploymentsForMachines.ps1

# Define Octopus variables
$octopusURL = "https://youroctopusserver"
$octopusAPIKey = "API-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}

# Get machine details
$machines = @()
$response = $null
do {
    $uri = if ($response) { $octopusURL + $response.Links.'Page.Next' } else { "$octopusURL/api/$($space.Id)/machines" }
    $response = Invoke-RestMethod -Method Get -Uri $uri -Headers $header
    $machines += $response.Items
} while ($response.Links.'Page.Next')

foreach ($machine in $machines) {
    $machineTasks = (Invoke-RestMethod -Method Get -Uri "$octopusURL/api/$($space.Id)/machines/$($machine.Id)/tasks" -Headers $header).Items

This file has been truncated. show original

Possibly another option would be to add a run condition to your step based off a deployment system variable, perhaps Octopus.Tentacle.PreviousInstallation.PackageVersion checking if it exists or not on the target the step is being run on.

I hope that helps in some way, and let me know what you think!

Best regards,

Kenny

dong_xue · 17 August 2022 05:16

Thank you Kenny. I will try it out and let you know.

Cheers,
Dong