---
title: "Get a Variable Set by Id"
method: GET
path: "/variables/{id}"
tags: ["Variables"]
---

# Get a Variable Set by Id

`GET /variables/{id}`

## Path parameters

- `id` string, required

## Response `200`

The requested Variable Set

- VariableSetResource
  - `Id` string
  - `LastModifiedBy` string
  - `LastModifiedOn` string, date-time
  - `Links` object
  - `OwnerId` string
  - `ScopeValues` VariableScopeValues
    - `Actions` ReferenceDataItem[]
      - `Id` string
      - `Name` string
    - `Channels` ReferenceDataItem[]
      - `Id` string
      - `Name` string
    - `EnvironmentParameters` ReferenceDataItem[]
      - `Id` string
      - `Name` string
    - `Environments` ReferenceDataItem[]
      - `Id` string
      - `Name` string
    - `Machines` ReferenceDataItem[]
      - `Id` string
      - `Name` string
    - `Processes` ProcessReferenceDataItem[]
      - `Id` string
      - `Name` string
      - `ProcessType` 'Deployment' | 'Runbook'
    - `ProcessTemplateSteps` ReferenceDataItem[]
      - `Id` string
      - `Name` string
    - `Roles` ReferenceDataItem[]
      - `Id` string
      - `Name` string
    - `TargetTagParameters` ReferenceDataItem[]
      - `Id` string
      - `Name` string
    - `TenantTagParameters` ReferenceDataItem[]
      - `Id` string
      - `Name` string
    - `TenantTags` ReferenceDataItem[]
      - `Id` string
      - `Name` string
  - `SpaceId` string
  - `Variables` VariableResource[]
    - `Description` string
    - `Id` string
    - `IsEditable` boolean
    - `IsSensitive` boolean
    - `Name` string
    - `Prompt` VariablePromptOptions
      - `Description` string
      - `DisplaySettings` object
      - `Label` string
      - `Required` boolean
    - `Scope` object
      - `Project` string[]
      - `Environment` string[]
      - `Machine` string[]
      - `Role` string[]
      - `TargetRole` string[]
      - `Action` string[]
      - `User` string[]
      - `Trigger` string[]
      - `ParentDeployment` string[]
      - `Private` string[]
      - `Channel` string[]
      - `TenantTag` string[]
      - `Tenant` string[]
      - `ProcessOwner` string[]
      - `ProjectTemplate` string[]
      - `TemplatedProject` string[]
      - `ProcessTemplateStep` string[]
      - `EnvironmentParameter` string[]
      - `TargetTagParameter` string[]
      - `TenantTagParameter` string[]
    - `Type` string
    - `Value` string
  - `Version` integer

## Other responses

- `400` — Bad request. Either the payload was not structurally valid or business rules did not permit the operation.
- `404` — Not found. One or more of the entities involved in the operation was not found.

---

[API](https://skmtc.net/octopus/apis/octopus-server-api.md) · [All operations](https://skmtc.net/octopus/apis/octopus-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/octopus/octopus-server-api/versions/bc9158facfc7/schema)
