/
OC
octopus
Search skmtc…
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
AccessTokens
1
Accounts
41
ActionTemplates
57
ApiKeys
5
Artifacts
21
AuditStream
2
Authentication
2
AzureDevOps
1
Branches
21
BuildInformation
15
Capabilities
2
Certificates
49
Channels
52
CloudTemplate
1
CommunityActionTemplates
9
CompliancePolicies
8
Configuration
5
ConnectionAgents
9
Dashboard
6
DashboardConfiguration
6
DeploymentFreeze
8
DeploymentProcesses
40
Deployments
19
DeploymentSettings
18
DeploymentTargets
47
DeploymentTargetTags
12
Deprecations
2
DirectoryServices
2
DynamicExtensions
3
Environments
53
EphemeralEnvironments
16
EventRetention
5
Events
18
ExternalSecurityGroupProviders
1
FeatureFlags
22
FeaturesConfiguration
2
FeatureToggles
8
Feeds
27
GitHub
34
Home
2
Icons
7
Insights
43
IntegratedAuthentication
1
Interruptions
15
Invitations
6
JiraIntegration
2
JsonWebKeys
1
LDAP
2
LetsEncrypt
2
LibraryVariableSets
27
Licenses
5
Lifecycles
27
MachinePolicies
30
MachineRoles
6
Machines
3
MaintenanceConfiguration
3
Migrations
2
Nuget
2
Observability
32
OctopusServerNodes
8
OpenIdConnect
1
OpenIDConnect
15
OpenTelemetry
2
Packages
42
ParentEnvironments
8
Performance
2
Permissions
1
PlatformHub
47
ProcessTemplates
14
Progression
18
ProjectGroups
21
Projects
62
ProjectTemplates
1
ProjectTriggers
30
Proxies
18
RateLimiting
3
Releases
68
get
/channels/{id}/releases
List all of the releases that belong to the given Channel.
get
/projects/{projectId}/channels/{id}/releases
List all of the releases that belong to the given Channel.
get
/projects/{projectId}/releases
List all of the releases that belong to the given Project.
get
/projects/{projectId}/releases/{id}/variables
Get 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
/releases
Get a list of Releases for the given Space.
post
/releases
Create a Release
post
/releases/create/v1
Create 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/template
Get all of the information necessary for creating or editing a deployment for this release.
get
/releases/{releaseId}/defects
Get all defects for a release.
post
/releases/{releaseId}/defects
Record defect in a release.
post
/releases/{releaseId}/defects/resolve
Resolve defect in a release.
get
/releases/{releaseId}/deployments
List 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/previews
Return 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}/progression
Get all of the information necessary for creating or editing a deployment for this release.
post
/releases/{releaseId}/release-notes
Update the release notes on an existing Release.
post
/releases/{releaseId}/snapshot-variables
Update the Variable Snapshot for a Release
get
/{spaceId}/channels/{id}/releases
List all of the releases that belong to the given Channel.
get
/{spaceId}/projects/{projectId}/channels/{id}/releases
List all of the releases that belong to the given Channel.
get
/{spaceId}/projects/{projectId}/releases
List all of the releases that belong to the given Project.
get
/{spaceId}/projects/{projectId}/releases/{id}/variables
Get 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}/releases
Get a list of Releases for the given Space.
post
/{spaceId}/releases
Create a Release
post
/{spaceId}/releases/create/v1
Create 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/template
Get all of the information necessary for creating or editing a deployment for this release.
get
/{spaceId}/releases/{releaseId}/defects
Get all defects for a release.
post
/{spaceId}/releases/{releaseId}/defects
Record defect in a release.
post
/{spaceId}/releases/{releaseId}/defects/resolve
Resolve defect in a release.
get
/{spaceId}/releases/{releaseId}/deployments
List 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/previews
Return 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}/missingPackages
Get the list of Packages that are missing from the built-in feed for a release
get
/{spaceId}/releases/{releaseId}/progression
Get all of the information necessary for creating or editing a deployment for this release.
post
/{spaceId}/releases/{releaseId}/release-notes
Update the release notes on an existing Release.
post
/{spaceId}/releases/{releaseId}/snapshot-variables
Update the Variable Snapshot for a Release
get
/spaces/{spaceIdentifier}/channels/{id}/releases
List all of the releases that belong to the given Channel.
get
/spaces/{spaceIdentifier}/projects/{projectId}/channels/{id}/releases
List all of the releases that belong to the given Channel.
get
/spaces/{spaceIdentifier}/projects/{projectId}/releases
List all of the releases that belong to the given Project.
get
/spaces/{spaceIdentifier}/projects/{projectId}/releases/{id}/variables
Get 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}/releases
Get a list of Releases for the given Space.
post
/spaces/{spaceIdentifier}/releases
Create a Release
post
/spaces/{spaceIdentifier}/releases/create/v1
Create 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/template
Get all of the information necessary for creating or editing a deployment for this release.
get
/spaces/{spaceIdentifier}/releases/{releaseId}/defects
Get all defects for a release.
post
/spaces/{spaceIdentifier}/releases/{releaseId}/defects
Record defect in a release.
post
/spaces/{spaceIdentifier}/releases/{releaseId}/defects/resolve
Resolve defect in a release.
get
/spaces/{spaceIdentifier}/releases/{releaseId}/deployments
List 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/previews
Return 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}/missingPackages
Get the list of Packages that are missing from the built-in feed for a release
get
/spaces/{spaceIdentifier}/releases/{releaseId}/progression
Get all of the information necessary for creating or editing a deployment for this release.
post
/spaces/{spaceIdentifier}/releases/{releaseId}/release-notes
Update the release notes on an existing Release.
post
/spaces/{spaceIdentifier}/releases/{releaseId}/snapshot-variables
Update the Variable Snapshot for a Release
Reporting
3
Retention
8
RolloutGroups
10
RunbookProcesses
30
RunbookRuns
33
Runbooks
115
RunbookSnapshots
77
ScheduledJobs
3
ScopedUserRoles
15
Server
3
ServerStatus
10
ServiceAccountOidcIdentities
5
Signing
5
SlackIntegration
9
Smtp
5
Spaces
49
SshKnownHosts
3
Subscriptions
18
TagSets
21
Tasks
39
TeamMemberships
9
Teams
21
TeamsIntegration
10
Telemetry
4
Tenants
66
TokenExchange
1
Upgrade
2
UserPermissions
9
UserRoles
6
Users
18
Variables
27
VersionControl
2
Web
2
WorkerPools
33
Workers
33
WorkerTaskLeases
2
Releases
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Update the release notes on an existing Release.
post
/spaces/{spaceIdentifier}/releases/{releaseId}/release-notes
Aug 14, 2026
dbbd6d1e3f1c
Revision changes
info
endpoint added