Runbook Snapshots

GET /api/{spaceId}/projects/{projectId}/runbookRuns/{id}/details/v1

Also reachable at /api/spaces/{spaceIdentifier}/projects/{projectId}/runbookRuns/{id}/details/v1.

Path Parameters

• id string (required)
  ID of the Runbook run to load packages for.
• projectId string (required)
  ID of the Project to get Runbook run packages for.
• spaceId string (required)
  The ID of the space containing the resource(s).

Response

200 — Packages and Git references that were used in a Runbook run

• GitResources array of object
  • ActionName string
    Minimum length 1.
  • DefaultBranch string
    Minimum length 1.
  • FilePathFilters array of string
  • GitCredentialId string
  • GitHubConnectionId string
  • GitResourceSelectedLastRelease object
  • IsResolvable boolean
  • Name string
  • RepositoryUri string
    Minimum length 1.
• Packages array of object
  • ActionName string
  • FeedId string
  • FeedName string
  • FixedVersion string
  • IsResolvable boolean
    Gets or sets a value indicating whether the PackageId or FeedId contain no references to other variables. Variables can be used to select different NuGet feeds or packages at deployment time, however, this means that it’s not possible to resolve which feed/package to search when creating a release.
  • NuGetFeedId string
  • NuGetFeedName string
  • NuGetPackageId string
  • PackageId string
  • PackageReferenceName string
  • ProjectName string
  • StepName string
  • VersionSelectedLastRelease string

{
  "GitResources": [
    {
      "ActionName": "string",
      "DefaultBranch": "string",
      "FilePathFilters": [
        "string"
      ],
      "GitCredentialId": "string",
      "GitHubConnectionId": "string",
      "GitResourceSelectedLastRelease": {
        "GitCommit": "string",
        "GitRef": "string"
      },
      "IsResolvable": true,
      "Name": "string",
      "RepositoryUri": "string"
    }
  ],
  "Packages": [
    {
      "ActionName": "string",
      "FeedId": "string",
      "FeedName": "string",
      "FixedVersion": "string",
      "IsResolvable": true,
      "NuGetFeedId": "string",
      "NuGetFeedName": "string",
      "NuGetPackageId": "string",
      "PackageId": "string",
      "PackageReferenceName": "string",
      "ProjectName": "string",
      "StepName": "string",
      "VersionSelectedLastRelease": "string"
    }
  ]
}

GET /api/{spaceId}/projects/{projectId}/runbookSnapshots

Also reachable at /api/projects/{projectId}/runbookSnapshots, /api/spaces/{spaceIdentifier}/projects/{projectId}/runbookSnapshots.

Runbook Snapshots will be ordered from most recent to least recent.

Path Parameters

• projectId string (required)
  The ID of the project to get runbook snapshots for.
• spaceId string (required)
  The ID of the space containing the resource(s).

Query Parameters

• searchByName string
  A partial or complete name to search on. This will perform a “contains” style match against the supplied name or name-fragment.
• skip integer
  Number of items to skip. Defaults to zero. Minimum 0.
• take integer
  Number of items to take. Defaults to 30. Minimum 0.

Response

200 — A paginated list of all of the Runbook Snapshots that belong to the given Project.

• Id string
  Gets or sets a unique identifier for this resource.
• ItemType string
• Items array of object
  • Assembled string
    Format date-time.
  • FrozenProjectVariableSetId string
    Minimum length 1.
  • FrozenRunbookProcessId string
    Minimum length 1.
  • GitReference object
  • Id string
    Gets or sets a unique identifier for this resource.
  • LastModifiedBy string
    Gets or sets the username of the user who last modified this resource.
  • LastModifiedOn string
    Gets or sets the date/time that this resource was last modified. Format date-time.
  • LibraryVariableSetSnapshotIds array of string
    Snapshots of the project’s included library variable sets. The snapshots are VariableSetResources, not LibraryVariableSetResources.
  • Links object
    Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
  • Name string
    Minimum length 1.
  • Notes string
  • ProjectId string
  • ProjectVariableSetSnapshotId string
    Minimum length 1.
  • RunbookId string
  • SelectedGitResources array of object
  • SelectedPackages array of object
  • SpaceId string
• ItemsPerPage integer
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• LastPageNumber integer
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• NumberOfPages integer
• TotalResults integer

{
  "Id": "string",
  "ItemType": "string",
  "Items": [
    {
      "Assembled": "2020-01-01T00:00:00.000Z",
      "FrozenProjectVariableSetId": "string",
      "FrozenRunbookProcessId": "string",
      "GitReference": {
        "GitCommit": "string",
        "GitRef": "string",
        "VariablesGitCommit": "string"
      },
      "Id": "string",
      "LastModifiedBy": "string",
      "LastModifiedOn": "2020-01-01T00:00:00.000Z",
      "LibraryVariableSetSnapshotIds": [
        "string"
      ],
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "Name": "string",
      "Notes": "string",
      "ProjectId": "Projects-1",
      "ProjectVariableSetSnapshotId": "string",
      "RunbookId": "Runbooks-1",
      "SelectedGitResources": [
        {}
      ],
      "SelectedPackages": [
        {}
      ],
      "SpaceId": "Spaces-1"
    }
  ],
  "ItemsPerPage": 0,
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "LastPageNumber": 0,
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "NumberOfPages": 0,
  "TotalResults": 0
}

POST /api/{spaceId}/projects/{projectId}/runbookSnapshots

Also reachable at /api/projects/{projectId}/runbookSnapshots, /api/spaces/{spaceIdentifier}/projects/{projectId}/runbookSnapshots.

Path Parameters

• projectId string (required)
  ID of the project that owns the runbook to snapshot.
• spaceId string (required)
  The ID of the space containing the resource(s).

Request Body

• Name string (required)
  The name of the runbook snapshot. Minimum length 1.
• Notes string
  Any additional information about the runbook snapshot.
• ProjectId string (required)
  ID of the project that owns the runbook to snapshot.
• Publish string
  Publishes the snapshot when set to any non-blank value, making it the snapshot that runbook triggers and ‘published’ runs use. The value itself is not stored. Leave unset to create the snapshot without publishing it.
• RunbookId string (required)
  ID of the runbook to snapshot.
• SelectedGitResources array of object
  • ActionName string (required)
    Minimum length 1.
  • GitReferenceResource object (required)
  • GitResourceReferenceName string
• SelectedPackages array of object
  The packages and versions used in the runbook snapshot.
  • ActionName string
  • PackageReferenceName string
  • StepName string
  • Version string
• SpaceId string (required)
  The ID of the space containing the resource(s).

Response

201 — Created

• Assembled string
  Format date-time.
• FrozenProjectVariableSetId string
  Minimum length 1.
• FrozenRunbookProcessId string
  Minimum length 1.
• GitReference object
  • GitCommit string
  • GitRef string
  • VariablesGitCommit string
• Id string
  Gets or sets a unique identifier for this resource.
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• LibraryVariableSetSnapshotIds array of string
  Snapshots of the project’s included library variable sets. The snapshots are VariableSetResources, not LibraryVariableSetResources.
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• Name string
  Minimum length 1.
• Notes string
• ProjectId string
• ProjectVariableSetSnapshotId string
  Minimum length 1.
• RunbookId string
• SelectedGitResources array of object
  • ActionName string
    Minimum length 1.
  • GitReferenceResource object
  • GitResourceReferenceName string
