Cannot add a new variable to a variable set using Rest API

TestQA · 6 January 2022 19:36

I’m trying to add a new variable to a variable set in Octopus using the Rest API.
The first time, I ran:
curl -X PUT my-octo/api/{spaceid}/variables/${varID} -H X-Octopus-ApiKey:**** -H Content-Type:application/json -d '{"Name":"something", "Value":"something", "Type":"String", "IsSensitive" : false}'

I go a json back. Did not seem to be an error. However, when I look in the UI or when I using the API to GET my-octo/api/{spaceid}/variables/${varID} I do not see any variable.

Now, if I try to run the PUT request, I get the following error:
“Changes to these variables could not be saved, because another user has made changes to the variables between when you started editing and when you saved your changes. Please reload or open a new tab to make your changes.”

Any help would be appreciated

brent_kinney · 6 January 2022 20:02

Hi @TestQA,

Thanks for reaching out on our support forums, and welcome to the community!

We have several scripts in our GitHub that might help you add new variable values.

You’ll want to review these options for the one that best fits your use case.

github.com

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

function Set-OctopusVariable {
    param(
        $octopusURL = "https://xxx.octopus.app/", # Octopus Server URL
        $octopusAPIKey = "API-xxx",               # API key goes here
        $projectName = "",                        # Replace with your project name
        $spaceName = "Default",                   # Replace with the name of the space you are working in
        $environment = $null,                     # Replace with the name of the environment you want to scope the variables to
        $varName = "",                            # Replace with the name of the variable
        $varValue = ""                            # Replace with the value of the variable
    )

    # 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}

This file has been truncated. show original

github.com

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

$ErrorActionPreference = "Stop";

# Define working variables
$octopusURL = "http://your.octopus.app/"
$octopusAPIKey = "YOUR-APIKEY"
$header = @{ "X-Octopus-ApiKey" = $octopusAPIKey }

# Specify the Space to search in
$spaceName = ""

# Library Variable Set
$libraryVariableSetName = ""

# Variable name to search for
$VariableName = ""

# New variable value to set
$VariableValue = ""

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

This file has been truncated. show original

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

Alternatively, you can use the Swagger page for your Octopus instance to help structure your API call

I hope one of those options works out for you. Let me know if you have any additional questions.

Regards,
Brent

TestQA · 11 January 2022 19:50

Hi Brent,

Thank you, I was able to make some progress. I was able to push a variable using the following json:

                "Version": 2
                "Variables":{"Name":"something", "Value":"something", "Type":"String", "IsSensitive" : false}

I was also able to add a variable using a Scope by using the following json:

                "Version": 2
                "Variables":{"Name":"something", "Value":"something", "Scope": { "Environment": [ "EnvId"]}, "Type":"String", "IsSensitive" : false}

Since I added the variable with a Scope, I cannot add anymore variables, I keep getting the error:
{ "ErrorMessage": "Object reference not set to an instance of an object." }

When I look at the audit on Octopus UI, it seems that it updated the variable “RelatedDocumentIds”: [] which I did not have in my script. It updated it with my environment ID.
Even if I run my PUT request with “RelatedDocumentIds”: [] it throws the Object error. Any help would be appreciated. Thank you

brent_kinney · 11 January 2022 22:20

Hi @TestQA,

I’m not sure what exactly would be causing that error, but you might have better luck trying this script:

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

It should allow you to create new and update existing variables with or without scoping and succeed without getting that error again. I know it looks complicated, but there is a section towards the bottom to enter the desired values.

I hope that helps.

Regards,

system · 11 February 2022 22:20

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