---
title: "Modify deployment settings"
method: PUT
path: "/projects/{projectId}/deploymentsettings"
tags: ["DeploymentSettings"]
---

# Modify deployment settings

`PUT /projects/{projectId}/deploymentsettings`

Modifies deployment settings for a project.

## Path parameters

- `projectId` string, required

## Request body

- ModifyDeploymentSettingsInDatabaseCommand — Modifies deployment settings for a project.
  - `CancelQueuedTasks` boolean — When enabled, creating a new deployment will cancel all previously queued deployments to the same project/environment/tenant
  - `CancelRunningTasks` boolean — When enabled, completing a deployment will cancel older running or paused deployments to the same project/environment/tenant
  - `ChangeDescription` string — The description for the deployment settings modification.
  - `ConnectivityPolicy` DeploymentConnectivityPolicy
    - `AllowDeploymentsToNoTargets` boolean
    - `ExcludeUnhealthyTargets` boolean
    - `SkipMachineBehavior` 'None' | 'SkipUnavailableMachines'
    - `TargetRoles` string[]
  - `DefaultGuidedFailureMode` 'EnvironmentDefault' | 'Off' | 'On' — The action related to when a deployment error occurs. (IE: Enabling guided failure will pause the deployment failure to allow error correction before proceeding)
  - `DefaultToSkipIfAlreadyInstalled` boolean — If true, and the version of the package being deployed is already present on the machine, its re-deployment will be skipped.
  - `DeploymentChangesTemplate` string — A markdown template generated for each deployment's changes.
  - `FailTargetDiscovery` boolean — Fail cloud discovery steps if no targets found
  - `ForcePackageDownload` boolean — Option to force re-downloading packages for deployment.
  - `ProjectId` string, required — The Project ID to get the deployment settings from. Example `Projects-1`.
  - `ReleaseNotesTemplate` string — 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.
  - `SpaceId` string, required — The ID of the space containing the resource(s).
  - `VersioningStrategy` VersioningStrategyResource
    - `DonorPackage` DeploymentActionPackageResource
      - `DeploymentAction` string — The name or ID of the deployment action
      - `PackageReference` string — The name or ID of the package reference
    - `Template` string

## Response `200`

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

- DeploymentSettingsResource
  - `CancelQueuedTasks` boolean
  - `CancelRunningTasks` boolean
  - `ConnectivityPolicy` DeploymentConnectivityPolicy
    - `AllowDeploymentsToNoTargets` boolean
    - `ExcludeUnhealthyTargets` boolean
    - `SkipMachineBehavior` 'None' | 'SkipUnavailableMachines'
    - `TargetRoles` string[]
  - `DefaultGuidedFailureMode` 'EnvironmentDefault' | 'Off' | 'On'
  - `DefaultToSkipIfAlreadyInstalled` boolean
  - `DeploymentChangesTemplate` string
  - `FailTargetDiscovery` boolean
  - `ForcePackageDownload` boolean
  - `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.
  - `ProjectId` string
  - `ReleaseNotesTemplate` string
  - `SpaceId` string
  - `VersioningStrategy` VersioningStrategyResource
    - `DonorPackage` DeploymentActionPackageResource
      - `DeploymentAction` string — The name or ID of the deployment action
      - `PackageReference` string — The name or ID of the package reference
    - `Template` string

## 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)