From c550834b7404c00352415865936048e1918c8b0e Mon Sep 17 00:00:00 2001 From: Octobob Date: Mon, 24 Aug 2026 15:18:19 +0000 Subject: [PATCH] Sync generated API docs origin revision: 54b6f124 --- src/pages/docs/api/_generated/capabilities.md | 24 +++- .../api/_generated/deployment-processes.md | 24 ++-- .../docs/api/_generated/process-templates.md | 14 +- .../docs/api/_generated/runbook-processes.md | 20 +-- .../docs/api/_generated/runbook-snapshots.md | 128 ++++++++++++++++-- 5 files changed, 164 insertions(+), 46 deletions(-) diff --git a/src/pages/docs/api/_generated/capabilities.md b/src/pages/docs/api/_generated/capabilities.md index 6bc74e4e2b..b74c72f5e6 100644 --- a/src/pages/docs/api/_generated/capabilities.md +++ b/src/pages/docs/api/_generated/capabilities.md @@ -1,11 +1,25 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-08-25 title: Capabilities --- -## Ask the server to return a list of all the Capabilities (Commands and Requests) it supports +A Capability is a Request or Command that the server supports. + +You can list all capabilities, or query for an individual one. + +The intent of these endpoints is to allow HTTP clients to detect features in a more robust way than +guessing based on the Server Version. + +Capabilities are expressed in terms of the internal Command or Request data type names. +For example, the URL `/api/{SpaceId}/certificates/v2` maps to the `GetCertificatesRequestV2` request type, +which will appear as a capability for servers which support it. + +The capabilities endpoints can be accessed anonymously; If a client needs to detect a feature before +authenticating, it may do so. + +## List capabilities (Commands and Requests) this server supports :endpoint{method="GET" path="/api/capabilities"} @@ -26,14 +40,16 @@ title: Capabilities ``` ::: -## Ask the server if a single capability exists or not. If the Capability exists, an HTTP 200 (OK) will be returned. If not, a 404 (Not Found) will be returned +## Query for a single capability (Command or Request) :endpoint{method="GET" path="/api/capabilities/\{capability\}"} +If the Capability exists, an HTTP 200 (OK) will be returned. If not, a 404 (Not Found) will be returned. + **Path Parameters** - **`capability`** :span[string]{.type-label} *(required)* - The capability you want to query for. Name matching is case insensitive but otherwise must be a full string match. + The capability you want to query for. Name matching is case insensitive. Partial matching is not supported. **Response** diff --git a/src/pages/docs/api/_generated/deployment-processes.md b/src/pages/docs/api/_generated/deployment-processes.md index 554a8555e5..c727d6b1fd 100644 --- a/src/pages/docs/api/_generated/deployment-processes.md +++ b/src/pages/docs/api/_generated/deployment-processes.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-08-20 title: Deployment Processes --- @@ -258,7 +258,7 @@ Also reachable at `/api/deploymentprocesses/{id}`, `/api/spaces/{spaceIdentifier - **`Properties`** :span[object]{.type-label} - **`Slug`** :span[string]{.type-label} - **`StartTrigger`** :span[enum]{.type-label} - Allowed values: `StartAfterPrevious`, `StartWithPrevious`. + Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`. - **`Type`** :span[string]{.type-label} Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided. - **`Version`** :span[integer]{.type-label} @@ -339,7 +339,7 @@ Also reachable at `/api/projects/{projectId}/deploymentprocesses`, `/api/spaces/ - **`Properties`** :span[object]{.type-label} - **`Slug`** :span[string]{.type-label} - **`StartTrigger`** :span[enum]{.type-label} - Allowed values: `StartAfterPrevious`, `StartWithPrevious`. + Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`. - **`Type`** :span[string]{.type-label} Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided. - **`Version`** :span[integer]{.type-label} @@ -413,7 +413,7 @@ Modifies a deployment process. Only allowed for deployment processes owned by a - **`Properties`** :span[object]{.type-label} - **`Slug`** :span[string]{.type-label} - **`StartTrigger`** :span[enum]{.type-label} - Allowed values: `StartAfterPrevious`, `StartWithPrevious`. + Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`. - **`Type`** :span[string]{.type-label} Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided. - **`Version`** :span[integer]{.type-label} *(required)* @@ -476,7 +476,7 @@ Modifies a deployment process. Only allowed for deployment processes owned by a - **`Properties`** :span[object]{.type-label} - **`Slug`** :span[string]{.type-label} - **`StartTrigger`** :span[enum]{.type-label} - Allowed values: `StartAfterPrevious`, `StartWithPrevious`. + Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`. - **`Type`** :span[string]{.type-label} Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided. - **`Version`** :span[integer]{.type-label} @@ -559,7 +559,7 @@ This request returns the deployment process with all process template usages res - **`Properties`** :span[object]{.type-label} - **`Slug`** :span[string]{.type-label} - **`StartTrigger`** :span[enum]{.type-label} - Allowed values: `StartAfterPrevious`, `StartWithPrevious`. + Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`. - **`Type`** :span[string]{.type-label} Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided. - **`Version`** :span[integer]{.type-label} @@ -805,7 +805,7 @@ Also reachable at `/api/projects/{projectId}/{gitRef}/deploymentprocesses`, `/ap - **`Properties`** :span[object]{.type-label} - **`Slug`** :span[string]{.type-label} - **`StartTrigger`** :span[enum]{.type-label} - Allowed values: `StartAfterPrevious`, `StartWithPrevious`. + Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`. - **`Type`** :span[string]{.type-label} Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided. - **`Version`** :span[integer]{.type-label} @@ -881,7 +881,7 @@ Modifies a deployment process. Only allowed for deployment processes owned by a - **`Properties`** :span[object]{.type-label} - **`Slug`** :span[string]{.type-label} - **`StartTrigger`** :span[enum]{.type-label} - Allowed values: `StartAfterPrevious`, `StartWithPrevious`. + Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`. - **`Type`** :span[string]{.type-label} Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided. - **`Version`** :span[integer]{.type-label} *(required)* @@ -945,7 +945,7 @@ Modifies a deployment process. Only allowed for deployment processes owned by a - **`Properties`** :span[object]{.type-label} - **`Slug`** :span[string]{.type-label} - **`StartTrigger`** :span[enum]{.type-label} - Allowed values: `StartAfterPrevious`, `StartWithPrevious`. + Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`. - **`Type`** :span[string]{.type-label} Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided. - **`Version`** :span[integer]{.type-label} @@ -1029,7 +1029,7 @@ This request returns the deployment process with all process template usages res - **`Properties`** :span[object]{.type-label} - **`Slug`** :span[string]{.type-label} - **`StartTrigger`** :span[enum]{.type-label} - Allowed values: `StartAfterPrevious`, `StartWithPrevious`. + Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`. - **`Type`** :span[string]{.type-label} Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided. - **`Version`** :span[integer]{.type-label} @@ -1282,7 +1282,7 @@ Modifies a deployment process. Only allowed for deployment processes owned by a - **`Properties`** :span[object]{.type-label} - **`Slug`** :span[string]{.type-label} - **`StartTrigger`** :span[enum]{.type-label} - Allowed values: `StartAfterPrevious`, `StartWithPrevious`. + Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`. - **`Type`** :span[string]{.type-label} Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided. - **`Version`** :span[integer]{.type-label} *(required)* @@ -1352,7 +1352,7 @@ Modifies a deployment process. Only allowed for deployment processes owned by a - **`Properties`** :span[object]{.type-label} - **`Slug`** :span[string]{.type-label} - **`StartTrigger`** :span[enum]{.type-label} - Allowed values: `StartAfterPrevious`, `StartWithPrevious`. + Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`. - **`Type`** :span[string]{.type-label} Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided. - **`Version`** :span[integer]{.type-label} diff --git a/src/pages/docs/api/_generated/process-templates.md b/src/pages/docs/api/_generated/process-templates.md index 48b11c3b71..3ae1ed1020 100644 --- a/src/pages/docs/api/_generated/process-templates.md +++ b/src/pages/docs/api/_generated/process-templates.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-08-20 title: Process Templates --- @@ -92,7 +92,7 @@ title: Process Templates - **`Properties`** :span[object]{.type-label} - **`Slug`** :span[string]{.type-label} - **`StartTrigger`** :span[enum]{.type-label} - Allowed values: `StartAfterPrevious`, `StartWithPrevious`. + Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`. - **`Type`** :span[string]{.type-label} Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided. - **`Version`** :span[string]{.type-label} @@ -278,7 +278,7 @@ title: Process Templates - **`Properties`** :span[object]{.type-label} - **`Slug`** :span[string]{.type-label} - **`StartTrigger`** :span[enum]{.type-label} - Allowed values: `StartAfterPrevious`, `StartWithPrevious`. + Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`. - **`Type`** :span[string]{.type-label} Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided. @@ -375,7 +375,7 @@ title: Process Templates - **`Properties`** :span[object]{.type-label} - **`Slug`** :span[string]{.type-label} - **`StartTrigger`** :span[enum]{.type-label} - Allowed values: `StartAfterPrevious`, `StartWithPrevious`. + Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`. - **`Type`** :span[string]{.type-label} Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided. @@ -575,7 +575,7 @@ title: Process Templates - **`Properties`** :span[object]{.type-label} - **`Slug`** :span[string]{.type-label} - **`StartTrigger`** :span[enum]{.type-label} - Allowed values: `StartAfterPrevious`, `StartWithPrevious`. + Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`. - **`Type`** :span[string]{.type-label} Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided. - **`Version`** :span[string]{.type-label} @@ -678,7 +678,7 @@ title: Process Templates - **`Properties`** :span[object]{.type-label} - **`Slug`** :span[string]{.type-label} - **`StartTrigger`** :span[enum]{.type-label} - Allowed values: `StartAfterPrevious`, `StartWithPrevious`. + Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`. - **`Type`** :span[string]{.type-label} Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided. @@ -766,7 +766,7 @@ title: Process Templates - **`Properties`** :span[object]{.type-label} - **`Slug`** :span[string]{.type-label} - **`StartTrigger`** :span[enum]{.type-label} - Allowed values: `StartAfterPrevious`, `StartWithPrevious`. + Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`. - **`Type`** :span[string]{.type-label} Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided. diff --git a/src/pages/docs/api/_generated/runbook-processes.md b/src/pages/docs/api/_generated/runbook-processes.md index 8ccdbfacdd..178433c2eb 100644 --- a/src/pages/docs/api/_generated/runbook-processes.md +++ b/src/pages/docs/api/_generated/runbook-processes.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-08-20 title: Runbook Processes --- @@ -138,7 +138,7 @@ Also reachable at `/api/projects/{projectId}/runbookProcesses/{id}`, `/api/space - **`Properties`** :span[object]{.type-label} - **`Slug`** :span[string]{.type-label} - **`StartTrigger`** :span[enum]{.type-label} - Allowed values: `StartAfterPrevious`, `StartWithPrevious`. + Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`. - **`Type`** :span[string]{.type-label} Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided. - **`Version`** :span[integer]{.type-label} @@ -223,7 +223,7 @@ Only allowed for Runbook Processes owned by a project. - **`Properties`** :span[object]{.type-label} - **`Slug`** :span[string]{.type-label} - **`StartTrigger`** :span[enum]{.type-label} - Allowed values: `StartAfterPrevious`, `StartWithPrevious`. + Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`. - **`Type`** :span[string]{.type-label} Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided. - **`Version`** :span[integer]{.type-label} *(required)* @@ -295,7 +295,7 @@ Only allowed for Runbook Processes owned by a project. - **`Properties`** :span[object]{.type-label} - **`Slug`** :span[string]{.type-label} - **`StartTrigger`** :span[enum]{.type-label} - Allowed values: `StartAfterPrevious`, `StartWithPrevious`. + Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`. - **`Type`** :span[string]{.type-label} Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided. - **`Version`** :span[integer]{.type-label} @@ -495,7 +495,7 @@ Also reachable at `/api/projects/{projectId}/{gitRef}/runbookProcesses/{id}`, `/ - **`Properties`** :span[object]{.type-label} - **`Slug`** :span[string]{.type-label} - **`StartTrigger`** :span[enum]{.type-label} - Allowed values: `StartAfterPrevious`, `StartWithPrevious`. + Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`. - **`Type`** :span[string]{.type-label} Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided. - **`Version`** :span[integer]{.type-label} @@ -586,7 +586,7 @@ Only allowed for Runbook Processes owned by a project. - **`Properties`** :span[object]{.type-label} - **`Slug`** :span[string]{.type-label} - **`StartTrigger`** :span[enum]{.type-label} - Allowed values: `StartAfterPrevious`, `StartWithPrevious`. + Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`. - **`Type`** :span[string]{.type-label} Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided. - **`Version`** :span[integer]{.type-label} *(required)* @@ -660,7 +660,7 @@ Only allowed for Runbook Processes owned by a project. - **`Properties`** :span[object]{.type-label} - **`Slug`** :span[string]{.type-label} - **`StartTrigger`** :span[enum]{.type-label} - Allowed values: `StartAfterPrevious`, `StartWithPrevious`. + Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`. - **`Type`** :span[string]{.type-label} Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided. - **`Version`** :span[integer]{.type-label} @@ -834,7 +834,7 @@ Also reachable at `/api/runbookProcesses/{id}`, `/api/spaces/{spaceIdentifier}/r - **`Properties`** :span[object]{.type-label} - **`Slug`** :span[string]{.type-label} - **`StartTrigger`** :span[enum]{.type-label} - Allowed values: `StartAfterPrevious`, `StartWithPrevious`. + Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`. - **`Type`** :span[string]{.type-label} Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided. - **`Version`** :span[integer]{.type-label} @@ -918,7 +918,7 @@ Only allowed for Runbook Processes owned by a project. - **`Properties`** :span[object]{.type-label} - **`Slug`** :span[string]{.type-label} - **`StartTrigger`** :span[enum]{.type-label} - Allowed values: `StartAfterPrevious`, `StartWithPrevious`. + Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`. - **`Type`** :span[string]{.type-label} Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided. - **`Version`** :span[integer]{.type-label} *(required)* @@ -990,7 +990,7 @@ Only allowed for Runbook Processes owned by a project. - **`Properties`** :span[object]{.type-label} - **`Slug`** :span[string]{.type-label} - **`StartTrigger`** :span[enum]{.type-label} - Allowed values: `StartAfterPrevious`, `StartWithPrevious`. + Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`. - **`Type`** :span[string]{.type-label} Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided. - **`Version`** :span[integer]{.type-label} diff --git a/src/pages/docs/api/_generated/runbook-snapshots.md b/src/pages/docs/api/_generated/runbook-snapshots.md index b0093cfa07..9ac2d52420 100644 --- a/src/pages/docs/api/_generated/runbook-snapshots.md +++ b/src/pages/docs/api/_generated/runbook-snapshots.md @@ -154,6 +154,8 @@ Runbook Snapshots will be ordered from most recent to least recent. - **`SelectedGitResources`** :span[array of object]{.type-label} - **`SelectedPackages`** :span[array of object]{.type-label} - **`SpaceId`** :span[string]{.type-label} + - **`VariableSnapshotConcurrencyToken`** :span[string]{.type-label} + Identifies the runbook snapshot's current variable snapshots. - **`ItemsPerPage`** :span[integer]{.type-label} - **`LastModifiedBy`** :span[string]{.type-label} Gets or sets the username of the user who last modified this resource. @@ -202,7 +204,8 @@ Runbook Snapshots will be ordered from most recent to least recent. "SelectedPackages": [ {} ], - "SpaceId": "Spaces-1" + "SpaceId": "Spaces-1", + "VariableSnapshotConcurrencyToken": "string" } ], "ItemsPerPage": 0, @@ -332,6 +335,8 @@ Also reachable at `/api/projects/{projectId}/runbookSnapshots`, `/api/spaces/{sp - **`StepName`** :span[string]{.type-label} - **`Version`** :span[string]{.type-label} - **`SpaceId`** :span[string]{.type-label} +- **`VariableSnapshotConcurrencyToken`** :span[string]{.type-label} + Identifies the runbook snapshot's current variable snapshots. :::api-example{label="Response"} ```json @@ -378,7 +383,8 @@ Also reachable at `/api/projects/{projectId}/runbookSnapshots`, `/api/spaces/{sp "Version": "string" } ], - "SpaceId": "Spaces-1" + "SpaceId": "Spaces-1", + "VariableSnapshotConcurrencyToken": "string" } ``` ::: @@ -440,6 +446,8 @@ Also reachable at `/api/projects/{projectId}/runbookSnapshots/{idOrName}`, `/api - **`StepName`** :span[string]{.type-label} - **`Version`** :span[string]{.type-label} - **`SpaceId`** :span[string]{.type-label} +- **`VariableSnapshotConcurrencyToken`** :span[string]{.type-label} + Identifies the runbook snapshot's current variable snapshots. :::api-example{label="Response"} ```json @@ -486,7 +494,8 @@ Also reachable at `/api/projects/{projectId}/runbookSnapshots/{idOrName}`, `/api "Version": "string" } ], - "SpaceId": "Spaces-1" + "SpaceId": "Spaces-1", + "VariableSnapshotConcurrencyToken": "string" } ``` ::: @@ -603,6 +612,8 @@ Also reachable at `/api/projects/{projectId}/runbookSnapshots/{id}`, `/api/space - **`StepName`** :span[string]{.type-label} - **`Version`** :span[string]{.type-label} - **`SpaceId`** :span[string]{.type-label} +- **`VariableSnapshotConcurrencyToken`** :span[string]{.type-label} + Identifies the runbook snapshot's current variable snapshots. :::api-example{label="Response"} ```json @@ -649,7 +660,8 @@ Also reachable at `/api/projects/{projectId}/runbookSnapshots/{id}`, `/api/space "Version": "string" } ], - "SpaceId": "Spaces-1" + "SpaceId": "Spaces-1", + "VariableSnapshotConcurrencyToken": "string" } ``` ::: @@ -1063,6 +1075,27 @@ Update the variable snapshots associated with the runbook snapshot to the latest - **`spaceId`** :span[string]{.type-label} *(required)* The ID of the space containing the resource(s). +**Request Body** + +- **`Id`** :span[string]{.type-label} *(required)* + The ID of the runbook snapshot whose variables to refresh, e.g. 'RunbookSnapshots-123'. Minimum length 1. +- **`ProjectId`** :span[string]{.type-label} + The ID of the project containing this resource. Will be inferred if not provided. +- **`SpaceId`** :span[string]{.type-label} *(required)* + The ID of the space containing the resource(s). +- **`VariableSnapshotConcurrencyToken`** :span[string]{.type-label} + +:::api-example{label="Request"} +```json +{ + "Id": "string", + "ProjectId": "Projects-1", + "SpaceId": "Spaces-1", + "VariableSnapshotConcurrencyToken": "string" +} +``` +::: + **Response** `200` — Confirmation that the Runbook Snapshot Variables were refreshed, containing the updated Snapshot @@ -1105,6 +1138,8 @@ Update the variable snapshots associated with the runbook snapshot to the latest - **`StepName`** :span[string]{.type-label} - **`Version`** :span[string]{.type-label} - **`SpaceId`** :span[string]{.type-label} +- **`VariableSnapshotConcurrencyToken`** :span[string]{.type-label} + Identifies the runbook snapshot's current variable snapshots. :::api-example{label="Response"} ```json @@ -1151,7 +1186,8 @@ Update the variable snapshots associated with the runbook snapshot to the latest "Version": "string" } ], - "SpaceId": "Spaces-1" + "SpaceId": "Spaces-1", + "VariableSnapshotConcurrencyToken": "string" } ``` ::: @@ -1173,6 +1209,27 @@ Update the variable snapshots associated with the runbook snapshot to the latest - **`spaceId`** :span[string]{.type-label} *(required)* The ID of the space containing the resource(s). +**Request Body** + +- **`Id`** :span[string]{.type-label} *(required)* + The ID of the runbook snapshot whose variables to refresh, e.g. 'RunbookSnapshots-123'. Minimum length 1. +- **`ProjectId`** :span[string]{.type-label} + The ID of the project containing this resource. Will be inferred if not provided. +- **`SpaceId`** :span[string]{.type-label} *(required)* + The ID of the space containing the resource(s). +- **`VariableSnapshotConcurrencyToken`** :span[string]{.type-label} + +:::api-example{label="Request"} +```json +{ + "Id": "string", + "ProjectId": "Projects-1", + "SpaceId": "Spaces-1", + "VariableSnapshotConcurrencyToken": "string" +} +``` +::: + **Response** `200` — Confirmation that the Runbook Snapshot Variables were refreshed, containing the updated Snapshot @@ -1205,6 +1262,8 @@ Update the variable snapshots associated with the runbook snapshot to the latest - **`SelectedGitResources`** :span[array of object]{.type-label} - **`SelectedPackages`** :span[array of object]{.type-label} - **`SpaceId`** :span[string]{.type-label} + - **`VariableSnapshotConcurrencyToken`** :span[string]{.type-label} + Identifies the runbook snapshot's current variable snapshots. :::api-example{label="Response"} ```json @@ -1249,7 +1308,8 @@ Update the variable snapshots associated with the runbook snapshot to the latest "Version": "string" } ], - "SpaceId": "Spaces-1" + "SpaceId": "Spaces-1", + "VariableSnapshotConcurrencyToken": "string" } } ``` @@ -1575,6 +1635,8 @@ Runbook Snapshots will be ordered from most recent to least recent. - **`SelectedGitResources`** :span[array of object]{.type-label} - **`SelectedPackages`** :span[array of object]{.type-label} - **`SpaceId`** :span[string]{.type-label} + - **`VariableSnapshotConcurrencyToken`** :span[string]{.type-label} + Identifies the runbook snapshot's current variable snapshots. - **`ItemsPerPage`** :span[integer]{.type-label} - **`LastModifiedBy`** :span[string]{.type-label} Gets or sets the username of the user who last modified this resource. @@ -1623,7 +1685,8 @@ Runbook Snapshots will be ordered from most recent to least recent. "SelectedPackages": [ {} ], - "SpaceId": "Spaces-1" + "SpaceId": "Spaces-1", + "VariableSnapshotConcurrencyToken": "string" } ], "ItemsPerPage": 0, @@ -1716,6 +1779,8 @@ Gets a paginated list of the runbook snapshots in the supplied Octopus Deploy Sp - **`SelectedGitResources`** :span[array of object]{.type-label} - **`SelectedPackages`** :span[array of object]{.type-label} - **`SpaceId`** :span[string]{.type-label} + - **`VariableSnapshotConcurrencyToken`** :span[string]{.type-label} + Identifies the runbook snapshot's current variable snapshots. - **`ItemsPerPage`** :span[integer]{.type-label} - **`LastModifiedBy`** :span[string]{.type-label} Gets or sets the username of the user who last modified this resource. @@ -1764,7 +1829,8 @@ Gets a paginated list of the runbook snapshots in the supplied Octopus Deploy Sp "SelectedPackages": [ {} ], - "SpaceId": "Spaces-1" + "SpaceId": "Spaces-1", + "VariableSnapshotConcurrencyToken": "string" } ], "ItemsPerPage": 0, @@ -1892,6 +1958,8 @@ Also reachable at `/api/runbookSnapshots`, `/api/spaces/{spaceIdentifier}/runboo - **`StepName`** :span[string]{.type-label} - **`Version`** :span[string]{.type-label} - **`SpaceId`** :span[string]{.type-label} +- **`VariableSnapshotConcurrencyToken`** :span[string]{.type-label} + Identifies the runbook snapshot's current variable snapshots. :::api-example{label="Response"} ```json @@ -1938,7 +2006,8 @@ Also reachable at `/api/runbookSnapshots`, `/api/spaces/{spaceIdentifier}/runboo "Version": "string" } ], - "SpaceId": "Spaces-1" + "SpaceId": "Spaces-1", + "VariableSnapshotConcurrencyToken": "string" } ``` ::: @@ -1998,6 +2067,8 @@ Also reachable at `/api/runbookSnapshots/{id}`, `/api/spaces/{spaceIdentifier}/r - **`StepName`** :span[string]{.type-label} - **`Version`** :span[string]{.type-label} - **`SpaceId`** :span[string]{.type-label} +- **`VariableSnapshotConcurrencyToken`** :span[string]{.type-label} + Identifies the runbook snapshot's current variable snapshots. :::api-example{label="Response"} ```json @@ -2044,7 +2115,8 @@ Also reachable at `/api/runbookSnapshots/{id}`, `/api/spaces/{spaceIdentifier}/r "Version": "string" } ], - "SpaceId": "Spaces-1" + "SpaceId": "Spaces-1", + "VariableSnapshotConcurrencyToken": "string" } ``` ::: @@ -2159,6 +2231,8 @@ Also reachable at `/api/runbookSnapshots/{id}`, `/api/spaces/{spaceIdentifier}/r - **`StepName`** :span[string]{.type-label} - **`Version`** :span[string]{.type-label} - **`SpaceId`** :span[string]{.type-label} +- **`VariableSnapshotConcurrencyToken`** :span[string]{.type-label} + Identifies the runbook snapshot's current variable snapshots. :::api-example{label="Response"} ```json @@ -2205,7 +2279,8 @@ Also reachable at `/api/runbookSnapshots/{id}`, `/api/spaces/{spaceIdentifier}/r "Version": "string" } ], - "SpaceId": "Spaces-1" + "SpaceId": "Spaces-1", + "VariableSnapshotConcurrencyToken": "string" } ``` ::: @@ -2619,6 +2694,27 @@ Update the variable snapshots associated with the runbook snapshot to the latest - **`spaceId`** :span[string]{.type-label} *(required)* The ID of the space containing the resource(s). +**Request Body** + +- **`Id`** :span[string]{.type-label} *(required)* + The ID of the runbook snapshot whose variables to refresh, e.g. 'RunbookSnapshots-123'. Minimum length 1. +- **`ProjectId`** :span[string]{.type-label} + The ID of the project containing this resource. Will be inferred if not provided. +- **`SpaceId`** :span[string]{.type-label} *(required)* + The ID of the space containing the resource(s). +- **`VariableSnapshotConcurrencyToken`** :span[string]{.type-label} + +:::api-example{label="Request"} +```json +{ + "Id": "string", + "ProjectId": "Projects-1", + "SpaceId": "Spaces-1", + "VariableSnapshotConcurrencyToken": "string" +} +``` +::: + **Response** `200` — Confirmation that the Runbook Snapshot Variables were refreshed, containing the updated Snapshot @@ -2661,6 +2757,8 @@ Update the variable snapshots associated with the runbook snapshot to the latest - **`StepName`** :span[string]{.type-label} - **`Version`** :span[string]{.type-label} - **`SpaceId`** :span[string]{.type-label} +- **`VariableSnapshotConcurrencyToken`** :span[string]{.type-label} + Identifies the runbook snapshot's current variable snapshots. :::api-example{label="Response"} ```json @@ -2707,7 +2805,8 @@ Update the variable snapshots associated with the runbook snapshot to the latest "Version": "string" } ], - "SpaceId": "Spaces-1" + "SpaceId": "Spaces-1", + "VariableSnapshotConcurrencyToken": "string" } ``` ::: @@ -2773,6 +2872,8 @@ Runbook Snapshots will be ordered from most recent to least recent. - **`SelectedGitResources`** :span[array of object]{.type-label} - **`SelectedPackages`** :span[array of object]{.type-label} - **`SpaceId`** :span[string]{.type-label} + - **`VariableSnapshotConcurrencyToken`** :span[string]{.type-label} + Identifies the runbook snapshot's current variable snapshots. - **`ItemsPerPage`** :span[integer]{.type-label} - **`LastModifiedBy`** :span[string]{.type-label} Gets or sets the username of the user who last modified this resource. @@ -2821,7 +2922,8 @@ Runbook Snapshots will be ordered from most recent to least recent. "SelectedPackages": [ {} ], - "SpaceId": "Spaces-1" + "SpaceId": "Spaces-1", + "VariableSnapshotConcurrencyToken": "string" } ], "ItemsPerPage": 0,