Sign in
Swagger 2.02026-08-141,9198883.7 MB

dbbd6d1e3f1c

DeploymentSettings

Modifies deployment settings

Modifies deployment settings for a project.

put/projects/{projectId}/{gitRef}/deploymentsettings

Path parameters

projectIdstring required

The Project ID to get the deployment settings from. Example Projects-1.

gitRefstring required

Git reference to use when modifying deployment settings.

Request body

CancelQueuedTasksboolean
CancelRunningTasksboolean
ChangeDescriptionstring

Used as the Git commit message. Omit to use the default message 'Update deployment settings'.

DefaultGuidedFailureMode'EnvironmentDefault' | 'Off' | 'On'
DefaultToSkipIfAlreadyInstalledboolean
DeploymentChangesTemplatestring
FailTargetDiscoveryboolean
ForcePackageDownloadboolean
GitRefstring required
ProjectIdstring required
ReleaseNotesTemplatestring

Template text pre-filled as the release notes when a release of this project is created; may contain Octopus variable expressions. Omitting this clears the project's existing template.

SpaceIdstring required

Response

Confirmation that the Deployment Settings were modified, contains the updated Deployment Settings

CancelQueuedTasksboolean
CancelRunningTasksboolean
DefaultGuidedFailureMode'EnvironmentDefault' | 'Off' | 'On'
DefaultToSkipIfAlreadyInstalledboolean
DeploymentChangesTemplatestring
FailTargetDiscoveryboolean
ForcePackageDownloadboolean
Idstring
LastModifiedBystring
LastModifiedOnstring date-time
Linksobject
ProjectIdstring
ReleaseNotesTemplatestring
SpaceIdstring