---
title: "Creates a new project."
method: POST
path: "/projects"
tags: ["Projects"]
---

# Creates a new project.

`POST /projects`

## Request body

- CreateProjectCommand
  - `AllowIgnoreChannelRules` boolean
  - `AutoCreateRelease` boolean
  - `AutoDeployReleaseOverrides` AutoDeployReleaseOverrideResource[]
    - `EnvironmentId` string
    - `ReleaseId` string
    - `TenantId` string
  - `Clone` string — ID of an existing project in the same space whose configuration (deployment process, variables, channels, runbooks, triggers) is copied into the new project. The source project must store its configuration in the database, not Git.
  - `CombineHealthAndSyncStatusInDashboardLiveStatus` boolean
  - `DefaultGuidedFailureMode` 'EnvironmentDefault' | 'Off' | 'On'
  - `DefaultToSkipIfAlreadyInstalled` boolean
  - `DeploymentChangesTemplate` string
  - `Description` string
  - `DiscreteChannelRelease` boolean
  - `ExecuteDeploymentsOnResilientPipeline` boolean
  - `ExtensionSettings` ExtensionSettingsValues[]
    - `ExtensionId` string
    - `Values` unknown
  - `ForcePackageDownload` boolean
  - `IncludedLibraryVariableSetIds` string[]
  - `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
  - `ProjectTags` string[] — Tags to apply to the project, each written as "TagSet/Tag" using either the names or the IDs of the tag set and tag (for example "Regions/us-east"). Call find_tag_sets to discover which tag sets apply to projects and what tags they contain.
  - `ReleaseCreationStrategy` ReleaseCreationStrategyResource
    - `ChannelId` string
    - `ReleaseCreationPackage` DeploymentActionPackageResource
      - `DeploymentAction` string
      - `PackageReference` string
  - `ReleaseNotesTemplate` string
  - `RetainTenantConnections` boolean
  - `Slug` string — URL-friendly short identifier for the project, unique within the space (for example "web-store"). Leave unset to have one generated from the name.
  - `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 `201`

Created

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