/
OC
octopus
/
Octopus Server API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 12h ago · Updated 3d ago
View markdown
octopus
Octopus Server API
get
Get the logo associated with the project.
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
ProcessTemplates
14
Progression
18
ProjectGroups
21
Projects
62
get
List all of the projects in the supplied Octopus Deploy Space, from all project groups. The results will be sorted alphabetically by name.
post
Create a new project.
get
List all of the projects in the supplied Octopus Deploy Space.
get
Get the logo associated with the project.
get
Get Project Badge based on relevant parameters
get
Get Project Badge based on relevant parameters
get
Get a Project by ID or slug.
put
Modify an existing Project
delete
Delete an existing Project
post
Test the Git settings to make sure we can connect.
post
Convert an existing project to store its configuration in version control.
post
Validate the provided git ref
put
Update the logo associated with the project.
post
Update the logo associated with the project.
get
Get the custom settings metadata from the extensions.
get
Get a summary of project-specific information.
get
Get a summary of project-specific information.
get
Get a summary of project-specific information.
get
Get a summary of project-specific information.
get
Get a Project by ID or slug.
get
List all of the projects in the supplied Octopus Deploy Space, from all project groups. The results will be sorted alphabetically by name.
post
Create a new project.
get
List all of the projects in the supplied Octopus Deploy Space.
get
Get the logo associated with the project.
get
Get Project Badge based on relevant parameters
get
Get Project Badge based on relevant parameters
get
Get a Project by ID or slug.
put
Modify an existing Project
delete
Delete an existing Project
post
Test the Git settings to make sure we can connect.
post
Convert an existing project to store its configuration in version control.
post
Convert all Runbooks to be stored in Git rather than the database.
post
Validate the provided git ref
put
Update the logo associated with the project.
post
Update the logo associated with the project.
get
Get the custom settings metadata from the extensions.
get
Get a summary of project-specific information.
get
Get a summary of project-specific information.
get
Get a summary of project-specific information.
get
Get a summary of project-specific information.
get
Get a Project by ID or slug.
get
List all of the projects in the supplied Octopus Deploy Space, from all project groups. The results will be sorted alphabetically by name.
post
Create a new project.
get
List all of the projects in the supplied Octopus Deploy Space.
get
Get the logo associated with the project.
get
Get Project Badge based on relevant parameters
get
Get Project Badge based on relevant parameters
get
Get a Project by ID or slug.
put
Modify an existing Project
delete
Delete an existing Project
post
Test the Git settings to make sure we can connect.
post
Convert an existing project to store its configuration in version control.
post
Convert all Runbooks to be stored in Git rather than the database.
post
Validate the provided git ref
put
Update the logo associated with the project.
post
Update the logo associated with the project.
get
Get the custom settings metadata from the extensions.
get
Get a summary of project-specific information.
get
Get a summary of project-specific information.
get
Get a summary of project-specific information.
get
Get a summary of project-specific information.
get
Get a Project by ID or slug.
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
Projects
Get the logo associated with the project.
get
/projects/{id}/logo
Path parameters
id
string
required
ID of the resource
Response
Success
string
binary
required