Releases

Update the release notes on an existing Release.

Changed on

Only the release notes are changed and everything else about the Release is left alone. Variable expressions in the notes are evaluated before they are stored, so the saved text is the resolved one.

post/releases/{releaseId}/release-notes

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/releases/{releaseId}/release-notes
  • 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

releaseIdstring required

Id of the release

Request body

ReleaseIdstring required

The ID of the release, for example 'Releases-123'.

ReleaseNotesstring required

The notes to store, replacing whatever the release currently has. Markdown is supported. Build information is in scope, so expressions such as #{Octopus.Release.WorkItems} and #{Octopus.Release.Number} are resolved before the notes are saved. Send an empty string to clear them.

SpaceIdstring required

The ID of the space containing the resource(s)

Example request

{
  "ReleaseId": "Releases-1",
  "SpaceId": "Spaces-1"
}

Response

Confirmation that the release notes were updated, containing the updated Release

Assembledstring date-time
ChannelIdstring
CustomFieldsobject
Idstring

Gets or sets a unique identifier for this resource.

IgnoreChannelRulesboolean
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.

LibraryVariableSetSnapshotIdsstring[]

Snapshots of the project's included library variable sets. The snapshots are VariableSetResources, not LibraryVariableSetResources.

Linksobject

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

ProjectDeploymentProcessSnapshotIdstring
ProjectIdstring
ProjectVariableSetSnapshotIdstring
ReleaseNotesstring
SpaceIdstring
VariableSnapshotConcurrencyTokenstring

Identifies the release's current variable snapshots.

Versionstring required

Example response

{
  "ChannelId": "Channels-1",
  "Id": "Releases-1",
  "Links": {
    "Self": "/api/..."
  },
  "ProjectId": "Projects-1",
  "SpaceId": "Spaces-1"
}

Changes