---
title: "Modifies an existing Project"
method: PUT
path: "/{spaceId}/projects/{projectId}"
tags: ["Projects"]
---

# Modifies an existing Project

`PUT /{spaceId}/projects/{projectId}`

## Path parameters

- `spaceId` string, required
- `projectId` string, required

## Request body

- ModifyProjectCommand
  - `AllowIgnoreChannelRules` boolean
  - `AutoCreateRelease` boolean
  - `AutoDeployReleaseOverrides` AutoDeployReleaseOverrideResource[]
    - `EnvironmentId` string
    - `ReleaseId` string
    - `TenantId` string
  - `ChangeDescription` string
  - `ClonedFromProjectId` string
  - `CombineHealthAndSyncStatusInDashboardLiveStatus` boolean
  - `DefaultGuidedFailureMode` 'EnvironmentDefault' | 'Off' | 'On'
  - `DefaultPowerShellEdition` string — Which edition of PowerShell the project's script steps run under: "Desktop" (Windows PowerShell) or "Core" (cross-platform PowerShell). Leave unset to inherit the server default.
  - `DefaultToSkipIfAlreadyInstalled` boolean
  - `DeploymentChangesTemplate` string
  - `DeprovisioningRunbookId` string — ID of a runbook in this project that tears down an ephemeral environment. Must be an existing runbook of this project; call find_runbooks to look one up. Only relevant to projects using ephemeral environments.
  - `Description` string
  - `DiscreteChannelRelease` boolean
  - `ExecuteDeploymentsOnResilientPipeline` boolean
  - `ExtensionSettings` ExtensionSettingsValues[]
    - `ExtensionId` string
    - `Values` unknown
  - `ForcePackageDownload` boolean
  - `IncludedLibraryVariableSetIds` string[]
  - `IsBadgesEnabled` boolean
  - `IsDisabled` boolean
  - `LifecycleId` string, required
  - `Name` string, required
  - `PersistenceSettings` PersistenceSettingsResource
    - `Type` 'Database' | 'VersionControlled'
  - `ProjectConnectivityPolicy` DeploymentConnectivityPolicy
    - `AllowDeploymentsToNoTargets` boolean
    - `ExcludeUnhealthyTargets` boolean
    - `SkipMachineBehavior` 'None' | 'SkipUnavailableMachines'
    - `TargetRoles` string[]
  - `ProjectGroupId` string, required
  - `ProjectId` string, required
  - `ProjectTags` string[] — The project's complete set of tags, each written as "TagSet/Tag" using either the names or the IDs of the tag set and tag (for example "Regions/us-east"). This replaces the project's current tags, so resubmit the existing ones you want to keep. Call find_tag_sets to discover which tag sets apply to projects.
  - `ProvisioningRunbookId` string — ID of a runbook in this project that provisions an ephemeral environment. Must be an existing runbook of this project; call find_runbooks to look one up. Only relevant to projects using ephemeral environments.
  - `ReleaseCreationStrategy` ReleaseCreationStrategyResource
    - `ChannelId` string
    - `ReleaseCreationPackage` DeploymentActionPackageResource
      - `DeploymentAction` string
      - `PackageReference` string
  - `ReleaseNotesTemplate` string
  - `Slug` string — URL-friendly short identifier for the project, unique within the space. Leave unset to keep the project's current slug.
  - `SpaceId` string, required
  - `Templates` ActionTemplateParameterResource[]
    - `DefaultValue` PropertyValueResource
      - `IsSensitive` boolean
      - `SensitiveValue` SensitiveValue
        - `HasValue` boolean
        - `Hint` string
        - `NewValue` string
      - `Value` string
    - `DisplaySettings` object
    - `HelpText` string
    - `Id` string
    - `Label` string
    - `Name` string
  - `TenantedDeploymentMode` 'Untenanted' | 'TenantedOrUntenanted' | 'Tenanted'
  - `VersioningStrategy` VersioningStrategyResource
    - `DonorPackage` DeploymentActionPackageResource
      - `DeploymentAction` string
      - `PackageReference` string
    - `Template` string

## Response `200`

Confirms that the Project has been modified, containing the updated Project

- ProjectResource
  - `AllowIgnoreChannelRules` boolean
  - `AutoCreateRelease` boolean
  - `AutoDeployReleaseOverrides` AutoDeployReleaseOverrideResource[]
    - `EnvironmentId` string
    - `ReleaseId` string
    - `TenantId` string
  - `ClonedFromProjectId` string
  - `CombineHealthAndSyncStatusInDashboardLiveStatus` boolean
  - `DefaultGuidedFailureMode` 'EnvironmentDefault' | 'Off' | 'On'
  - `DefaultPowerShellEdition` string
  - `DefaultToSkipIfAlreadyInstalled` boolean
  - `DeploymentChangesTemplate` string
  - `DeploymentProcessId` string
  - `DeprovisioningRunbookId` string
  - `Description` string
  - `DiscreteChannelRelease` boolean
  - `ExecuteDeploymentsOnResilientPipeline` boolean
  - `ExtensionSettings` ExtensionSettingsValues[]
    - `ExtensionId` string
    - `Values` unknown
  - `ForcePackageDownload` boolean
  - `Icon` IconResource
    - `Color` string
    - `Id` string
  - `Id` string
  - `IncludedLibraryVariableSetIds` string[]
  - `IsBadgesEnabled` boolean
  - `IsDisabled` boolean
  - `IsVersionControlled` boolean
  - `LastModifiedBy` string
  - `LastModifiedOn` string, date-time
  - `LifecycleId` string
  - `Links` object
  - `Name` string
  - `PersistenceSettings` PersistenceSettingsResource
    - `Type` 'Database' | 'VersionControlled'
  - `ProjectConnectivityPolicy` DeploymentConnectivityPolicy
    - `AllowDeploymentsToNoTargets` boolean
    - `ExcludeUnhealthyTargets` boolean
    - `SkipMachineBehavior` 'None' | 'SkipUnavailableMachines'
    - `TargetRoles` string[]
  - `ProjectGroupId` string
  - `ProjectTags` string[]
  - `ProjectTemplateDetails` ProjectTemplateDetailsResource
    - `IsShared` boolean
    - `Slug` string, required
    - `VersionMask` string, required
  - `ProvisioningRunbookId` string
  - `ReleaseCreationStrategy` ReleaseCreationStrategyResource
    - `ChannelId` string
    - `ReleaseCreationPackage` DeploymentActionPackageResource
      - `DeploymentAction` string
      - `PackageReference` string
  - `ReleaseNotesTemplate` string
  - `Slug` string
  - `SpaceId` string
  - `Templates` ActionTemplateParameterResource[]
    - `DefaultValue` PropertyValueResource
      - `IsSensitive` boolean
      - `SensitiveValue` SensitiveValue
        - `HasValue` boolean
        - `Hint` string
        - `NewValue` string
      - `Value` string
    - `DisplaySettings` object
    - `HelpText` string
    - `Id` string
    - `Label` string
    - `Name` string
  - `TenantedDeploymentMode` 'Untenanted' | 'TenantedOrUntenanted' | 'Tenanted'
  - `VariableSetId` string
  - `VersioningStrategy` VersioningStrategyResource
    - `DonorPackage` DeploymentActionPackageResource
      - `DeploymentAction` string
      - `PackageReference` string
    - `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/versions/bc9158facfc7/schema)