/
OC
octopus
/
Octopus Server API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 10h ago · Updated 3d ago
View markdown
octopus
Octopus Server API
post
Creates a new environment.
Swagger 2.0
2026-08-14
1,919
888
3.7 MB
dbbd6d1e3f1c
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
get
Get a list of Environments.
post
Creates a new environment.
get
Get a list of Environments
get
Get a list of Environments
put
/environments/sortorder
get
Lists all environments, including a summary of machine information
get
Get a list of Environments.
put
Modifies an existing environment.
get
Gets the environment custom settings metadata from the extensions.
get
Lists all the variable set names (projects and library variable sets) that have variables that are scoped to only the given environment
get
Gets a specific Deployment Environment
delete
Deletes an existing Environment
get
Returns the list of machines in an environment that matches the filters requested by the user.
get
Get a list of Environments.
post
Creates a new environment.
get
Get a list of Environments
get
Get a list of Environments
put
/{spaceId}/environments/sortorder
get
Lists all environments, including a summary of machine information
get
Lists all environments, including a summary of machine information
get
Get a list of Environments.
get
Lists Static, Parent and Ephemeral Environments in the supplied Octopus Deploy Space. The results will be sorted by the `SortOrder` field on each environment (which is set to a MaxValue integer for Ephemeral Environments).
put
Modifies an existing environment.
get
Gets the environment custom settings metadata from the extensions.
get
Lists all the variable set names (projects and library variable sets) that have variables that are scoped to only the given environment
get
Gets a specific Deployment Environment
delete
Deletes an existing Environment
get
Returns the list of machines in an environment that matches the filters requested by the user.
get
Gets a specific Static, Parent or Ephemeral Environment by ID
get
Lists environments available for a project.
get
Get a list of Environments.
post
Creates a new environment.
get
Get a list of Environments
get
Get a list of Environments
put
/spaces/{spaceIdentifier}/environments/sortorder
get
Lists all environments, including a summary of machine information
get
Lists all environments, including a summary of machine information
get
Get a list of Environments.
get
Lists Static, Parent and Ephemeral Environments in the supplied Octopus Deploy Space. The results will be sorted by the `SortOrder` field on each environment (which is set to a MaxValue integer for Ephemeral Environments).
put
Modifies an existing environment.
get
Gets the environment custom settings metadata from the extensions.
get
Lists all the variable set names (projects and library variable sets) that have variables that are scoped to only the given environment
get
Gets a specific Deployment Environment
delete
Deletes an existing Environment
get
Returns the list of machines in an environment that matches the filters requested by the user.
get
Gets a specific Static, Parent or Ephemeral Environment by ID
get
Lists environments available for a project.
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
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
Environments
Creates a new environment.
post
/{spaceId}/environments
Path parameters
spaceId
string
required
Request body
CreateEnvironmentCommand
required
AllowDynamicInfrastructure
boolean
Description
string
EnvironmentTags
string[]
ExtensionSettings
ExtensionSettingsValues[]
Name
string
required
Slug
string
SortOrder
integer
SpaceId
string
required
UseGuidedFailure
boolean
Response
Created
EnvironmentResource
required
AllowDynamicInfrastructure
boolean
Description
string
EnvironmentTags
string[]
ExtensionSettings
ExtensionSettingsValues[]
Id
string
LastModifiedBy
string
LastModifiedOn
string
date-time
Links
object
Name
string
Slug
string
SortOrder
integer
SpaceId
string
UseGuidedFailure
boolean