• SelectedPackages array of object
  • ActionName string
  • PackageReferenceName string
  • StepName string
  • Version string
• SpaceId string

{
  "Name": "string",
  "Notes": "string",
  "ProjectId": "Projects-1",
  "Publish": "string",
  "RunbookId": "Runbooks-1",
  "SelectedGitResources": [
    {
      "ActionName": "string",
      "GitReferenceResource": {
        "GitCommit": "string",
        "GitRef": "string"
      },
      "GitResourceReferenceName": "string"
    }
  ],
  "SelectedPackages": [
    {
      "ActionName": "string",
      "PackageReferenceName": "string",
      "StepName": "string",
      "Version": "string"
    }
  ],
  "SpaceId": "Spaces-1"
}

{
  "Assembled": "2020-01-01T00:00:00.000Z",
  "FrozenProjectVariableSetId": "string",
  "FrozenRunbookProcessId": "string",
  "GitReference": {
    "GitCommit": "string",
    "GitRef": "string",
    "VariablesGitCommit": "string"
  },
  "Id": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "LibraryVariableSetSnapshotIds": [
    "string"
  ],
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "Notes": "string",
  "ProjectId": "Projects-1",
  "ProjectVariableSetSnapshotId": "string",
  "RunbookId": "Runbooks-1",
  "SelectedGitResources": [
    {
      "ActionName": "string",
      "GitReferenceResource": {
        "GitCommit": "string",
        "GitRef": "string"
      },
      "GitResourceReferenceName": "string"
    }
  ],
  "SelectedPackages": [
    {
      "ActionName": "string",
      "PackageReferenceName": "string",
      "StepName": "string",
      "Version": "string"
    }
  ],
  "SpaceId": "Spaces-1"
}

GET /api/{spaceId}/projects/{projectId}/runbookSnapshots/{idOrName}

Also reachable at /api/projects/{projectId}/runbookSnapshots/{idOrName}, /api/spaces/{spaceIdentifier}/projects/{projectId}/runbookSnapshots/{idOrName}.

Path Parameters

• idOrName string (required)
  ID or Name of the RunbookSnapshot to load.
• projectId string (required)
  ID of the Project to get Runbook Snapshot for.
• spaceId string (required)
  The ID of the space containing the resource(s).

Response

200 — Success

• Assembled string
  Format date-time.
• FrozenProjectVariableSetId string
  Minimum length 1.
• FrozenRunbookProcessId string
  Minimum length 1.
• GitReference object
  • GitCommit string
  • GitRef string
  • VariablesGitCommit string
• Id string
  Gets or sets a unique identifier for this resource.
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• LibraryVariableSetSnapshotIds array of string
  Snapshots of the project’s included library variable sets. The snapshots are VariableSetResources, not LibraryVariableSetResources.
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• Name string
  Minimum length 1.
• Notes string
• ProjectId string
• ProjectVariableSetSnapshotId string
  Minimum length 1.
• RunbookId string
• SelectedGitResources array of object
  • ActionName string
    Minimum length 1.
  • GitReferenceResource object
  • GitResourceReferenceName string
• SelectedPackages array of object
  • ActionName string
  • PackageReferenceName string
  • StepName string
  • Version string
• SpaceId string

{
  "Assembled": "2020-01-01T00:00:00.000Z",
  "FrozenProjectVariableSetId": "string",
  "FrozenRunbookProcessId": "string",
  "GitReference": {
    "GitCommit": "string",
    "GitRef": "string",
    "VariablesGitCommit": "string"
  },
  "Id": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "LibraryVariableSetSnapshotIds": [
    "string"
  ],
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "Notes": "string",
  "ProjectId": "Projects-1",
  "ProjectVariableSetSnapshotId": "string",
  "RunbookId": "Runbooks-1",
  "SelectedGitResources": [
    {
      "ActionName": "string",
      "GitReferenceResource": {
        "GitCommit": "string",
        "GitRef": "string"
      },
      "GitResourceReferenceName": "string"
    }
  ],
  "SelectedPackages": [
    {
      "ActionName": "string",
      "PackageReferenceName": "string",
      "StepName": "string",
      "Version": "string"
    }
  ],
  "SpaceId": "Spaces-1"
}

PUT /api/{spaceId}/projects/{projectId}/runbookSnapshots/{id}

Also reachable at /api/projects/{projectId}/runbookSnapshots/{id}, /api/spaces/{spaceIdentifier}/projects/{projectId}/runbookSnapshots/{id}.

Path Parameters

• id string (required)
  ID of the runbook snapshot to modify.
• projectId string (required)
  ID of the project that owns the runbook.
• spaceId string (required)
  The ID of the space containing the resource(s).

Request Body

• Id string (required)
  ID of the runbook snapshot to modify.
• Name string (required)
  The name of the runbook snapshot. Minimum length 1.
• Notes string
  Any additional information about the runbook snapshot.
• ProjectId string
  Not used to locate the snapshot; the snapshot ID alone finds it. Safe to omit.
• SelectedGitResources array of object
  The git resources and versions used in the runbook snapshot.
  • ActionName string (required)
    Minimum length 1.
  • GitReferenceResource object (required)
  • GitResourceReferenceName string
• SelectedPackages array of object
  The packages and versions used in the runbook snapshot.
  • ActionName string
  • PackageReferenceName string
  • StepName string
  • Version string
• SpaceId string (required)
  The ID of the space containing the resource(s).

Response

200 — Confirmation that the Runbook Snapshot was modified, containing the updated snapshot

• Assembled string
  Format date-time.
• FrozenProjectVariableSetId string
  Minimum length 1.
• FrozenRunbookProcessId string
  Minimum length 1.
• GitReference object
  • GitCommit string
  • GitRef string
  • VariablesGitCommit string
• Id string
  Gets or sets a unique identifier for this resource.
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• LibraryVariableSetSnapshotIds array of string
  Snapshots of the project’s included library variable sets. The snapshots are VariableSetResources, not LibraryVariableSetResources.
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• Name string
  Minimum length 1.
• Notes string
• ProjectId string
• ProjectVariableSetSnapshotId string
  Minimum length 1.
• RunbookId string
• SelectedGitResources array of object
  • ActionName string
    Minimum length 1.
  • GitReferenceResource object
  • GitResourceReferenceName string
• SelectedPackages array of object
  • ActionName string
  • PackageReferenceName string
  • StepName string
  • Version string
• SpaceId string

{
  "Id": "string",
  "Name": "string",
  "Notes": "string",
  "ProjectId": "Projects-1",
  "SelectedGitResources": [
    {
      "ActionName": "string",
      "GitReferenceResource": {
        "GitCommit": "string",
        "GitRef": "string"
      },
      "GitResourceReferenceName": "string"
    }
  ],
  "SelectedPackages": [
    {
      "ActionName": "string",
      "PackageReferenceName": "string",
      "StepName": "string",
      "Version": "string"
    }
  ],
  "SpaceId": "Spaces-1"
}

