/
OC
octopus
/
Octopus Server API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 18h ago · Updated 4d ago
View markdown
octopus
Octopus Server API
post
Create a new Platform Hub account
latest
Swagger 2.0
2026-08-19
1,919
888
3.9 MB
b296c3a60aa5
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
get
Get Platform Hub accounts
post
Create a new Platform Hub account
get
Get a specific Platform Hub account
put
Modify an existing Platform Hub account
delete
Delete an existing Platform Hub account
get
Get Platform Hub certificates.
post
Create a new Platform Hub certificate.
post
Create a self-signed Platform Hub certificate.
get
Get a Platform Hub certificate by ID or Thumbprint.
put
Modify an existing Platform Hub certificate.
delete
Delete an existing archived Platform Hub certificate.
post
Archive an existing Platform Hub certificate.
get
Export the Platform Hub certificate.
post
Replace an existing Platform Hub certificate with another.
post
Unarchive an existing archived Platform Hub certificate.
get
Get usages for a Platform Hub certificate.
get
Get a list of Platform Hub Feeds
post
Create a new Platform Hub Feed
get
Get a Platform Hub Feed by its id
put
Modify a Platform Hub Feed
delete
Delete an existing Platform Hub Feed
get
Search the specified platform hub feed for packages based on the provided search term
get
List available package versions for the specified platform hub feed and package.
get
Get Platform Hub Git credentials
post
Create a new Platform Hub Git credential
get
Get Platform Hub Git credentials (V2)
post
Create a new Platform Hub Git credential
get
Get a specific Platform Hub Git credential
put
Modify an existing Platform Hub Git credential
delete
Delete an existing Platform Hub Git credential
get
Get a specific Platform Hub Git credential (V2)
put
Modify an existing Platform Hub Git credential
get
Request the list of Branches for the Platform Hub
post
Create a branch given the base git ref, and the new branch's name
get
Request a list of Git Tags for the Platform Hub
get
Get GitHub App connections for the Platform Hub
post
Create a new GitHub App connection in Platform Hub
get
Get a single PlatformHub GitHub app connection by id
put
Update a Platform Hub GitHub App connection with a new set of repositories
delete
Delete a PlatformHub GitHub App connection by id
post
Recover a platfrom hub GitHub App connection after the registration has changed
post
Refresh the Platform Hub GitHub App connection token.
get
Get a list of GitHub organisations accessible to the current GitHub OAuth user. Request will fail if the user does not have a valid GitHub OAuth token.
get
Get platform hub version control settings configuration
put
Update the platform hub's existing version control settings configuration
get
Get a paginated list of process templates from the specified Git reference (sorted by name).
ProcessTemplates
14
Progression
18
ProjectGroups
21
Projects
62
ProjectTemplates
1
ProjectTriggers
30
Proxies
18
RateLimiting
3
Releases
68
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
PlatformHub
Create a new Platform Hub account
post
/platformhub/accounts
Request body
CreatePlatformHubAccountCommand
required
Description
string
Details
AccountDetailsResource
required
Name
string
required
Slug
string
Response
Created
CreatePlatformHubAccountResponse
required
Id
string
required