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}/projects/{projectId}/runbookSnapshots/{id}/snapshot-variables/v1

Request

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

projectIdstring required

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

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

Example response

{
  "Resource": {
    "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.