Sign in
Projects

Modify an existing Project

put/projects/{projectId}

Path parameters

projectIdstring required

ID of the project to modify

Request body

AllowIgnoreChannelRulesboolean
AutoCreateReleaseboolean
ChangeDescriptionstring

The change description

ClonedFromProjectIdstring
CombineHealthAndSyncStatusInDashboardLiveStatusboolean
DefaultGuidedFailureMode'EnvironmentDefault' | 'Off' | 'On'
DefaultPowerShellEditionstring

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.

DefaultToSkipIfAlreadyInstalledboolean
DeploymentChangesTemplatestring
DeprovisioningRunbookIdstring

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.

Descriptionstring
DiscreteChannelReleaseboolean

Treats releases of different channels to the same environment as a separate deployment dimension. 'False' indicates a "hotfix"-style usage of channels (single release active per environment ignoring channels), whereas True indicates "microservice"-style usage (single release per environment per channel)

ExecuteDeploymentsOnEventBasedPipelineboolean
ForcePackageDownloadboolean
IncludedLibraryVariableSetIdsstring[]

Library variable sets included in the project. Sets are listed in order of precedence, with earlier items in the list overriding any variables with the same name and scope definition appearing later in the list.

IsBadgesEnabledboolean
IsDisabledboolean
LifecycleIdstring required
Namestring required
ProjectGroupIdstring required
ProjectIdstring required

ID of the project to modify

ProjectTagsstring[]

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.

ProvisioningRunbookIdstring

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.

ReleaseNotesTemplatestring
Slugstring

URL-friendly short identifier for the project, unique within the space. Leave unset to keep the project's current slug.

SpaceIdstring required
TenantedDeploymentMode'Untenanted' | 'TenantedOrUntenanted' | 'Tenanted'

Example request

{
  "AutoDeployReleaseOverrides": [
    {
      "TenantId": "Tenants-1"
    }
  ],
  "ClonedFromProjectId": "Projects-1",
  "DeprovisioningRunbookId": "Runbooks-1",
  "LifecycleId": "Lifecycles-1",
  "ProjectGroupId": "ProjectGroups-1",
  "ProjectId": "Projects-1",
  "ProvisioningRunbookId": "Runbooks-1",
  "SpaceId": "Spaces-1"
}

Response

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

AllowIgnoreChannelRulesboolean
AutoCreateReleaseboolean
ClonedFromProjectIdstring
CombineHealthAndSyncStatusInDashboardLiveStatusboolean
DefaultGuidedFailureMode'EnvironmentDefault' | 'Off' | 'On'
DefaultPowerShellEditionstring
DefaultToSkipIfAlreadyInstalledboolean
DeploymentChangesTemplatestring
DeploymentProcessIdstring
DeprovisioningRunbookIdstring
Descriptionstring
DiscreteChannelReleaseboolean

Treats releases of different channels to the same environment as a seperate deployment dimension. 'False' indicates a "hotfix"-style usage of channels (single release active per environment ignoring channels), whereas True indicates "microservice"-style usage (single release per environment per channel)

ExecuteDeploymentsOnEventBasedPipelineboolean
ForcePackageDownloadboolean
Idstring

Gets or sets a unique identifier for this resource.

IncludedLibraryVariableSetIdsstring[]

Library variable sets included in the project. Sets are listed in order of precedence, with earlier items in the list overriding any variables with the same name and scope definition appearing later in the list.

IsBadgesEnabledboolean
IsDisabledboolean
IsVersionControlledboolean
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.

LifecycleIdstring
Linksobject

Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.

Namestring
ProjectGroupIdstring
ProjectTagsstring[]

List of tags assigned to this project

ProvisioningRunbookIdstring
ReleaseNotesTemplatestring
Slugstring
SpaceIdstring
TenantedDeploymentMode'Untenanted' | 'TenantedOrUntenanted' | 'Tenanted'
VariableSetIdstring

Example response

{
  "AutoDeployReleaseOverrides": [
    {
      "TenantId": "Tenants-1"
    }
  ],
  "ClonedFromProjectId": "Projects-1",
  "DeprovisioningRunbookId": "Runbooks-1",
  "ProvisioningRunbookId": "Runbooks-1",
  "SpaceId": "Spaces-1"
}

Changes