/
OC
octopus
/
Octopus Server API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 3h ago · Updated 4d ago
View markdown
AccessTokens
1
Accounts
41
ActionTemplates
57
ApiKeys
5
ApprovalPolicies
10
Approvals
8
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
45
DeploymentTargetTags
12
Deprecations
2
DirectoryServices
2
DynamicExtensions
3
Environments
47
EphemeralEnvironments
16
EventRetention
5
Events
18
ExternalSecurityGroupProviders
1
FeaturesConfiguration
2
FeatureToggles
14
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
46
ProcessTemplates
14
Progression
18
ProjectGroups
21
Projects
62
ProjectTemplates
1
ProjectTriggers
30
Proxies
18
RateLimiting
3
Releases
65
get
Lists all of the releases that belong to the given Channel.
get
Lists all of the releases that belong to the given Channel.
get
Lists all of the releases that belong to the given Project.
get
Get a list of Variable Sets included in the Release's current Variable Snapshot
get
Gets a single release by project ID and version number.
get
Get a list of Releases for the given Space.
post
Create a Release
post
Creates a Release
get
Get a Release by ID
put
Updates an existing Release
delete
Deletes an existing release, along with all of the deployments, tasks and other associated resources belonging to the release.
get
Gets all of the information necessary for creating or editing a deployment for this release.
get
Gets all defects for a release.
post
Record defect in a release.
post
Resolve defect in a release.
get
Lists all of the Deployments that belong to the given Release.
get
Gets a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).
get
Gets a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).
post
Returns an array of documents that describes what steps will/won't be run during deployments to a given set of environments and tenants.
get
Gets all of the information necessary for creating or editing a deployment for this release.
post
Updates the Variable Snapshot for a Release
get
Lists all of the releases that belong to the given Channel.
get
Lists all of the releases that belong to the given Channel.
get
Lists all of the releases that belong to the given Project.
get
Get a list of Variable Sets included in the Release's current Variable Snapshot
get
Gets a single release by project ID and version number.
get
Get a list of Releases for the given Space.
post
Create a Release
post
Creates a Release
get
Get a Release by ID
put
Updates an existing Release
delete
Deletes an existing release, along with all of the deployments, tasks and other associated resources belonging to the release.
get
Gets all of the information necessary for creating or editing a deployment for this release.
get
Gets all defects for a release.
post
Record defect in a release.
post
Resolve defect in a release.
get
Lists all of the Deployments that belong to the given Release.
get
Gets a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).
get
Gets a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).
post
Returns an array of documents that describes what steps will/won't be run during deployments to a given set of environments and tenants.
get
Gets the list of Packages that are missing from the built-in feed for a release
get
Gets all of the information necessary for creating or editing a deployment for this release.
post
Updates the Variable Snapshot for a Release
get
Lists all of the releases that belong to the given Channel.
get
Lists all of the releases that belong to the given Channel.
get
Lists all of the releases that belong to the given Project.
get
Get a list of Variable Sets included in the Release's current Variable Snapshot
get
Gets a single release by project ID and version number.
get
Get a list of Releases for the given Space.
post
Create a Release
post
Creates a Release
get
Get a Release by ID
put
Updates an existing Release
delete
Deletes an existing release, along with all of the deployments, tasks and other associated resources belonging to the release.
get
Gets all of the information necessary for creating or editing a deployment for this release.
get
Gets all defects for a release.
post
Record defect in a release.
post
Resolve defect in a release.
get
Lists all of the Deployments that belong to the given Release.
get
Gets a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).
get
Gets a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).
post
Returns an array of documents that describes what steps will/won't be run during deployments to a given set of environments and tenants.
get
Gets the list of Packages that are missing from the built-in feed for a release
get
Gets all of the information necessary for creating or editing a deployment for this release.
post
Updates the Variable Snapshot for a Release
Reporting
3
Retention
8
RolloutGroups
10
RunbookProcesses
30
RunbookRuns
33
Runbooks
115
RunbookSnapshots
77
ScheduledJobs
6
ScopedUserRoles
15
Server
3
ServerStatus
9
ServerTaskApprovals
6
ServiceAccountOidcIdentities
5
Signing
5
SlackIntegration
8
Smtp
5
Spaces
49
SshKnownHosts
3
Subscriptions
18
TagSets
21
Tasks
36
TeamMemberships
9
Teams
21
Telemetry
4
Tenants
66
TokenExchange
1
Upgrade
2
UserPermissions
9
UserRoles
6
Users
15
Variables
27
VersionControl
2
Web
2
WorkerPools
33
Workers
33
WorkerTaskLeases
2
Releases
Create a Release
post
/{spaceId}/releases
Path parameters
spaceId
string
required
Request body
CreateReleaseCommand
required
Assembled
string
date-time
ChannelId
string
CustomFields
object
IgnoreChannelRules
boolean
ProjectId
string
required
ReleaseNotes
string
SelectedGitResources
SelectedGitResource[]
SelectedPackages
SelectedPackage[]
SpaceId
string
required
Version
string
required
VersionControlReference
SnapshotGitReferenceResource
Response
Created
ReleaseResource
required
Assembled
string
date-time
BuildInformation
ReleasePackageVersionBuildInformationResource[]
ChannelId
string
CustomFields
object
Id
string
IgnoreChannelRules
boolean
LastModifiedBy
string
LastModifiedOn
string
date-time
LibraryVariableSetSnapshotIds
string[]
Links
object
ProjectDeploymentProcessSnapshotId
string
ProjectId
string
ProjectVariableSetSnapshotId
string
ReleaseNotes
string
SelectedGitResources
SelectedGitResource[]
SelectedPackages
SelectedPackage[]
SpaceId
string
Version
string
required
VersionControlReference
SnapshotGitReferenceResource