{
  "Assembled": "2020-01-01T00:00:00.000Z",
  "FrozenProjectVariableSetId": "string",
  "FrozenRunbookProcessId": "string",
  "GitReference": {
    "GitCommit": "string",
    "GitRef": "string",
    "VariablesGitCommit": "string"
  },
  "Id": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "LibraryVariableSetSnapshotIds": [
    "string"
  ],
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "Notes": "string",
  "ProjectId": "Projects-1",
  "ProjectVariableSetSnapshotId": "string",
  "RunbookId": "Runbooks-1",
  "SelectedGitResources": [
    {
      "ActionName": "string",
      "GitReferenceResource": {
        "GitCommit": "string",
        "GitRef": "string"
      },
      "GitResourceReferenceName": "string"
    }
  ],
  "SelectedPackages": [
    {
      "ActionName": "string",
      "PackageReferenceName": "string",
      "StepName": "string",
      "Version": "string"
    }
  ],
  "SpaceId": "Spaces-1"
}

GET /api/{spaceId}/projects/{projectId}/runbookSnapshots/{id}/runbookRuns

Also reachable at /api/projects/{projectId}/runbookSnapshots/{id}/runbookRuns, /api/spaces/{spaceIdentifier}/projects/{projectId}/runbookSnapshots/{id}/runbookRuns.

Path Parameters

• id string (required)
• projectId string (required)
• spaceId string (required)

Query Parameters

• skip integer
  Number of items to skip. Defaults to zero. Minimum 0.
• take integer
  Number of items to take. Defaults to 30. Minimum 0.

Response

200 — Contains the Runbook Runs for the given Runbook Snapshot.

• Id string
  Gets or sets a unique identifier for this resource.
• ItemType string
• Items array of object
  • ChangeRequestSettings array of object
  • Comments string
  • Created string
    Format date-time.
  • DebugMode string
  • DeployedBy string
  • DeployedById string
  • DeployedToMachineIds array of string
  • EnvironmentId string
  • ExcludedMachineIds array of string
    A collection of machines in the target environment that should be excluded from the deployment.
  • ExcludedTargetTagIds array of string
    A collection of target tag IDs that should be excluded from the deployment. Only deployment targets that have none of these tags will be deployed to. Tag IDs are in the format “TagSets-{id}/Tags-{id}”.
  • ExecutionPlanLogContext object
  • FailTargetDiscovery boolean
  • FailureEncountered boolean
  • ForcePackageDownload boolean
  • FormValues object
  • FrozenRunbookProcessId string
  • Id string
    Gets or sets a unique identifier for this resource.
  • LastModifiedBy string
    Gets or sets the username of the user who last modified this resource.
  • LastModifiedOn string
    Gets or sets the date/time that this resource was last modified. Format date-time.
  • Links object
    Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
  • ManifestVariableSetId string
  • Name string
  • Priority string
  • ProjectId string
  • QueueTime string
    If set this time will be the used to schedule the deployment to a later time, null is assumed to mean the time will be executed immediately. Format date-time.
  • QueueTimeExpiry string
    Format date-time.
  • RunbookId string
    Minimum length 1.
  • RunbookName string
  • RunbookSnapshotId string
    Minimum length 1.
  • SkipActions array of string
  • SpaceId string
  • SpecificMachineIds array of string
    A collection of machines in the target environment that should be deployed to. If the collection is empty, all enabled machines are deployed.
  • SpecificTargetTagIds array of string
    A collection of target tag IDs that should be included in the deployment. Only deployment targets that have at least one of these tags will be deployed to. Tag IDs are in the format “TagSets-{id}/Tags-{id}”.
  • TaskId string
  • TenantId string
  • TentacleRetentionPeriod object
  • UseGuidedFailure boolean
    If set to true, the deployment will prompt for manual intervention (Fail/Retry/Ignore) when failures are encountered in activities that support it. May be overridden with the Octopus.UseGuidedFailure special variable.
• ItemsPerPage integer
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• LastPageNumber integer
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• NumberOfPages integer
• TotalResults integer

{
  "Id": "string",
  "ItemType": "string",
  "Items": [
    {
      "ChangeRequestSettings": [
        {}
      ],
      "Comments": "string",
      "Created": "2020-01-01T00:00:00.000Z",
      "DebugMode": "string",
      "DeployedBy": "string",
      "DeployedById": "string",
      "DeployedToMachineIds": [
        "string"
      ],
      "EnvironmentId": "Environments-1",
      "ExcludedMachineIds": [
        "string"
      ],
      "ExcludedTargetTagIds": [
        "string"
      ],
      "ExecutionPlanLogContext": {
        "Steps": [
          {}
        ]
      },
      "FailTargetDiscovery": true,
      "FailureEncountered": true,
      "ForcePackageDownload": true,
      "FormValues": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "FrozenRunbookProcessId": "string",
      "Id": "string",
      "LastModifiedBy": "string",
      "LastModifiedOn": "2020-01-01T00:00:00.000Z",
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "ManifestVariableSetId": "string",
      "Name": "string",
      "Priority": "string",
      "ProjectId": "Projects-1",
      "QueueTime": "2020-01-01T00:00:00.000Z",
      "QueueTimeExpiry": "2020-01-01T00:00:00.000Z",
      "RunbookId": "string",
      "RunbookName": "string",
      "RunbookSnapshotId": "string",
      "SkipActions": [
        "string"
      ],
      "SpaceId": "Spaces-1",
      "SpecificMachineIds": [
        "string"
      ],
      "SpecificTargetTagIds": [
        "string"
      ],
      "TaskId": "ServerTasks-1",
      "TenantId": "Tenants-1",
      "TentacleRetentionPeriod": {
        "QuantityToKeep": 0,
        "ShouldKeepForever": true,
        "Strategy": "string",
        "Unit": "Days"
      },
      "UseGuidedFailure": true
    }
  ],
  "ItemsPerPage": 0,
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "LastPageNumber": 0,
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "NumberOfPages": 0,
  "TotalResults": 0
}

GET /api/{spaceId}/projects/{projectId}/runbookSnapshots/{id}/runbookRuns/preview/{environmentId}

Also reachable at /api/projects/{projectId}/runbookSnapshots/{id}/runbookRuns/preview/{environmentId}, /api/projects/{projectId}/runbookSnapshots/{id}/runbookRuns/preview/{environmentId}/{tenant}, /api/spaces/{spaceIdentifier}/projects/{projectId}/runbookSnapshots/{id}/runbookRuns/preview/{environmentId}, /api/spaces/{spaceIdentifier}/projects/{projectId}/runbookSnapshots/{id}/runbookRuns/preview/{environmentId}/{tenant}, /api/{spaceId}/projects/{projectId}/runbookSnapshots/{id}/runbookRuns/preview/{environmentId}/{tenant}.

Gets a document that describes what steps will/won’t be run during a run to a given environment (and tenant if supplied)

Path Parameters

• environmentId string (required)
  ID of the Environment.
• id string (required)
  ID of the Runbook Snapshot.
• projectId string (required)
  ID of the Project.
• spaceId string (required)
  The ID of the space containing the resource(s).

Query Parameters

• includeDisabledSteps boolean
  Boolean to include/exclude disabled steps from response.
• tenant string
  ID of the Tenant.

Response

200 — The requested Runbook Run preview

• Form object
  • Elements array of object
    Elements of the form.
  • Values object
    Values supplied for the form elements.
• Id string
  Gets or sets a unique identifier for this resource.
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• StepsToExecute array of object
  • ActionId string
  • ActionName string
  • ActionNumber string
  • AvailableTagSets array of object
  • CanBeSkipped boolean
  • ExcludedMachines array of object
  • HasNoApplicableMachines boolean
  • IsDisabled boolean
  • MachineNames array of string
  • Machines array of object
  • Roles array of string
  • UnavailableMachines array of object
