Releases

Create a Release

post/{spaceId}/releases/create/v1

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/{spaceId}/releases/create/v1
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Path parameters

spaceIdstring required

Request body

ChannelNamestring

Name of the channel to use for the new release. Omit this argument to automatically select the best channel.

CustomFieldsobject

Values for the project's custom release fields, if it defines any, keyed by field name.

GitCommitstring

Only set alongside GitRef, when a specific commit is needed; GitRef alone uses the tip of that ref.

GitRefstring

The Git branch, tag or commit to snapshot the deployment process from. Required for a project that stores its configuration in Git, and must be left unset for one stored in the database — the command fails either way round. Find the project's branches first when you need a branch reference.

GitResourcesstring[]

Git ref to use for a git resource in the release. Format: StepName:GitRef or StepName:GitResourceName:GitRef. If the GitResourceName is omitted, it's assumed to be the primary git resource for the step. The GitRef can be replaced with an asterisk. An asterisk will use the tip ref of the step-defined default branch.

IgnoreChannelRulesboolean

Create the release even when a package version, or the Git reference, violates the channel's version rules. This overrides a deliberate guardrail, so prefer correcting the versions or letting Octopus select the channel; only set it when explicitly asked to.

IgnoreIfAlreadyExistsboolean

If a release with the same version number already exists, return that one instead of failing — so the returned ReleaseId may be an existing release rather than a newly created one.

PackagePrereleasestring

Restrict automatic version selection to pre-release versions carrying this tag, for example "beta". Ignored for steps whose version is pinned by PackageVersion or Packages.

Packagesstring[]

Version number to use for a package in the release. Format: StepName:Version or PackageID:Version or StepName:PackageName:Version. StepName, PackageID, and PackageName can be replaced with an asterisk. An asterisk will be assumed for StepName, PackageID, or PackageName if they are omitted.

PackageVersionstring

One version to use for every package step. Leave unset to take the latest version of each package; use Packages instead to pin versions per step.

ProjectNamestring required
ReleaseNotesstring

Release Notes for the new release. Styling with Markdown is supported.

ReleaseVersionstring

Leave unset to let Octopus pick the next version from the project's versioning strategy, which is usually what you want.

SpaceIdstring required
SpaceIdOrNamestring required

Both this and SpaceId are required, and normally hold the same space ID; set both.

Example request

{
  "SpaceId": "Spaces-1"
}

Response

Created

ReleaseIdstring required
ReleaseVersionstring required

Example response

{
  "ReleaseId": "Releases-1"
}

Changes

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