Adding variables using REST API

Siya · 29 January 2020 10:08

Hello,

I am trying to add variables in the newly created project using Rest API. Before that I want to create a project using the API which I unable to create using the below playbook. The same is happening with curl command. Is there other way I add the variables ( project > variables > project/project templates) using API?

hosts: localhost
tasks:
- name: view all the octopus projects.
uri:
url: http://{ip-address}/api
API_key: {API KEY}
force_basic_auth: yes
method: POST
status_code: 200
body:
create-project: name=newProj projectgroup=nova environment=Nova2
register: p
- debug: var=p

Thank you!

paul.calvert · 29 January 2020 11:14

Hi Siya,

Thanks for getting in touch!

The easiest way to interact with the API is using our octopus.client as this allows scripts to be used without needing to generate the full REST call.

We have a repository full of script examples for both the octopus.client and REST here: https://github.com/OctopusDeploy/OctopusDeploy-Api

For example, this script allows you to add or modify a variable within a specific project

github.com

OctopusDeploy/OctopusDeploy-Api/blob/master/Octopus.Client/PowerShell/Variables/UpdateVariableInProject.ps1

cls
function UpdateVarInProject {
    Param (
        [Parameter(Mandatory=$true)][string] $UserApiKey,
        [Parameter(Mandatory=$true)][string] $OctopusUrl,
        [Parameter(Mandatory=$true)][string] $ProjectName,
        [Parameter(Mandatory=$true)][string] $VariableToModify,
        [Parameter(Mandatory=$true)][string] $VariableValue,
        [Parameter()][string] $EnvironmentScope,
        [Parameter()][string] $RoleScope,
        [Parameter()][string] $MachineScope,
        [Parameter()][string] $ActionScope
    )
    Process {
        Set-Location "C:\Program Files\Octopus Deploy\Tentacle"
        Add-Type -Path 'Newtonsoft.Json.dll'
        Add-Type -Path 'Octopus.Client.dll'
        $endpoint = New-Object Octopus.Client.OctopusServerEndpoint $OctopusUrl,$UserApiKey
        $repository = New-Object Octopus.Client.OctopusRepository $endpoint
        $project = $repository.Projects.FindByName($ProjectName)

This file has been truncated. show original

I hope this helps, please let me know if you have any further questions.

Best regards,
Paul