Setting variable scope with the REST API

chris.obrien · 11 December 2020 14:33

Hi all

I’ve been using the code snippet found in the Octopus Documentation here to create and update variables programmatically with the REST API. This is working perfectly.

However I can’t seem to work out how to set the variable scope via the same API. Specifically, I’m trying to set the Environment field to bind the value to the “Development” environment.

I’ve uploaded a copy of my script (without sensitive information), with my attempt at adding the scope property to the payload. I’ve also added a screenshot of the code in case it’s easier to read that way.

Would someone be able to tell me where I’ve gone wrong here please? I can’t find any page in the documentation or anywhere on Stackoverflow etc. that illustrates this.

Set-Variables.ps1 (2.0 KB)

Thanks very much.

donny.bell · 11 December 2020 16:34

Hi Chris,

Thank you for contacting Octopus Support.

I’m going to see if I can get this worked out in a test environment. I’ll touch base again shortly.

Thanks for your patience.

Regards,
Donny

donny.bell · 11 December 2020 21:21

Hi Chris,

Thank you for your patience.

Here is a modified version of the script you are using that includes the ability to scope to an environment:

github.com

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

$ErrorActionPreference = "Stop";

# Define working variables
$octopusURL = "https://OctopusServerURL" # Octopus Server URL
$octopusAPIKey = "API-XXXXXXXXXXXXXXXXXXXXXXXXXX" # API key goes here
$projectName = "ProjectName" # Replace with your project name
$spaceName = "Default" # Replace with the name of the space you are working in
$environment = "DevEnv" # Replace with the name of the environment you want to scope the variables to

# Defines header for API call
$header = @{ "X-Octopus-ApiKey" = $octopusAPIKey }

# Get space
$space = (Invoke-RestMethod -Method Get -Uri "$octopusURL/api/spaces/all" -Headers $header) | Where-Object {$_.Name -eq $spaceName}

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

# Get project variables
$projectVariables = Invoke-RestMethod -Method Get -Uri "$octopusURL/api/$($space.Id)/variables/$($project.VariableSetId)" -Headers $header

This file has been truncated. show original

Let me know if that does the trick.

Regards,
Donny

chris.obrien · 14 December 2020 12:35

Hi Donny

That’s really useful thanks very much. It worked a treat.

Regards

Chris

donny.bell · 14 December 2020 15:09

Hi Chris,

Thank you for getting back to me. I’m glad this worked for you.

Don’t hesitate to reach out if you need anything else.

Regards,
Donny

system · 14 January 2021 15:09

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