DeploymentSettings

Modify deployment settings

Modifies deployment settings for a project.

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

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/projects/{projectId}/{gitRef}/deploymentsettings
  • 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

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

When enabled, creating a new deployment will cancel all previously queued deployments to the same project/environment/tenant

CancelRunningTasksboolean

When enabled, completing a deployment will cancel older running or paused deployments to the same project/environment/tenant

ChangeDescriptionstring

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

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)

DefaultToSkipIfAlreadyInstalledboolean

If true, and the version of the package being deployed is already present on the machine, its re-deployment will be skipped.

DeploymentChangesTemplatestring

A markdown template generated for each deployment's changes.

FailTargetDiscoveryboolean

Option to fail a step if no matching targets found in cloud discovery steps

ForcePackageDownloadboolean

Option to force re-downloading packages for deployment.

GitRefstring required

Git reference to use when modifying deployment settings.

ProjectIdstring required

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

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

The ID of the space containing the resource(s).

Example request

{
  "ProjectId": "Projects-1",
  "SpaceId": "Spaces-1"
}

Response

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

CancelQueuedTasksboolean
CancelRunningTasksboolean
DefaultGuidedFailureMode'EnvironmentDefault' | 'Off' | 'On'
DefaultToSkipIfAlreadyInstalledboolean
DeploymentChangesTemplatestring
FailTargetDiscoveryboolean
ForcePackageDownloadboolean
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.

ProjectIdstring
ReleaseNotesTemplatestring
SpaceIdstring

Example response

{
  "Links": {
    "Self": "/api/..."
  },
  "ProjectId": "Projects-1",
  "SpaceId": "Spaces-1"
}

Changes

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