/
OC
octopus
/
Octopus Server API
Search skmtc…
⌘K
Changes
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 7h ago · Updated 5d ago
Details
Filter operations
AccessTokens
1
Accounts
40
ActionTemplates
57
ApiKeys
5
ApprovalPolicies
10
Approvals
8
Artifacts
21
AuditStream
2
Authentication
2
AzureDevOps
1
Branches
21
BuildInformation
15
Capabilities
2
Certificates
46
Channels
52
CloudTemplate
1
CommunityActionTemplates
9
CompliancePolicies
8
Configuration
5
ConnectionAgents
9
Dashboard
6
DashboardConfiguration
6
DeploymentFreeze
8
DeploymentProcesses
40
Deployments
19
DeploymentSettings
18
get
Gets deployment settings by ID.
put
Modifies deployment settings
get
Gets deployment settings by ID.
put
Modifies deployment settings
get
Gets deployment settings by ID.
put
Modifies deployment settings
get
Gets deployment settings by ID.
put
Modifies deployment settings
get
Gets deployment settings by ID.
put
Modifies deployment settings
get
Gets deployment settings by ID.
put
Modifies deployment settings
get
Gets deployment settings by ID.
put
Modifies deployment settings
get
Gets deployment settings by ID.
put
Modifies deployment settings
get
Gets deployment settings by ID.
put
Modifies deployment settings
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
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
DeploymentSettings
Gets deployment settings by ID.
get
/deploymentsettings/{id}
Path parameters
id
string
required
ID of the DeploymentSettings to load
Response
Success
DeploymentSettingsResource
required
CancelQueuedTasks
boolean
CancelRunningTasks
boolean
ConnectivityPolicy
DeploymentConnectivityPolicy
DefaultGuidedFailureMode
'EnvironmentDefault'
|
'Off'
|
'On'
DefaultToSkipIfAlreadyInstalled
boolean
DeploymentChangesTemplate
string
FailTargetDiscovery
boolean
ForcePackageDownload
boolean
Id
string
LastModifiedBy
string
LastModifiedOn
string
date-time
Links
object
ProjectId
string
ReleaseNotesTemplate
string
SpaceId
string
VersioningStrategy
VersioningStrategyResource
Changes