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

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/{spaceId}/releases/{releaseId}/deployments/previews
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Path parameters

spaceIdstring required

ID of the space containing the resources

releaseIdstring required

ID of the release

Request body

IncludeDisabledStepsboolean

Whether to include Disabled Steps in the preview

ReleaseIdstring required

ID of the release

SpaceIdstring required

ID of the space containing the resources

Example request

{
  "DeploymentPreviews": [
    {
      "EnvironmentId": "Environments-1",
      "TenantId": "Tenants-1"
    }
  ],
  "ReleaseId": "Releases-1",
  "SpaceId": "Spaces-1"
}

Response

The requested array of Release Deployment Previews

ChangesMarkdownstring
Idstring

Gets or sets a unique identifier for this resource.

LastModifiedBystring

Gets or sets the username of the user who last modified this resource.

LastModifiedOnstring date-time

Gets or sets the date/time that this resource was last modified.

Linksobject

Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.

UseGuidedFailureModeByDefaultboolean

Example response

[
  {
    "Links": {
      "Self": "/api/..."
    }
  }
]

Changes

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