• UseGuidedFailureModeByDefault boolean

{
  "Form": {
    "Elements": [
      {
        "Control": {},
        "IsValueRequired": true,
        "Name": "string"
      }
    ],
    "Values": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  },
  "Id": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "StepsToExecute": [
    {
      "ActionId": "string",
      "ActionName": "string",
      "ActionNumber": "string",
      "AvailableTagSets": [
        {}
      ],
      "CanBeSkipped": true,
      "ExcludedMachines": [
        {}
      ],
      "HasNoApplicableMachines": true,
      "IsDisabled": true,
      "MachineNames": [
        "string"
      ],
      "Machines": [
        {}
      ],
      "Roles": [
        "string"
      ],
      "UnavailableMachines": [
        {}
      ]
    }
  ],
  "UseGuidedFailureModeByDefault": true
}

GET /api/{spaceId}/projects/{projectId}/runbookSnapshots/{id}/runbookRuns/template

Also reachable at /api/projects/{projectId}/runbookSnapshots/{id}/runbookRuns/template, /api/spaces/{spaceIdentifier}/projects/{projectId}/runbookSnapshots/{id}/runbookRuns/template.

Gets all of the information necessary for creating or editing a run for this snapshot.

Path Parameters

• id string (required)
  ID of the Runbook Snapshot to get a Runbook Run Template for.
• projectId string (required)
  ID of the Project the Runbook Snapshot belongs to.
• spaceId string (required)
  The ID of the space containing the resource(s).

Response

200 — The requested Runbook Run Template

• Id string
  Gets or sets a unique identifier for this resource.
• IsGitResourceModified boolean
• IsLibraryVariableSetModified boolean
• IsRunbookProcessModified boolean
• IsVariableSetModified boolean
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• PromoteTo array of object
  • Id string
  • Links object
  • Name string
• TenantPromotions array of object
  • Id string
    Gets or sets a unique identifier for this resource.
  • LastModifiedBy string
    Gets or sets the username of the user who last modified this resource.
  • LastModifiedOn string
    Gets or sets the date/time that this resource was last modified. Format date-time.
  • Links object
    Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
  • Name string
  • PromoteTo array of object

{
  "Id": "string",
  "IsGitResourceModified": true,
  "IsLibraryVariableSetModified": true,
  "IsRunbookProcessModified": true,
  "IsVariableSetModified": true,
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "PromoteTo": [
    {
      "Id": "Environments-1",
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "Name": "string"
    }
  ],
  "TenantPromotions": [
    {
      "Id": "string",
      "LastModifiedBy": "string",
      "LastModifiedOn": "2020-01-01T00:00:00.000Z",
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "Name": "string",
      "PromoteTo": [
        {}
      ]
    }
  ]
}

POST /api/{spaceId}/projects/{projectId}/runbookSnapshots/{id}/snapshot-variables

Also reachable at /api/projects/{projectId}/runbookSnapshots/{id}/snapshot-variables, /api/spaces/{spaceIdentifier}/projects/{projectId}/runbookSnapshots/{id}/snapshot-variables.

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.

Path Parameters

• id string (required)
  ID of the Runbook Snapshot.
• projectId string (required)
  The ID of the project containing this resource. Will be inferred if not provided.
• spaceId string (required)
  The ID of the space containing the resource(s).

Response

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

• Assembled string
  Format date-time.
• FrozenProjectVariableSetId string
  Minimum length 1.
• FrozenRunbookProcessId string
  Minimum length 1.
• GitReference object
  • GitCommit string
  • GitRef string
  • VariablesGitCommit string
• Id string
  Gets or sets a unique identifier for this resource.
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• LibraryVariableSetSnapshotIds array of string
  Snapshots of the project’s included library variable sets. The snapshots are VariableSetResources, not LibraryVariableSetResources.
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• Name string
  Minimum length 1.
• Notes string
• ProjectId string
• ProjectVariableSetSnapshotId string
  Minimum length 1.
• RunbookId string
• SelectedGitResources array of object
  • ActionName string
    Minimum length 1.
  • GitReferenceResource object
  • GitResourceReferenceName string
• SelectedPackages array of object
  • ActionName string
  • PackageReferenceName string
  • StepName string
  • Version string
• SpaceId string

{
  "Assembled": "2020-01-01T00:00:00.000Z",
  "FrozenProjectVariableSetId": "string",
  "FrozenRunbookProcessId": "string",
  "GitReference": {
    "GitCommit": "string",
    "GitRef": "string",
    "VariablesGitCommit": "string"
  },
  "Id": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "LibraryVariableSetSnapshotIds": [
    "string"
  ],
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "Notes": "string",
  "ProjectId": "Projects-1",
  "ProjectVariableSetSnapshotId": "string",
  "RunbookId": "Runbooks-1",
  "SelectedGitResources": [
    {
      "ActionName": "string",
      "GitReferenceResource": {
        "GitCommit": "string",
        "GitRef": "string"
      },
      "GitResourceReferenceName": "string"
    }
  ],
  "SelectedPackages": [
    {
      "ActionName": "string",
      "PackageReferenceName": "string",
      "StepName": "string",
      "Version": "string"
    }
  ],
  "SpaceId": "Spaces-1"
}

POST /api/{spaceId}/projects/{projectId}/runbookSnapshots/{id}/snapshot-variables/v1

Also reachable at /api/projects/{projectId}/runbookSnapshots/{id}/snapshot-variables/v1, /api/spaces/{spaceIdentifier}/projects/{projectId}/runbookSnapshots/{id}/snapshot-variables/v1.

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.

Path Parameters

• id string (required)
  ID of the Runbook Snapshot.
• projectId string (required)
  The ID of the project containing this resource. Will be inferred if not provided.
• spaceId string (required)
  The ID of the space containing the resource(s).

Response

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

• Resource object
  • Assembled string
    Format date-time.
  • FrozenProjectVariableSetId string
    Minimum length 1.
  • FrozenRunbookProcessId string
    Minimum length 1.
  • GitReference object
  • Id string
    Gets or sets a unique identifier for this resource.
  • LastModifiedBy string
    Gets or sets the username of the user who last modified this resource.
  • LastModifiedOn string
    Gets or sets the date/time that this resource was last modified. Format date-time.
  • LibraryVariableSetSnapshotIds array of string
    Snapshots of the project’s included library variable sets. The snapshots are VariableSetResources, not LibraryVariableSetResources.
  • Links object
    Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
  • Name string
    Minimum length 1.
  • Notes string
  • ProjectId string
  • ProjectVariableSetSnapshotId string
    Minimum length 1.
  • RunbookId string
  • SelectedGitResources array of object
  • SelectedPackages array of object
  • SpaceId string

{
  "Resource": {
    "Assembled": "2020-01-01T00:00:00.000Z",
    "FrozenProjectVariableSetId": "string",
    "FrozenRunbookProcessId": "string",
    "GitReference": {
      "GitCommit": "string",
      "GitRef": "string",
      "VariablesGitCommit": "string"
    },
    "Id": "string",
    "LastModifiedBy": "string",
    "LastModifiedOn": "2020-01-01T00:00:00.000Z",
    "LibraryVariableSetSnapshotIds": [
      "string"
    ],
    "Links": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "Name": "string",
    "Notes": "string",
    "ProjectId": "Projects-1",
    "ProjectVariableSetSnapshotId": "string",
    "RunbookId": "Runbooks-1",
    "SelectedGitResources": [
      {
        "ActionName": "string",
        "GitReferenceResource": {},
        "GitResourceReferenceName": "string"
      }
    ],
    "SelectedPackages": [
      {
        "ActionName": "string",
        "PackageReferenceName": "string",
        "StepName": "string",
        "Version": "string"
      }
    ],
    "SpaceId": "Spaces-1"
  }
}

