Releases

Update the Variable Snapshot for a Release

post/{spaceId}/releases/{releaseId}/snapshot-variables

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/{spaceId}/releases/{releaseId}/snapshot-variables
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Path parameters

spaceIdstring required
releaseIdstring required

Request body

ReleaseIdstring required
SpaceIdstring required
VariableSnapshotConcurrencyTokenstring

The VariableSnapshotConcurrencyToken read from the release. When supplied, the update fails with a conflict if the release's variable snapshots have changed since. Omit to skip the check.

Example request

{
  "ReleaseId": "Releases-1",
  "SpaceId": "Spaces-1"
}

Response

Confirmation that the Variable Snapshot for a Release was updated, containing the updated Release

Assembledstring date-time
ChannelIdstring
CustomFieldsobject
Idstring

Gets or sets a unique identifier for this resource.

IgnoreChannelRulesboolean
LastModifiedBystring

Gets or sets the username of the user who last modified this resource.

LastModifiedOnstring date-time

Gets or sets the date/time that this resource was last modified.

LibraryVariableSetSnapshotIdsstring[]

Snapshots of the project's included library variable sets. The snapshots are VariableSetResources, not LibraryVariableSetResources.

Linksobject

Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.

ProjectDeploymentProcessSnapshotIdstring
ProjectIdstring
ProjectVariableSetSnapshotIdstring
ReleaseNotesstring
SpaceIdstring
VariableSnapshotConcurrencyTokenstring

Identifies the release's current variable snapshots.

Versionstring required

Example response

{
  "ChannelId": "Channels-1",
  "Id": "Releases-1",
  "Links": {
    "Self": "/api/..."
  },
  "ProjectId": "Projects-1",
  "SpaceId": "Spaces-1"
}

Changes