/

Docs
History
Schema
Generate

Filter operations

AccessTokens1

Accounts41

ActionTemplates57

ApiKeys5

Artifacts21

AuditStream2

Authentication2

AzureDevOps1

Branches21

BuildInformation15

Capabilities2

Certificates49

Channels52

CloudTemplate1

CommunityActionTemplates9

CompliancePolicies8

Configuration5

ConnectionAgents9

Dashboard6

DashboardConfiguration6

DeploymentFreeze8

DeploymentProcesses40

Deployments19

DeploymentSettings18

DeploymentTargets47

DeploymentTargetTags12

Deprecations2

DirectoryServices2

DynamicExtensions3

Environments53

EphemeralEnvironments16

EventRetention5

Events18

ExternalSecurityGroupProviders1

FeatureFlags22

FeaturesConfiguration2

FeatureToggles8

Feeds27

GitHub34

Home2

Icons7

Insights43

IntegratedAuthentication1

Interruptions15

Invitations6

JiraIntegration2

JsonWebKeys1

LDAP2

LetsEncrypt2

LibraryVariableSets27

Licenses5

Lifecycles27

MachinePolicies30

MachineRoles6

Machines3

MaintenanceConfiguration3

Migrations2

Nuget2

Observability32

OctopusServerNodes8

OpenIdConnect1

OpenIDConnect15

OpenTelemetry2

Packages42

ParentEnvironments8

Performance2

Permissions1

PlatformHub47

ProcessTemplates14

Progression18

ProjectGroups21

Projects62

ProjectTemplates1

ProjectTriggers30

Proxies18

RateLimiting3

Releases68