GET /api/{spaceId}/projects/{projectId}/runbookSnapshots/{id}/variables

Also reachable at /api/projects/{projectId}/runbookSnapshots/{id}/variables, /api/spaces/{spaceIdentifier}/projects/{projectId}/runbookSnapshots/{id}/variables.

Path Parameters

• id string (required)
  ID of the Runbook Snapshot to get variables for.
• projectId string (required)
  ID of the Project the Runbook Snapshot is in.
• spaceId string (required)
  The ID of the space containing the resource(s).

Response

200 — The requested list of Runbook Snapshot Variables

• Id string
  Gets or sets a unique identifier for this resource.
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• OwnerId string
  Gets or sets the ID of the document that owns these variables.
• ScopeValues object
  • Actions array of object
  • Channels array of object
  • EnvironmentParameters array of object
  • Environments array of object
  • Machines array of object
  • ProcessTemplateSteps array of object
  • Processes array of object
  • Roles array of object
  • TargetTagParameters array of object
  • TenantTagParameters array of object
  • TenantTags array of object
• SpaceId string
• Variables array of object
  Gets the collection of variables.
  • Description string
  • Id string
  • IsEditable boolean
  • IsSensitive boolean
  • Name string
  • Prompt object
  • Scope object
  • Type string
  • Value string
• Version integer
  Gets or sets the version number.

[
  {
    "Id": "string",
    "LastModifiedBy": "string",
    "LastModifiedOn": "2020-01-01T00:00:00.000Z",
    "Links": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "OwnerId": "string",
    "ScopeValues": {
      "Actions": [
        {}
      ],
      "Channels": [
        {}
      ],
      "EnvironmentParameters": [
        {}
      ],
      "Environments": [
        {}
      ],
      "Machines": [
        {}
      ],
      "ProcessTemplateSteps": [
        {}
      ],
      "Processes": [
        {}
      ],
      "Roles": [
        {}
      ],
      "TargetTagParameters": [
        {}
      ],
      "TenantTagParameters": [
        {}
      ],
      "TenantTags": [
        {}
      ]
    },
    "SpaceId": "Spaces-1",
    "Variables": [
      {
        "Description": "string",
        "Id": "string",
        "IsEditable": true,
        "IsSensitive": true,
        "Name": "string",
        "Prompt": {},
        "Scope": {},
        "Type": "string",
        "Value": "string"
      }
    ],
    "Version": 0
  }
]

POST /api/{spaceId}/projects/{projectId}/runbookSnapshots/{runbookSnapshotId}/runbookRuns/previews

Also reachable at /api/projects/{projectId}/runbookSnapshots/{runbookSnapshotId}/runbookRuns/previews, /api/spaces/{spaceIdentifier}/projects/{projectId}/runbookSnapshots/{runbookSnapshotId}/runbookRuns/previews.

Path Parameters

• projectId string (required)
  ID of the Project.
• runbookSnapshotId string (required)
  ID of the Runbook Snapshot.
• spaceId string (required)
  The ID of the space containing the resource(s).

Request Body

• DeploymentPreviews array of object (required)
  The environment/tenant combinations to preview, one entry per combination. Leave an entry’s TenantId unset to preview an untenanted run in that environment.
  • EnvironmentId string
  • TenantId string
• IncludeDisabledSteps boolean
  Boolean to include/exclude disabled steps from response.
• ProjectId string (required)
  ID of the Project.
• RunbookSnapshotId string (required)
  ID of the Runbook Snapshot.
• SpaceId string (required)
  The ID of the space containing the resource(s).

Response

200 — A preview for a Runbook run, representing the planned execution.

• Form object
  • Elements array of object
    Elements of the form.
  • Values object
    Values supplied for the form elements.
• Id string
  Gets or sets a unique identifier for this resource.
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• StepsToExecute array of object
  • ActionId string
  • ActionName string
  • ActionNumber string
  • AvailableTagSets array of object
  • CanBeSkipped boolean
  • ExcludedMachines array of object
  • HasNoApplicableMachines boolean
  • IsDisabled boolean
  • MachineNames array of string
  • Machines array of object
  • Roles array of string
  • UnavailableMachines array of object
• UseGuidedFailureModeByDefault boolean

{
  "DeploymentPreviews": [
    {
      "EnvironmentId": "Environments-1",
      "TenantId": "Tenants-1"
    }
  ],
  "IncludeDisabledSteps": true,
  "ProjectId": "Projects-1",
  "RunbookSnapshotId": "string",
  "SpaceId": "Spaces-1"
}

[
  {
    "Form": {
      "Elements": [
        {}
      ],
      "Values": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    },
    "Id": "string",
    "LastModifiedBy": "string",
    "LastModifiedOn": "2020-01-01T00:00:00.000Z",
    "Links": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "StepsToExecute": [
      {
        "ActionId": "string",
        "ActionName": "string",
        "ActionNumber": "string",
        "AvailableTagSets": [
          {}
        ],
        "CanBeSkipped": true,
        "ExcludedMachines": [
          {}
        ],
        "HasNoApplicableMachines": true,
        "IsDisabled": true,
        "MachineNames": [
          "string"
        ],
        "Machines": [
          {}
        ],
        "Roles": [
          "string"
        ],
        "UnavailableMachines": [
          {}
        ]
      }
    ],
    "UseGuidedFailureModeByDefault": true
  }
]

GET /api/{spaceId}/projects/{projectId}/runbooks/{id}/runbookSnapshots

Also reachable at /api/projects/{projectId}/runbooks/{id}/runbookSnapshots, /api/spaces/{spaceIdentifier}/projects/{projectId}/runbooks/{id}/runbookSnapshots.

Runbook Snapshots will be ordered from most recent to least recent.

Path Parameters

• id string (required)
  ID of the runbook to get runbook Snapshots for.
• projectId string (required)
  The ID of the project the runbook belongs to.
• spaceId string (required)
  The ID of the space containing the resource(s).

Query Parameters

• searchByName string
  A partial or complete name to search on. This will perform a “contains” style match against the supplied name or name-fragment.
• skip integer
  Number of items to skip. Defaults to zero. Minimum 0.
• take integer
  Number of items to take. Defaults to 30. Minimum 0.

Response

200 — A paginated list of all of the Runbook Snapshots that belong to the given Runbook.

• Id string
  Gets or sets a unique identifier for this resource.
• ItemType string
• Items array of object
  • Assembled string
    Format date-time.
  • FrozenProjectVariableSetId string
    Minimum length 1.
  • FrozenRunbookProcessId string
    Minimum length 1.
  • GitReference object
  • Id string
    Gets or sets a unique identifier for this resource.
  • LastModifiedBy string
    Gets or sets the username of the user who last modified this resource.
  • LastModifiedOn string
    Gets or sets the date/time that this resource was last modified. Format date-time.
  • LibraryVariableSetSnapshotIds array of string
    Snapshots of the project’s included library variable sets. The snapshots are VariableSetResources, not LibraryVariableSetResources.
  • Links object
    Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
  • Name string
    Minimum length 1.
  • Notes string
  • ProjectId string
  • ProjectVariableSetSnapshotId string
    Minimum length 1.
  • RunbookId string
  • SelectedGitResources array of object
  • SelectedPackages array of object
  • SpaceId string
