RunbookSnapshots

Update the variable snapshots for a Runbook Snapshot

Update the variable snapshots associated with the runbook snapshot to the latest versions. The runbook's process must not have changed since the snapshot was created.

post/{spaceId}/runbookSnapshots/{id}/snapshot-variables

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/{spaceId}/runbookSnapshots/{id}/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

The ID of the space containing the resource(s).

idstring required

ID of the Runbook Snapshot

Request body

Idstring required

The ID of the runbook snapshot whose variables to refresh, e.g. 'RunbookSnapshots-123'.

ProjectIdstring

The ID of the project containing this resource. Will be inferred if not provided.

SpaceIdstring required

The ID of the space containing the resource(s).

VariableSnapshotConcurrencyTokenstring

Example request

{
  "ProjectId": "Projects-1",
  "SpaceId": "Spaces-1"
}

Response

Confirmation that the Runbook Snapshot Variables were refreshed, containing the updated Snapshot

Assembledstring date-time required
FrozenProjectVariableSetIdstring required
FrozenRunbookProcessIdstring required
Idstring

Gets or sets a unique identifier for this resource.

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.

Namestring required
Notesstring
ProjectIdstring required
ProjectVariableSetSnapshotIdstring required
RunbookIdstring required
SpaceIdstring required
VariableSnapshotConcurrencyTokenstring

Identifies the runbook snapshot's current variable snapshots.

Example response

{
  "Links": {
    "Self": "/api/..."
  },
  "ProjectId": "Projects-1",
  "RunbookId": "Runbooks-1",
  "SpaceId": "Spaces-1"
}

Changes

No recorded changes to this operation across all 13 revisions of this API.