get/channels/{id}/releasesList all of the releases that belong to the given Channel.
get/projects/{projectId}/channels/{id}/releasesList all of the releases that belong to the given Channel.
get/projects/{projectId}/releasesList all of the releases that belong to the given Project.
get/projects/{projectId}/releases/{id}/variablesGet a list of Variable Sets included in the Release's current Variable Snapshot
get/projects/{projectId}/releases/{version}Get a single release by project ID and version number.
get/releasesGet a list of Releases for the given Space.
post/releasesCreate a Release
post/releases/create/v1Create a Release
get/releases/{id}Get a Release by ID
put/releases/{id}Update an existing Release
delete/releases/{id}Delete an existing release, along with all of the deployments, tasks and other associated resources belonging to the release.
get/releases/{id}/deployments/templateGet all of the information necessary for creating or editing a deployment for this release.
get/releases/{releaseId}/defectsGet all defects for a release.
post/releases/{releaseId}/defectsRecord defect in a release.
post/releases/{releaseId}/defects/resolveResolve defect in a release.
get/releases/{releaseId}/deploymentsList all of the Deployments that belong to the given Release.
get/releases/{releaseId}/deployments/preview/{environmentId}Get a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).
get/releases/{releaseId}/deployments/preview/{environmentId}/{tenantId}Get a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).
post/releases/{releaseId}/deployments/previewsReturn an array of documents that describes what steps will/won't be run during deployments to a given set of environments and tenants.
get/releases/{releaseId}/progressionGet all of the information necessary for creating or editing a deployment for this release.
post/releases/{releaseId}/release-notesUpdate the release notes on an existing Release.
post/releases/{releaseId}/snapshot-variablesUpdate the Variable Snapshot for a Release
get/{spaceId}/channels/{id}/releasesList all of the releases that belong to the given Channel.
get/{spaceId}/projects/{projectId}/channels/{id}/releasesList all of the releases that belong to the given Channel.
get/{spaceId}/projects/{projectId}/releasesList all of the releases that belong to the given Project.
get/{spaceId}/projects/{projectId}/releases/{id}/variablesGet a list of Variable Sets included in the Release's current Variable Snapshot
get/{spaceId}/projects/{projectId}/releases/{version}Get a single release by project ID and version number.
get/{spaceId}/releasesGet a list of Releases for the given Space.
post/{spaceId}/releasesCreate a Release
post/{spaceId}/releases/create/v1Create a Release
get/{spaceId}/releases/{id}Get a Release by ID
put/{spaceId}/releases/{id}Update an existing Release
delete/{spaceId}/releases/{id}Delete an existing release, along with all of the deployments, tasks and other associated resources belonging to the release.
get/{spaceId}/releases/{id}/deployments/templateGet all of the information necessary for creating or editing a deployment for this release.
get/{spaceId}/releases/{releaseId}/defectsGet all defects for a release.
post/{spaceId}/releases/{releaseId}/defectsRecord defect in a release.
post/{spaceId}/releases/{releaseId}/defects/resolveResolve defect in a release.
get/{spaceId}/releases/{releaseId}/deploymentsList all of the Deployments that belong to the given Release.
get/{spaceId}/releases/{releaseId}/deployments/preview/{environmentId}Get a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).
get/{spaceId}/releases/{releaseId}/deployments/preview/{environmentId}/{tenantId}Get a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).
post/{spaceId}/releases/{releaseId}/deployments/previewsReturn an array of documents that describes what steps will/won't be run during deployments to a given set of environments and tenants.
get/{spaceId}/releases/{releaseId}/missingPackagesGet the list of Packages that are missing from the built-in feed for a release
get/{spaceId}/releases/{releaseId}/progressionGet all of the information necessary for creating or editing a deployment for this release.
post/{spaceId}/releases/{releaseId}/release-notesUpdate the release notes on an existing Release.
post/{spaceId}/releases/{releaseId}/snapshot-variablesUpdate the Variable Snapshot for a Release
get/spaces/{spaceIdentifier}/channels/{id}/releasesList all of the releases that belong to the given Channel.
get/spaces/{spaceIdentifier}/projects/{projectId}/channels/{id}/releasesList all of the releases that belong to the given Channel.
get/spaces/{spaceIdentifier}/projects/{projectId}/releasesList all of the releases that belong to the given Project.
get/spaces/{spaceIdentifier}/projects/{projectId}/releases/{id}/variablesGet a list of Variable Sets included in the Release's current Variable Snapshot
get/spaces/{spaceIdentifier}/projects/{projectId}/releases/{version}Get a single release by project ID and version number.
get/spaces/{spaceIdentifier}/releasesGet a list of Releases for the given Space.
post/spaces/{spaceIdentifier}/releasesCreate a Release
post/spaces/{spaceIdentifier}/releases/create/v1Create a Release
get/spaces/{spaceIdentifier}/releases/{id}Get a Release by ID
put/spaces/{spaceIdentifier}/releases/{id}Update an existing Release
delete/spaces/{spaceIdentifier}/releases/{id}Delete an existing release, along with all of the deployments, tasks and other associated resources belonging to the release.
get/spaces/{spaceIdentifier}/releases/{id}/deployments/templateGet all of the information necessary for creating or editing a deployment for this release.
get/spaces/{spaceIdentifier}/releases/{releaseId}/defectsGet all defects for a release.
post/spaces/{spaceIdentifier}/releases/{releaseId}/defectsRecord defect in a release.
post/spaces/{spaceIdentifier}/releases/{releaseId}/defects/resolveResolve defect in a release.
get/spaces/{spaceIdentifier}/releases/{releaseId}/deploymentsList all of the Deployments that belong to the given Release.
get/spaces/{spaceIdentifier}/releases/{releaseId}/deployments/preview/{environmentId}Get a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).
get/spaces/{spaceIdentifier}/releases/{releaseId}/deployments/preview/{environmentId}/{tenantId}Get a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).
post/spaces/{spaceIdentifier}/releases/{releaseId}/deployments/previewsReturn an array of documents that describes what steps will/won't be run during deployments to a given set of environments and tenants.
get/spaces/{spaceIdentifier}/releases/{releaseId}/missingPackagesGet the list of Packages that are missing from the built-in feed for a release
get/spaces/{spaceIdentifier}/releases/{releaseId}/progressionGet all of the information necessary for creating or editing a deployment for this release.
post/spaces/{spaceIdentifier}/releases/{releaseId}/release-notesUpdate the release notes on an existing Release.
post/spaces/{spaceIdentifier}/releases/{releaseId}/snapshot-variablesUpdate the Variable Snapshot for a Release

Reporting3

Retention8

RolloutGroups10

RunbookProcesses30

RunbookRuns33

Runbooks115

RunbookSnapshots77

ScheduledJobs3

ScopedUserRoles15

Server3

ServerStatus10

ServiceAccountOidcIdentities5

Signing5

SlackIntegration9

Smtp5

Spaces49

SshKnownHosts3

Subscriptions18

TagSets21

Tasks39

TeamMemberships9

Teams21

TeamsIntegration10

Telemetry4

Tenants66

TokenExchange1

Upgrade2

UserPermissions9

UserRoles6

Users18

Variables27

VersionControl2

Web2

WorkerPools33

Workers33

WorkerTaskLeases2

Releases

Changes to Update the release notes on an existing Release.

post/{spaceId}/releases/{releaseId}/release-notes

Aug 14, 2026dbbd6d1e3f1c Revision changes
- info
  endpoint added