• ItemsPerPage integer
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• LastPageNumber integer
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• NumberOfPages integer
• TotalResults integer

{
  "Id": "string",
  "ItemType": "string",
  "Items": [
    {
      "Assembled": "2020-01-01T00:00:00.000Z",
      "FrozenProjectVariableSetId": "string",
      "FrozenRunbookProcessId": "string",
      "GitReference": {
        "GitCommit": "string",
        "GitRef": "string",
        "VariablesGitCommit": "string"
      },
      "Id": "string",
      "LastModifiedBy": "string",
      "LastModifiedOn": "2020-01-01T00:00:00.000Z",
      "LibraryVariableSetSnapshotIds": [
        "string"
      ],
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "Name": "string",
      "Notes": "string",
      "ProjectId": "Projects-1",
      "ProjectVariableSetSnapshotId": "string",
      "RunbookId": "Runbooks-1",
      "SelectedGitResources": [
        {}
      ],
      "SelectedPackages": [
        {}
      ],
      "SpaceId": "Spaces-1"
    }
  ],
  "ItemsPerPage": 0,
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "LastPageNumber": 0,
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "NumberOfPages": 0,
  "TotalResults": 0
}

DELETE /api/{spaceId}/projects/{projectId}/runbooksnapshots/{id}

Also reachable at /api/projects/{projectId}/runbooksnapshots/{id}, /api/spaces/{spaceIdentifier}/projects/{projectId}/runbooksnapshots/{id}.

Also deletes all of the Runbook Runs, Tasks and other associated resources belonging to the Runbook Snapshot.

Path Parameters

• id string (required)
  ID of the Runbook Snapshot to delete.
• projectId string (required)
  ID of the Project that the Runbook Snapshot belongs to.
• spaceId string (required)
  The ID of the space containing the resource(s).

Response

200 — Success

GET /api/{spaceId}/runbookSnapshots

Also reachable at /api/runbookSnapshots, /api/spaces/{spaceIdentifier}/runbookSnapshots.

Gets a paginated list of the runbook snapshots in the supplied Octopus Deploy Space, from all projects. The results will be sorted from most recent to least recent snapshot.

Path Parameters

• spaceId string (required)

Query Parameters

• skip integer
  Number of items to skip. Defaults to zero. Minimum 0.
• take integer
  Number of items to take. Defaults to 30. Minimum 0.

Response

200 — A paginated list of the runbook snapshots in the supplied Octopus Deploy Space, from all projects. The results will be sorted from most recent to least recent snapshot.

• Id string
  Gets or sets a unique identifier for this resource.
• ItemType string
• Items array of object
  • Assembled string
    Format date-time.
  • FrozenProjectVariableSetId string
    Minimum length 1.
  • FrozenRunbookProcessId string
    Minimum length 1.
  • GitReference object
  • Id string
    Gets or sets a unique identifier for this resource.
  • LastModifiedBy string
    Gets or sets the username of the user who last modified this resource.
  • LastModifiedOn string
    Gets or sets the date/time that this resource was last modified. Format date-time.
  • LibraryVariableSetSnapshotIds array of string
    Snapshots of the project’s included library variable sets. The snapshots are VariableSetResources, not LibraryVariableSetResources.
  • Links object
    Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
  • Name string
    Minimum length 1.
  • Notes string
  • ProjectId string
  • ProjectVariableSetSnapshotId string
    Minimum length 1.
  • RunbookId string
  • SelectedGitResources array of object
  • SelectedPackages array of object
  • SpaceId string
• ItemsPerPage integer
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• LastPageNumber integer
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• NumberOfPages integer
• TotalResults integer

{
  "Id": "string",
  "ItemType": "string",
  "Items": [
    {
      "Assembled": "2020-01-01T00:00:00.000Z",
      "FrozenProjectVariableSetId": "string",
      "FrozenRunbookProcessId": "string",
      "GitReference": {
        "GitCommit": "string",
        "GitRef": "string",
        "VariablesGitCommit": "string"
      },
      "Id": "string",
      "LastModifiedBy": "string",
      "LastModifiedOn": "2020-01-01T00:00:00.000Z",
      "LibraryVariableSetSnapshotIds": [
        "string"
      ],
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "Name": "string",
      "Notes": "string",
      "ProjectId": "Projects-1",
      "ProjectVariableSetSnapshotId": "string",
      "RunbookId": "Runbooks-1",
      "SelectedGitResources": [
        {}
      ],
      "SelectedPackages": [
        {}
      ],
      "SpaceId": "Spaces-1"
    }
  ],
  "ItemsPerPage": 0,
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "LastPageNumber": 0,
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "NumberOfPages": 0,
  "TotalResults": 0
}

POST /api/{spaceId}/runbookSnapshots

Also reachable at /api/runbookSnapshots, /api/spaces/{spaceIdentifier}/runbookSnapshots.

Path Parameters

• spaceId string (required)
  The ID of the space containing the resource(s).

Request Body

• Name string (required)
  The name of the runbook snapshot. Minimum length 1.
• Notes string
  Any additional information about the runbook snapshot.
• ProjectId string (required)
  ID of the project that owns the runbook to snapshot.
• Publish string
  Publishes the snapshot when set to any non-blank value, making it the snapshot that runbook triggers and ‘published’ runs use. The value itself is not stored. Leave unset to create the snapshot without publishing it.
• RunbookId string (required)
  ID of the runbook to snapshot.
• SelectedGitResources array of object
  • ActionName string (required)
    Minimum length 1.
  • GitReferenceResource object (required)
  • GitResourceReferenceName string
• SelectedPackages array of object
  The packages and versions used in the runbook snapshot.
  • ActionName string
  • PackageReferenceName string
  • StepName string
  • Version string
• SpaceId string (required)
  The ID of the space containing the resource(s).

Response

201 — Created

• Assembled string
  Format date-time.
• FrozenProjectVariableSetId string
  Minimum length 1.
• FrozenRunbookProcessId string
  Minimum length 1.
• GitReference object
  • GitCommit string
  • GitRef string
  • VariablesGitCommit string
• Id string
  Gets or sets a unique identifier for this resource.
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• LibraryVariableSetSnapshotIds array of string
  Snapshots of the project’s included library variable sets. The snapshots are VariableSetResources, not LibraryVariableSetResources.
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• Name string
  Minimum length 1.
• Notes string
• ProjectId string
• ProjectVariableSetSnapshotId string
  Minimum length 1.
• RunbookId string
• SelectedGitResources array of object
  • ActionName string
    Minimum length 1.
  • GitReferenceResource object
  • GitResourceReferenceName string
• SelectedPackages array of object
  • ActionName string
  • PackageReferenceName string
  • StepName string
  • Version string
• SpaceId string

