Passing prompted variables to deployments created with the REST API

cwilkins · 28 January 2015 11:34

One of our Projects has a prompted variable, I’m trying to create a release and deploy it using the REST API but I can’t see how to set that variable. Is there an example of how to do this somewhere?

cwilkins · 5 February 2015 16:31

Nothing on this? It’s possible with Octo.exe so I’m guessing it must be possible with the REST API.

Dalmiro · 6 February 2015 15:55

Hello,

Thanks for reaching out and sorry for the delay! Yes, as a rule of thumb it can always be done using the REST API. Using a WebDebugger while running Octo.exe will always show you how to use the REST API (its exactly what i did to write this reply).

There’s some serious digging that needs to be done and a few API calls:

Short version: When you make the Post to create the deployment, you’re gonna need to pass down the variables Names and Values on the FormValues dictionary

Long version: This powershell script does pretty much the same as Octo.exe, but using 100% direct REST API calls. It should give you an idea of how to get this working.

gist.github.com

https://gist.github.com/Dalmirog/b6264c8b7d61a2e1398a

gistfile1.ps1

$apiKey = "Your API Key"
$OctopusURL = "Your Octopus URL"

$Header =  @{ "X-Octopus-ApiKey" = $apiKey }

$ProjectName = "Your Project Name"
$EnvironmentName = "Your Environment Name"

#Getting Environment and Project By Name
$Project = Invoke-WebRequest -Uri "$OctopusURL/api/projects/$ProjectName" -Headers $Header| ConvertFrom-Json

This file has been truncated. show original

Hope that helps!

Dalmiro