v1

latestSwagger 2.02026-08-061,9128853.7 MB
Projects

Modifies an existing Project

put/spaces/{spaceIdentifier}/projects/{projectId}

Path parameters

spaceIdentifierstring required

Identifier (ID or slug) of the space

projectIdstring required

ID of the project to modify

Request body

AllowIgnoreChannelRulesboolean
AutoCreateReleaseboolean
ChangeDescriptionstring
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
ExecuteDeploymentsOnResilientPipelineboolean
ForcePackageDownloadboolean
IncludedLibraryVariableSetIdsstring[]
IsBadgesEnabledboolean
IsDisabledboolean
LifecycleIdstring required
Namestring required
ProjectGroupIdstring required
ProjectIdstring required
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'

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
ExecuteDeploymentsOnResilientPipelineboolean
ForcePackageDownloadboolean
Idstring
IncludedLibraryVariableSetIdsstring[]
IsBadgesEnabledboolean
IsDisabledboolean
IsVersionControlledboolean
LastModifiedBystring
LastModifiedOnstring date-time
LifecycleIdstring
Linksobject
Namestring
ProjectGroupIdstring
ProjectTagsstring[]
ProvisioningRunbookIdstring
ReleaseNotesTemplatestring
Slugstring
SpaceIdstring
TenantedDeploymentMode'Untenanted' | 'TenantedOrUntenanted' | 'Tenanted'
VariableSetIdstring