LibraryVariableSets

Michael Noonan edited this page Sep 12, 2016 · 3 revisions

A standalone variable set that can be included in projects where required.

Properties

Name Writeable Description
Id A unique identifier for this resource.
ContentType POST Describes the purpose of the variable set. Clients can use this to offer an editing experience appropriately.
Description POST, PUT A description of this variable set that explains the purpose of the variable set to other users. This field may contain markdown.
LastModifiedBy The username of the user who last modified this resource.
LastModifiedOn The date/time that this resource was last modified.
Links A dictionary of links to other related resources. These links can be used to navigate the resources on the server.
Name POST, PUT (required) The name of this variable set. This should be short, preferably 5-20 characters.
Templates Gets the variable templates.
VariableSetId The id of the associated variable set.

Operations

The following operations are supported:


GET /api/libraryvariablesets/all HTTP/1.1

Lists all the library variable sets in the Octopus Deploy installation. The results will be sorted alphabetically by name.

The response will be an array of objects, each with only a name and ID. This query does not use pagination; instead, all items will be returned. Keep in mind that this may be a large number of items and so could take some time. This query is designed for populating collections of reference data such as combo boxes and drop downs. Note also that the results may be stale.

Notes:

  • Users must be authenticated with an API key to perform this action.
  • Filters the returned model by the specified ids. The ids can either be comma seperated or the ids parameter can be specfied multiple times.
  • Access is restricted to users in teams with LibraryVariableSetView permission.

GET ~/api/libraryvariablesets{?skip,contentType,ids} HTTP/1.1

Lists all of the library variable sets in the current Octopus installation. The results will be sorted alphabetically by name.

The response will be a collection of resources. This query uses pagination, so a maximum of 30 items will be returned per page of results. The results may also be stale. Learn more about pagination and stale results.

Notes:

  • Users must be authenticated with an API key to perform this action.
  • Filters the returned model by the specified ids. The ids can either be comma seperated or the ids parameter can be specfied multiple times.
  • Access is restricted to users in teams with LibraryVariableSetView permission.

GET /api/libraryvariablesets/{id} HTTP/1.1

Gets a single library variable set by ID

Notes:

  • Users must be authenticated with an API key to perform this action.
  • Access is restricted to users in teams with LibraryVariableSetView permission.

POST /api/libraryvariablesets HTTP/1.1

Creates a new library variable set.

Notes:

  • Users must be authenticated with an API key to perform this action.
  • Access is restricted to users in teams with LibraryVariableSetCreate permission.
  • This resource can have variables associated with it. After creating the resource, you can check the links on the created resource for a link to retrieve the variables.

PUT /api/libraryvariablesets/{id} HTTP/1.1

Modifies an existing library variable set.

Notes:

  • Users must be authenticated with an API key to perform this action.
  • Access is restricted to users in teams with LibraryVariableSetEdit permission.

DELETE /api/libraryvariablesets/{id} HTTP/1.1

Deletes an existing library variable set.

The resource will be marked as deleted and will no longer appear in any query results. A new background task will be created to delete the resource as well as any child resources it owns. The JSON representation of this task will be returned as the result of this request.

Notes:

  • Users must be authenticated with an API key to perform this action.
  • Access is restricted to users in teams with LibraryVariableSetDelete permission.
Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.