Releases

Get a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).

get/{spaceId}/releases/{releaseId}/deployments/preview/{environmentId}/{tenantId}

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/{spaceId}/releases/{releaseId}/deployments/preview/{environmentId}/{tenantId}
  • 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

environmentIdstring required

ID of the environment

tenantIdstring required

ID of the tenant

Query parameters

includeDisabledStepsboolean

Whether to include Disabled Steps in the preview

Response

The requested Release Deployment Preview

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.