Update scope for multiple Library Variables

djeantine · 13 August 2022 11:27

We have many library set variables that are scoped to environments i.e.(QA,DEV). We are trying to update all of them to add a new environments to their scope (QA,DEV,UAT). Since we have so many this manual process takes for ever. Is there an easy way to find variables that are scope to (QA,DEV) and update their scope to (QA,DEV,UAT) ?

Kenneth_Bates · 15 August 2022 00:25

Hi @djeantine,

Thanks for getting in touch! The easiest way to make bulk updates like this would be via an API script. I don’t see any existing sample scripts that do exactly this against a library variable set, however the following might give you a good starting point. This should give you the ability to find and modify any project variables that are scoped to your 2 environments and update all their scopes to include the third (UAT).

github.com

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

Function Get-OctopusProject {
    # Define parameters
    param(
        $OctopusServerUrl,
        $ApiKey,
        $ProjectName,
        $SpaceId
    )
    # Call API to get all projects, then filter on name
    $octopusProject = Invoke-RestMethod -Method "get" -Uri "$OctopusServerUrl/api/$spaceId/projects/all" -Headers @{"X-Octopus-ApiKey" = "$ApiKey" }

    # return the specific project
    return ($octopusProject | Where-Object { $_.Name -eq $ProjectName })
}

Function Get-OctopusProjectVariables {
    # Define parameters
    param(
        $OctopusDeployProject,
        $OctopusServerUrl,

This file has been truncated. show original

As with running any API scripts I’d recommend taking a database backup first, or test this against a test instance first so as not to include any potential unexpected changes to your live instance, especially when there are a large number you’re expecting to modify.

I hope this helps, and please let us know if you have any questions or concerns going forward.

Best regards,

Kenny

djeantine · 20 August 2022 14:15

Thank you much for your help. I will go ahead and use this code.

Cheers,