Generating a Variable Report via Octopus REST API / Octopus Client

jason02 · 4 February 2021 13:36

Hi,

I’m curious how to go about generating a report capturing the variable values for a specific project, environment and tenant. I’ve been exploring the rest api via swaggerui and looking into the Octopus Client powershell library as well. Does anyone have a code sample or know of which rest calls I can use to accomplish this?

paul.calvert · 4 February 2021 13:52

Hi Jason,

Thanks for getting in touch!

We have a sample script repository available here that is a good starting place when working with the REST API: GitHub - OctopusDeploy/OctopusDeploy-Api: Documentation for the Octopus Deploy HTTP API

I don’t think we have an exact script for this, but one that could be a good base is this one:

github.com

OctopusDeploy/OctopusDeploy-Api/blob/master/REST/PowerShell/Variables/PreviewVariablesForProjectEnvironment.ps1

$OctopusUrl = "" # example https://myoctopus.something.com
$APIKey = ""  # example API-XXXXXXXXXXXXXXXXXXXXXXXXXXX
$environmentName = "Development"
$spaceName = "Default"
$projectName = ""

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

## First we need to find the space
$spaceList = Invoke-RestMethod "$OctopusUrl/api/spaces?Name=$spaceName" -Headers $header
$spaceFilter = @($spaceList.Items | Where {$_.Name -eq $spaceName})
$spaceId = $spaceFilter[0].Id
Write-Host "The spaceId for Space Name $spaceName is $spaceId"

## Next, let's find the environment
$environmentList = Invoke-RestMethod "$OctopusUrl/api/$spaceId/environments?skip=0&take=1000&name=$environmentName" -Headers $header
$environmentFilter = @($environmentList.Items | Where {$_.Name -eq $environmentName})
$environmentId = $environmentFilter[0].Id
Write-Host "The environmentId for Environment Name $environmentName in space $spaceName is $environmentId"

This file has been truncated. show original

It doesn’t include filtering for Tenants though, so, would need some additional work to reach what you need.

Another good resource to use when scripting on the REST API is the developer tools within your browser. All of the actions that you can take within the Octopus UI are accomplished using the REST API, so, you can often check the requests being made as you perform an action to get a good idea for what your script will need.
So, checking out the request made when using the Preview option within Project > Variables could help.

Regards,
Paul

jason02 · 4 February 2021 21:54

Thanks, I’ll give that a try

system · 7 March 2021 21:54

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