Projects

Create a new project.

post/projects

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/projects
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Request body

AllowIgnoreChannelRulesboolean
AutoCreateReleaseboolean
Clonestring

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.

CombineHealthAndSyncStatusInDashboardLiveStatusboolean
DefaultGuidedFailureMode'EnvironmentDefault' | 'Off' | 'On'
DefaultToSkipIfAlreadyInstalledboolean
DeploymentChangesTemplatestring
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
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.

IsDisabledboolean
LifecycleIdstring

Required for non-templated projects. Templated projects source their lifecycle from the project template.

Namestring required
ProjectGroupIdstring required
ProjectTagsstring[]

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"). Find the tag sets first to discover which ones apply to projects and what tags they contain.

ReleaseNotesTemplatestring
RetainTenantConnectionsboolean

When cloning, copy the source project's tenant connections to the new project. Only honoured when Clone is set. Defaults to false.

Slugstring

URL-friendly short identifier for the project, unique within the space (for example "web-store"). Leave unset to have one generated from the name.

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

Example request

{
  "AutoDeployReleaseOverrides": [
    {
      "EnvironmentId": "Environments-1",
      "ReleaseId": "Releases-1",
      "TenantId": "Tenants-1"
    }
  ],
  "Clone": "Projects-1",
  "ExtensionSettings": [],
  "LifecycleId": "Lifecycles-1",
  "ProjectGroupId": "ProjectGroups-1",
  "SpaceId": "Spaces-1"
}

Response

Created

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": [
    {
      "EnvironmentId": "Environments-1",
      "ReleaseId": "Releases-1",
      "TenantId": "Tenants-1"
    }
  ],
  "ClonedFromProjectId": "Projects-1",
  "DeploymentProcessId": "deploymentprocess-Projects-1",
  "DeprovisioningRunbookId": "Runbooks-1",
  "ExtensionSettings": [],
  "Icon": {
    "Color": "#3CA4F3",
    "Id": "rocket"
  },
  "IncludedLibraryVariableSetIds": [
    "LibraryVariableSets-1"
  ],
  "Links": {
    "Self": "/api/..."
  },
  "ProjectGroupId": "ProjectGroups-1",
  "ProvisioningRunbookId": "Runbooks-1",
  "SpaceId": "Spaces-1",
  "VariableSetId": "variableset-Projects-1"
}

Changes

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