{
  "Name": "string",
  "Notes": "string",
  "ProjectId": "Projects-1",
  "Publish": "string",
  "RunbookId": "Runbooks-1",
  "SelectedGitResources": [
    {
      "ActionName": "string",
      "GitReferenceResource": {
        "GitCommit": "string",
        "GitRef": "string"
      },
      "GitResourceReferenceName": "string"
    }
  ],
  "SelectedPackages": [
    {
      "ActionName": "string",
      "PackageReferenceName": "string",
      "StepName": "string",
      "Version": "string"
    }
  ],
  "SpaceId": "Spaces-1"
}

{
  "Assembled": "2020-01-01T00:00:00.000Z",
  "FrozenProjectVariableSetId": "string",
  "FrozenRunbookProcessId": "string",
  "GitReference": {
    "GitCommit": "string",
    "GitRef": "string",
    "VariablesGitCommit": "string"
  },
  "Id": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "LibraryVariableSetSnapshotIds": [
    "string"
  ],
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "Notes": "string",
  "ProjectId": "Projects-1",
  "ProjectVariableSetSnapshotId": "string",
  "RunbookId": "Runbooks-1",
  "SelectedGitResources": [
    {
      "ActionName": "string",
      "GitReferenceResource": {
        "GitCommit": "string",
        "GitRef": "string"
      },
      "GitResourceReferenceName": "string"
    }
  ],
  "SelectedPackages": [
    {
      "ActionName": "string",
      "PackageReferenceName": "string",
      "StepName": "string",
      "Version": "string"
    }
  ],
  "SpaceId": "Spaces-1"
}

GET /api/{spaceId}/runbookSnapshots/{id}

Also reachable at /api/runbookSnapshots/{id}, /api/spaces/{spaceIdentifier}/runbookSnapshots/{id}.

Path Parameters

• id string (required)
  ID of the RunbookSnapshot to retrieve.
• spaceId string (required)
  The ID of the space containing the resource(s).

Response

200 — The requested runbook snapshot

• Assembled string
  Format date-time.
• FrozenProjectVariableSetId string
  Minimum length 1.
• FrozenRunbookProcessId string
  Minimum length 1.
• GitReference object
  • GitCommit string
  • GitRef string
  • VariablesGitCommit string
• Id string
  Gets or sets a unique identifier for this resource.
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• LibraryVariableSetSnapshotIds array of string
  Snapshots of the project’s included library variable sets. The snapshots are VariableSetResources, not LibraryVariableSetResources.
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• Name string
  Minimum length 1.
• Notes string
• ProjectId string
• ProjectVariableSetSnapshotId string
  Minimum length 1.
• RunbookId string
• SelectedGitResources array of object
  • ActionName string
    Minimum length 1.
  • GitReferenceResource object
  • GitResourceReferenceName string
• SelectedPackages array of object
  • ActionName string
  • PackageReferenceName string
  • StepName string
  • Version string
• SpaceId string

{
  "Assembled": "2020-01-01T00:00:00.000Z",
  "FrozenProjectVariableSetId": "string",
  "FrozenRunbookProcessId": "string",
  "GitReference": {
    "GitCommit": "string",
    "GitRef": "string",
    "VariablesGitCommit": "string"
  },
  "Id": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "LibraryVariableSetSnapshotIds": [
    "string"
  ],
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "Notes": "string",
  "ProjectId": "Projects-1",
  "ProjectVariableSetSnapshotId": "string",
  "RunbookId": "Runbooks-1",
  "SelectedGitResources": [
    {
      "ActionName": "string",
      "GitReferenceResource": {
        "GitCommit": "string",
        "GitRef": "string"
      },
      "GitResourceReferenceName": "string"
    }
  ],
  "SelectedPackages": [
    {
      "ActionName": "string",
      "PackageReferenceName": "string",
      "StepName": "string",
      "Version": "string"
    }
  ],
  "SpaceId": "Spaces-1"
}

PUT /api/{spaceId}/runbookSnapshots/{id}

Also reachable at /api/runbookSnapshots/{id}, /api/spaces/{spaceIdentifier}/runbookSnapshots/{id}.

Path Parameters

• id string (required)
  ID of the runbook snapshot to modify.
• spaceId string (required)
  The ID of the space containing the resource(s).

Request Body

• Id string (required)
  ID of the runbook snapshot to modify.
• Name string (required)
  The name of the runbook snapshot. Minimum length 1.
• Notes string
  Any additional information about the runbook snapshot.
• ProjectId string
  Not used to locate the snapshot; the snapshot ID alone finds it. Safe to omit.
• SelectedGitResources array of object
  The git resources and versions used in the runbook snapshot.
  • ActionName string (required)
    Minimum length 1.
  • GitReferenceResource object (required)
  • GitResourceReferenceName string
• SelectedPackages array of object
  The packages and versions used in the runbook snapshot.
  • ActionName string
  • PackageReferenceName string
  • StepName string
  • Version string
• SpaceId string (required)
  The ID of the space containing the resource(s).

Response

200 — Confirmation that the Runbook Snapshot was modified, containing the updated snapshot

• Assembled string
  Format date-time.
• FrozenProjectVariableSetId string
  Minimum length 1.
• FrozenRunbookProcessId string
  Minimum length 1.
• GitReference object
  • GitCommit string
  • GitRef string
  • VariablesGitCommit string
• Id string
  Gets or sets a unique identifier for this resource.
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• LibraryVariableSetSnapshotIds array of string
  Snapshots of the project’s included library variable sets. The snapshots are VariableSetResources, not LibraryVariableSetResources.
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• Name string
  Minimum length 1.
• Notes string
• ProjectId string
• ProjectVariableSetSnapshotId string
  Minimum length 1.
• RunbookId string
• SelectedGitResources array of object
  • ActionName string
    Minimum length 1.
  • GitReferenceResource object
  • GitResourceReferenceName string
• SelectedPackages array of object
  • ActionName string
  • PackageReferenceName string
  • StepName string
  • Version string
• SpaceId string

{
  "Id": "string",
  "Name": "string",
  "Notes": "string",
  "ProjectId": "Projects-1",
  "SelectedGitResources": [
    {
      "ActionName": "string",
      "GitReferenceResource": {
        "GitCommit": "string",
        "GitRef": "string"
      },
      "GitResourceReferenceName": "string"
    }
  ],
  "SelectedPackages": [
    {
      "ActionName": "string",
      "PackageReferenceName": "string",
      "StepName": "string",
      "Version": "string"
    }
  ],
  "SpaceId": "Spaces-1"
}

{
  "Assembled": "2020-01-01T00:00:00.000Z",
  "FrozenProjectVariableSetId": "string",
  "FrozenRunbookProcessId": "string",
  "GitReference": {
    "GitCommit": "string",
    "GitRef": "string",
    "VariablesGitCommit": "string"
  },
  "Id": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "LibraryVariableSetSnapshotIds": [
    "string"
  ],
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "Notes": "string",
  "ProjectId": "Projects-1",
  "ProjectVariableSetSnapshotId": "string",
  "RunbookId": "Runbooks-1",
  "SelectedGitResources": [
    {
      "ActionName": "string",
      "GitReferenceResource": {
        "GitCommit": "string",
        "GitRef": "string"
      },
      "GitResourceReferenceName": "string"
    }
  ],
  "SelectedPackages": [
    {
      "ActionName": "string",
      "PackageReferenceName": "string",
      "StepName": "string",
      "Version": "string"
    }
  ],
  "SpaceId": "Spaces-1"
}

GET /api/{spaceId}/runbookSnapshots/{id}/runbookRuns

