/
OC
octopus
/
Octopus Server API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 15h ago · Updated 3d ago
View markdown
octopus
Octopus Server API
get
Get the installation URL for the GitHub App
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
get
Get the installation URL for the GitHub App
get
Get the settings for the GitHub App
get
Get the status of the registration between Octopus Server and the GitHub App
get
Handle the response from GitHub after an application has been installed or updated.
get
Get the GitHub repositories for an installation visible to the current user https://docs.github.com/en/rest/apps/installations?apiVersion=2022-11-28#list-repositories-accessible-to-the-user-access-token
post
Reset the GitHub app registration for this Octopus instance. This is a destructive command and will break all existing GitHub app connections across the instance. This should only be used as a last resort to recover connectivity with GitHub.
get
Search for GitHub repositories for an account visible to the current user https://docs.github.com/en/rest/search/search?apiVersion=2022-11-28#search-repositories
get
Get status of the users current authorization.
post
Authorize the current user with the Octopus GitHub app
post
Exchange a GitHub App authorization code for an access token and store in the instance
get
Exchange a GitHub App authorization code for an access token and store in the instance
delete
Deauthorize the GitHub app for the current user, removing this users GitHub tokens from Octopus
post
Refresh the GitHub current app user. Refreshing the users token and cached GitHub account details.
post
Test connectivity to GitHub using the provided credentials
get
Get GitHub App connections for the space
post
Create a new GitHub App connection for an installation
get
Get the GitHub repositories for the current connection
get
Get a single GitHub app connection by id
put
Update a GitHub App connection with a new set of repositories
delete
Delete a GitHub App Connection
post
Recover GitHub App connection after the registration has changed
post
Recover GitHub App connection after the installation was not found
post
Refresh the 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 GitHub App connections for the space
post
Create a new GitHub App connection for an installation
get
Get the GitHub repositories for the current connection
get
Get a single GitHub app connection by id
put
Update a GitHub App connection with a new set of repositories
delete
Delete a GitHub App Connection
post
Recover GitHub App connection after the registration has changed
post
Recover GitHub App connection after the installation was not found
post
Refresh the 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.
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
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
GitHub
Get the installation URL for the GitHub App
get
/github/accounts/install-url
Query parameters
redirectUri
string
required
Response
OK