---
title: "Return an array of documents that describes what steps will/won't be run during deployments to a given set of environments and tenants."
method: POST
path: "/{spaceId}/releases/{releaseId}/deployments/previews"
tags: ["Releases"]
---

# Return an array of documents that describes what steps will/won't be run during deployments to a given set of environments and tenants.

`POST /{spaceId}/releases/{releaseId}/deployments/previews`

## Path parameters

- `spaceId` string, required
- `releaseId` string, required

## Request body

- GetReleaseDeploymentPreviewsRequest
  - `DeploymentPreviews` DeploymentPreviewRequest[], required — The array of requests you would like to make
    - `EnvironmentId` string
    - `TenantId` string
  - `IncludeDisabledSteps` boolean — Whether to include Disabled Steps in the preview
  - `ReleaseId` string, required — ID of the release
  - `SpaceId` string, required — ID of the space containing the resources

## Response `200`

The requested array of Release Deployment Previews

- DeploymentPreviewResource[]
  - `Changes` ReleaseChangesResource[]
    - `BuildInformation` ReleasePackageVersionBuildInformation[]
      - `Branch` string
      - `BuildEnvironment` string
      - `BuildNumber` string
      - `BuildUrl` string
      - `Commits` CommitDetails[]
        - `Comment` string
        - `Id` string
        - `LinkUrl` string
      - `PackageId` string
      - `VcsCommitNumber` string
      - `VcsCommitUrl` string
      - `VcsRoot` string
      - `VcsType` string
      - `Version` string
      - `WorkItems` WorkItemLink[]
        - `Description` string
        - `Id` string
        - `LinkUrl` string
        - `Source` string
    - `Commits` CommitDetails[] — Aggregate of distinct commits from all VersionMetadata
      - `Comment` string
      - `Id` string
      - `LinkUrl` string
    - `ReleaseNotes` string
    - `Version` string
    - `WorkItems` WorkItemLink[] — Aggregate of distinct work items from all VersionMetadata
      - `Description` string
      - `Id` string
      - `LinkUrl` string
      - `Source` string
  - `ChangesMarkdown` string
  - `Form` Form
    - `Elements` FormElement[] — Elements of the form.
      - `Control` Control
        - `Type` 'Checkbox' | 'TextArea' | 'Paragraph' | 'SubmitButtonGroup' | 'VariableValue'
      - `IsValueRequired` boolean — If true, the receiver of the form expects that a value will be provided for the element.
      - `Name` string — The name of the element. Must be unique within 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, date-time — Gets or sets the date/time that this resource was last modified.
  - `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` DeploymentTemplateStep[]
    - `ActionId` string
    - `ActionName` string
    - `ActionNumber` string
    - `AvailableTagSets` TagSetPreview[]
      - `AvailableTags` TargetTagPreview[]
        - `SortOrder` integer
        - `TagId` string, required
        - `TagName` string, required
      - `SortOrder` integer
      - `TagSetId` string, required
      - `TagSetName` string, required
      - `TagSetType` string, required
    - `CanBeSkipped` boolean
    - `ExcludedMachines` ReferenceDataItem[]
      - `Id` string
      - `Name` string
    - `HasNoApplicableMachines` boolean
    - `IsDisabled` boolean
    - `MachineNames` string[]
    - `Machines` MachineDeploymentPreview[]
      - `HasLatestCalamari` boolean
      - `HealthStatus` 'Healthy' | 'HasWarnings' | 'Unhealthy' | 'Unavailable'
      - `Id` string
      - `Name` string
    - `Roles` string[]
    - `UnavailableMachines` ReferenceDataItem[]
      - `Id` string
      - `Name` string
  - `UseGuidedFailureModeByDefault` boolean

## Other responses

- `400` — Bad request. Either the payload was not structurally valid or business rules did not permit the operation.
- `404` — Not found. One or more of the entities involved in the operation was not found.

---

[API](https://skmtc.net/octopus/apis/octopus-server-api.md) · [All operations](https://skmtc.net/octopus/apis/octopus-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/octopus/octopus-server-api/revisions/b296c3a60aa5/schema)