Also reachable at /api/runbookSnapshots/{id}/runbookRuns, /api/spaces/{spaceIdentifier}/runbookSnapshots/{id}/runbookRuns.

Path Parameters

• id string (required)
• spaceId string (required)

Query Parameters

• skip integer
  Number of items to skip. Defaults to zero. Minimum 0.
• take integer
  Number of items to take. Defaults to 30. Minimum 0.

Response

200 — Contains the Runbook Runs for the given Runbook Snapshot.

• Id string
  Gets or sets a unique identifier for this resource.
• ItemType string
• Items array of object
  • ChangeRequestSettings array of object
  • Comments string
  • Created string
    Format date-time.
  • DebugMode string
  • DeployedBy string
  • DeployedById string
  • DeployedToMachineIds array of string
  • EnvironmentId string
  • ExcludedMachineIds array of string
    A collection of machines in the target environment that should be excluded from the deployment.
  • ExcludedTargetTagIds array of string
    A collection of target tag IDs that should be excluded from the deployment. Only deployment targets that have none of these tags will be deployed to. Tag IDs are in the format “TagSets-{id}/Tags-{id}”.
  • ExecutionPlanLogContext object
  • FailTargetDiscovery boolean
  • FailureEncountered boolean
  • ForcePackageDownload boolean
  • FormValues object
  • FrozenRunbookProcessId string
  • Id string
    Gets or sets a unique identifier for this resource.
  • LastModifiedBy string
    Gets or sets the username of the user who last modified this resource.
  • LastModifiedOn string
    Gets or sets the date/time that this resource was last modified. Format date-time.
  • Links object
    Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
  • ManifestVariableSetId string
  • Name string
  • Priority string
  • ProjectId string
  • QueueTime string
    If set this time will be the used to schedule the deployment to a later time, null is assumed to mean the time will be executed immediately. Format date-time.
  • QueueTimeExpiry string
    Format date-time.
  • RunbookId string
    Minimum length 1.
  • RunbookName string
  • RunbookSnapshotId string
    Minimum length 1.
  • SkipActions array of string
  • SpaceId string
  • SpecificMachineIds array of string
    A collection of machines in the target environment that should be deployed to. If the collection is empty, all enabled machines are deployed.
  • SpecificTargetTagIds array of string
    A collection of target tag IDs that should be included in the deployment. Only deployment targets that have at least one of these tags will be deployed to. Tag IDs are in the format “TagSets-{id}/Tags-{id}”.
  • TaskId string
  • TenantId string
  • TentacleRetentionPeriod object
  • UseGuidedFailure boolean
    If set to true, the deployment will prompt for manual intervention (Fail/Retry/Ignore) when failures are encountered in activities that support it. May be overridden with the Octopus.UseGuidedFailure special variable.
• ItemsPerPage integer
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• LastPageNumber integer
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• NumberOfPages integer
• TotalResults integer

{
  "Id": "string",
  "ItemType": "string",
  "Items": [
    {
      "ChangeRequestSettings": [
        {}
      ],
      "Comments": "string",
      "Created": "2020-01-01T00:00:00.000Z",
      "DebugMode": "string",
      "DeployedBy": "string",
      "DeployedById": "string",
      "DeployedToMachineIds": [
        "string"
      ],
      "EnvironmentId": "Environments-1",
      "ExcludedMachineIds": [
        "string"
      ],
      "ExcludedTargetTagIds": [
        "string"
      ],
      "ExecutionPlanLogContext": {
        "Steps": [
          {}
        ]
      },
      "FailTargetDiscovery": true,
      "FailureEncountered": true,
      "ForcePackageDownload": true,
      "FormValues": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "FrozenRunbookProcessId": "string",
      "Id": "string",
      "LastModifiedBy": "string",
      "LastModifiedOn": "2020-01-01T00:00:00.000Z",
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "ManifestVariableSetId": "string",
      "Name": "string",
      "Priority": "string",
      "ProjectId": "Projects-1",
      "QueueTime": "2020-01-01T00:00:00.000Z",
      "QueueTimeExpiry": "2020-01-01T00:00:00.000Z",
      "RunbookId": "string",
      "RunbookName": "string",
      "RunbookSnapshotId": "string",
      "SkipActions": [
        "string"
      ],
      "SpaceId": "Spaces-1",
      "SpecificMachineIds": [
        "string"
      ],
      "SpecificTargetTagIds": [
        "string"
      ],
      "TaskId": "ServerTasks-1",
      "TenantId": "Tenants-1",
      "TentacleRetentionPeriod": {
        "QuantityToKeep": 0,
        "ShouldKeepForever": true,
        "Strategy": "string",
        "Unit": "Days"
      },
      "UseGuidedFailure": true
    }
  ],
  "ItemsPerPage": 0,
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "LastPageNumber": 0,
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "NumberOfPages": 0,
  "TotalResults": 0
}

GET /api/{spaceId}/runbookSnapshots/{id}/runbookRuns/preview/{environmentId}

Also reachable at /api/runbookSnapshots/{id}/runbookRuns/preview/{environmentId}, /api/runbookSnapshots/{id}/runbookRuns/preview/{environmentId}/{tenant}, /api/spaces/{spaceIdentifier}/runbookSnapshots/{id}/runbookRuns/preview/{environmentId}, /api/spaces/{spaceIdentifier}/runbookSnapshots/{id}/runbookRuns/preview/{environmentId}/{tenant}, /api/{spaceId}/runbookSnapshots/{id}/runbookRuns/preview/{environmentId}/{tenant}.

Gets a document that describes what steps will/won’t be run during a run to a given environment (and tenant if supplied)

Path Parameters

• environmentId string (required)
  ID of the Environment.
• id string (required)
  ID of the Runbook Snapshot.
• spaceId string (required)
  The ID of the space containing the resource(s).

Query Parameters

• includeDisabledSteps boolean
  Boolean to include/exclude disabled steps from response.
• projectId string
  ID of the Project.
• tenant string
  ID of the Tenant.

Response

200 — The requested Runbook Run preview

• Form object
  • Elements array of object
    Elements of the form.
  • Values object
    Values supplied for the form elements.
• Id string
  Gets or sets a unique identifier for this resource.
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• StepsToExecute array of object
  • ActionId string
  • ActionName string
  • ActionNumber string
  • AvailableTagSets array of object
  • CanBeSkipped boolean
  • ExcludedMachines array of object
  • HasNoApplicableMachines boolean
  • IsDisabled boolean
  • MachineNames array of string
  • Machines array of object
  • Roles array of string
  • UnavailableMachines array of object
• UseGuidedFailureModeByDefault boolean

{
  "Form": {
    "Elements": [
      {
        "Control": {},
        "IsValueRequired": true,
        "Name": "string"
      }
    ],
    "Values": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  },
  "Id": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "StepsToExecute": [
    {
      "ActionId": "string",
      "ActionName": "string",
      "ActionNumber": "string",
      "AvailableTagSets": [
        {}
      ],
      "CanBeSkipped": true,
      "ExcludedMachines": [
        {}
      ],
      "HasNoApplicableMachines": true,
      "IsDisabled": true,
      "MachineNames": [
        "string"
      ],
      "Machines": [
        {}
      ],
      "Roles": [
        "string"
      ],
      "UnavailableMachines": [
        {}
      ]
    }
  ],
  "UseGuidedFailureModeByDefault": true
}