Deploy an release to a specific machine using REST API

sujeshsasi · 21 June 2022 13:43

Hi Team,
I want to deploy an release to a specific machine/target. I am able to achieve this using octo.exe but since all our projects are using REST Apis . I also wanted to use REST API to deploy an release to an specific machine. Please let me know if we have an option to achieve this ? thanks in advance

paul.calvert · 21 June 2022 13:53

Hi @sujeshsasi,

Thanks for getting in touch!

All of the actions within the Octopus Web Portal make use of the REST API to execute. So, anything that can be done within the UI can be scripted for the REST API.

A good starting point when creating a new script like this is to use the network tab within your browser dev tools (F12) to capture the API call being made as you perform the desired action within the UI.
e.g.
If I perform a deployment with a specific machine selected I can see the payload being sent.

The main challenge here is that the payload for the deployments endpoint requires the MachineID rather than the machine name. So, you would need to perform additional API calls to the machine endpoint to retrieve the relevant ID.

We have a sample script in our API repo that can perform a deployment of an existing release to a specified machine that may be exactly what you’re looking for.

github.com

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

##CONFIG##

$apiKey = "" #Octopus API Key
$OctopusURL = "" #Octopus URL
 
$ProjectName = "" #project name
$EnvironmentName = "" #environment name

$MachineName = "" #Machine name in Octopus. Accepts only 1 Machine.

$ReleaseVersion = "" #Version of the release you want to deploy. Put 'Latest' if you want to deploy the latest version without having to know its number.


##PROCESS##

$Header =  @{ "X-Octopus-ApiKey" = $apiKey }
 
#Getting Project
Try{
    $Project = Invoke-WebRequest -Uri "$OctopusURL/api/projects/$ProjectName" -Headers $Header -ErrorAction Ignore| ConvertFrom-Json

This file has been truncated. show original

Regards,
Paul

system · 22 July 2022 13:53

This topic was automatically closed 31 days after the last reply. New replies are no longer allowed.