/
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
latest
Swagger 2.0
2026-08-19
1,919
888
3.9 MB
b296c3a60aa5
AccessTokens
1
post
Create an access token for the current user
Accounts
41
get
Get a list of accounts.
post
Create a new account - of the type defined by body content
get
Get a list of Accounts
get
List the Azure Environments provided by the SDK
put
Modify the account identified by the accoutId
get
Get an Account by ID
delete
Delete an existing Account
get
Retrieve the public key portion of the account's associated certificate, if present.
get
List the Resource Groups associated with an Azure account.
get
List the storage accounts associated with an Azure account.
get
List projects and deployments which are using an account.
delete
Delete an existing Account
get
List the websites associated with an Azure account.
get
List the slots associated with an Azure Web Site.
get
Get the account types this Octopus Server supports
get
Get a list of accounts.
post
Create a new account - of the type defined by body content
get
Get a list of Accounts
put
Modify the account identified by the accoutId
get
Get an Account by ID
delete
Delete an existing Account
get
Retrieve the public key portion of the account's associated certificate, if present.
get
List the Resource Groups associated with an Azure account.
get
List the storage accounts associated with an Azure account.
get
List projects and deployments which are using an account.
delete
Delete an existing Account
get
List the websites associated with an Azure account.
get
List the slots associated with an Azure Web Site.
get
Get a list of accounts.
post
Create a new account - of the type defined by body content
get
Get a list of Accounts
put
Modify the account identified by the accoutId
get
Get an Account by ID
delete
Delete an existing Account
get
Retrieve the public key portion of the account's associated certificate, if present.
get
List the Resource Groups associated with an Azure account.
get
List the storage accounts associated with an Azure account.
get
List projects and deployments which are using an account.
delete
Delete an existing Account
get
List the websites associated with an Azure account.
get
List the slots associated with an Azure Web Site.
ActionTemplates
57
get
Get a list of Action Templates
post
Create an Action Template.
get
Get all Action Templates
get
Get a list of Action Template categories
get
List all available action templates including built-in, custom and community contributed step templates.
get
Get an Action Template by ID
put
Modify an existing action template.
delete
Delete an existing Action Template and all its versions.
post
Update deployment and runbook actions to a specific version of the action template
post
Create a server task to update deployment and runbook actions to a specific version of the action template
get
Get the logo associated with the latest version of action template.
put
Update the logo associated with the latest version of the action template.
post
Update the logo associated with the latest version of the action template.
get
Get usages for an Action Template.
get
Get an Action Template by ID
delete
Delete an existing Action Template and all its versions.
get
Get all versions of an Action Template.
get
Get a specific version of an Action Template.
get
Get the logo associated with specific version of the action template.
get
Get a list of Action Templates
post
Create an Action Template.
get
Get all Action Templates
get
Get a list of Action Template categories
get
List all available action templates including built-in, custom and community contributed step templates.
get
Get an Action Template by ID
put
Modify an existing action template.
delete
Delete an existing Action Template and all its versions.
post
Update deployment and runbook actions to a specific version of the action template
post
Create a server task to update deployment and runbook actions to a specific version of the action template
get
Get the logo associated with the latest version of action template.
put
Update the logo associated with the latest version of the action template.
post
Update the logo associated with the latest version of the action template.
get
Get usages for an Action Template.
get
Get an Action Template by ID
delete
Delete an existing Action Template and all its versions.
get
Get all versions of an Action Template.
get
Get a specific version of an Action Template.
get
Get the logo associated with specific version of the action template.
get
Get a list of Action Templates
post
Create an Action Template.
get
Get all Action Templates
get
Get a list of Action Template categories
get
List all available action templates including built-in, custom and community contributed step templates.
get
Get an Action Template by ID
put
Modify an existing action template.
delete
Delete an existing Action Template and all its versions.
post
Update deployment and runbook actions to a specific version of the action template
post
Create a server task to update deployment and runbook actions to a specific version of the action template
get
Get the logo associated with the latest version of action template.
put
Update the logo associated with the latest version of the action template.
post
Update the logo associated with the latest version of the action template.
get
Get usages for an Action Template.
get
Get an Action Template by ID
delete
Delete an existing Action Template and all its versions.
get
Get all versions of an Action Template.
get
Get a specific version of an Action Template.
get
Get the logo associated with specific version of the action template.
ApiKeys
5
get
Get a list of API Keys for a given User
post
Generate a new API key for the specified user. The API key returned in the result must be saved by the caller, as it cannot be retrieved subsequently from the Octopus server.
get
Get a list of API Keys for a given User
get
Get a ApiKeyResource by ID
delete
Revoke an existing API key.
ApprovalPolicies
10
get
Get a list of Approval policies
post
Creates a new approval policy in the specified Octopus Deploy space.
get
Gets an ApprovalPolicyResource by ID
put
Modifies an existing approval policy in the specified Octopus Deploy space.
delete
Deletes an existing ApprovalPolicy
get
Get a list of Approval policies
post
Creates a new approval policy in the specified Octopus Deploy space.
get
Gets an ApprovalPolicyResource by ID
put
Modifies an existing approval policy in the specified Octopus Deploy space.
delete
Deletes an existing ApprovalPolicy
Approvals
8
get
Get a list of all approvals for a server task approval
post
Create a new Approval
get
Get an Approval by id
put
Modify an Approval
get
Get a list of all approvals for a server task approval
post
Create a new Approval
get
Get an Approval by id
put
Modify an Approval
Artifacts
21
get
List all of the artifacts in the supplied Octopus Deploy Space, from all releases. The results will be sorted by date from most recently to least recently created.
post
Create a new artifact.
get
Get an Artifact by ID
put
Modify an existing artifact.
delete
Delete an existing Artifact
get
Get the content associated with an artifact.
put
/artifacts/{id}/content
get
List all of the artifacts in the supplied Octopus Deploy Space, from all releases. The results will be sorted by date from most recently to least recently created.
post
Create a new artifact.
get
Get an Artifact by ID
put
Modify an existing artifact.
delete
Delete an existing Artifact
get
Get the content associated with an artifact.
put
/{spaceId}/artifacts/{id}/content
get
List all of the artifacts in the supplied Octopus Deploy Space, from all releases. The results will be sorted by date from most recently to least recently created.
post
Create a new artifact.
get
Get an Artifact by ID
put
Modify an existing artifact.
delete
Delete an existing Artifact
get
Get the content associated with an artifact.
put
/spaces/{spaceIdentifier}/artifacts/{id}/content
AuditStream
2
get
Get the audit stream configuration
put
Modify the audit stream configuration
Authentication
2
get
Get authentication providers
post
Determine whether an external server (.e.g Okta) has initiated login from a URL query string and, if so, get the provider's name
AzureDevOps
1
post
/azuredevopsissuetracker/connectivitycheck
Branches
21
get
Request the list of Branches for a given Project
post
Create a branch given a project, the base git ref, and the new branch's name
get
Get a Git branch by name
get
Get a Git commit by hash
get
Get a Git named reference by name
get
Request a list of Git Tags for the project
get
Get an individual Git Tag; searching for it by Name
get
Request the list of Branches for a given Project
post
Create a branch given a project, the base git ref, and the new branch's name
get
Get a Git branch by name
get
Get a Git commit by hash
get
Get a Git named reference by name
get
Request a list of Git Tags for the project
get
Get an individual Git Tag; searching for it by Name
get
Request the list of Branches for a given Project
post
Create a branch given a project, the base git ref, and the new branch's name
get
Get a Git branch by name
get
Get a Git commit by hash
get
Get a Git named reference by name
get
Request a list of Git Tags for the project
get
Get an individual Git Tag; searching for it by Name
BuildInformation
15
get
Retrieve a list of build information records describing the vcs information for a given package
post
Create or update a specific build information record describing the vcs information for a given package
delete
Bulk delete specific Build Information records.
get
Retrieve a specific build information record describing the vcs information for a given package
delete
Delete a specific Build Information record.
get
Retrieve a list of build information records describing the vcs information for a given package
post
Create or update a specific build information record describing the vcs information for a given package
delete
Bulk delete specific Build Information records.
get
Retrieve a specific build information record describing the vcs information for a given package
delete
Delete a specific Build Information record.
get
Retrieve a list of build information records describing the vcs information for a given package
post
Create or update a specific build information record describing the vcs information for a given package
delete
Bulk delete specific Build Information records.
get
Retrieve a specific build information record describing the vcs information for a given package
delete
Delete a specific Build Information record.
Capabilities
2
get
Ask the server to return a list of all the Capabilities (Commands and Requests) it supports.
get
Ask the server if a single capability exists or not. If the Capability exists, an HTTP 200 (OK) will be returned. If not, a 404 (Not Found) will be returned.
Certificates
49
get
List X.509 certificates managed by Octopus
post
Create a new certificate.
get
Get a list of Certificates
get
Get the global Certificate
post
Create a self-signed Certificate
get
List the X.509 certificates in the supplied Octopus Deploy Space in pages. Current certificates are sorted by soonest expiry first unless OrderBy says otherwise; archived certificates are always sorted by most recently archived.
get
Get a Certificate by ID or Thumbprint
put
Modify a certificate by ID
delete
Delete an existing Certificate
post
Archive an existing Certificate.
post
Archive an existing Certificate.
get
Export the certificate
post
Replace an existing Certificate with another
post
Unarchive an existing archived Certificate.
post
Unarchive an existing archived Certificate.
get
/certificates/{id}/usages
get
Request the list of Certificate Configurations
get
Get a Certificate Configuration by ID
get
Get public certificate
get
List X.509 certificates managed by Octopus
post
Create a new certificate.
get
Get a list of Certificates
post
Create a self-signed Certificate
get
List the X.509 certificates in the supplied Octopus Deploy Space in pages. Current certificates are sorted by soonest expiry first unless OrderBy says otherwise; archived certificates are always sorted by most recently archived.
get
Get a Certificate by ID or Thumbprint
put
Modify a certificate by ID
delete
Delete an existing Certificate
post
Archive an existing Certificate.
post
Archive an existing Certificate.
get
Export the certificate
post
Replace an existing Certificate with another
post
Unarchive an existing archived Certificate.
post
Unarchive an existing archived Certificate.
get
/{spaceId}/certificates/{id}/usages
get
List X.509 certificates managed by Octopus
post
Create a new certificate.
get
Get a list of Certificates
post
Create a self-signed Certificate
get
List the X.509 certificates in the supplied Octopus Deploy Space in pages. Current certificates are sorted by soonest expiry first unless OrderBy says otherwise; archived certificates are always sorted by most recently archived.
get
Get a Certificate by ID or Thumbprint
put
Modify a certificate by ID
delete
Delete an existing Certificate
post
Archive an existing Certificate.
post
Archive an existing Certificate.
get
Export the certificate
post
Replace an existing Certificate with another
post
Unarchive an existing archived Certificate.
post
Unarchive an existing archived Certificate.
get
/spaces/{spaceIdentifier}/certificates/{id}/usages
Channels
52
get
Get a list of Channels
post
Create a Channel
get
Get a list of Channels
get
Perform Channel version rule test against provided Package version
post
Perform Channel version rule test against provided Package version
get
Test Channel version rules
post
Test Channel version rules
get
Get a Channel by ID
put
Update an existing Channel
delete
Delete a ChannelResource by ID
get
Get a list of ChannelResources for the given ProjectResource
post
Create a Channel
get
Get a Channel by ID
put
Update an existing Channel
delete
Delete a ChannelResource by ID
delete
Delete a ChannelResource by ID
get
Get a list of Channels
post
Create a Channel
get
Get a list of Channels
get
Perform Channel version rule test against provided Package version
post
Perform Channel version rule test against provided Package version
get
Test Channel version rules
post
Test Channel version rules
get
Get a Channel by ID
put
Update an existing Channel
delete
Delete a ChannelResource by ID
get
Get a list of ChannelResources for the given ProjectResource
post
Create a Channel
get
Determine if a git reference satisfies the rules of a channel.
get
Determine if a git reference satisfies a channel's Git resource rules.
get
Get a Channel by ID
put
Update an existing Channel
delete
Delete a ChannelResource by ID
delete
Delete a ChannelResource by ID
get
Get a list of Channels
post
Create a Channel
get
Get a list of Channels
get
Perform Channel version rule test against provided Package version
post
Perform Channel version rule test against provided Package version
get
Test Channel version rules
post
Test Channel version rules
get
Get a Channel by ID
put
Update an existing Channel
delete
Delete a ChannelResource by ID
get
Get a list of ChannelResources for the given ProjectResource
post
Create a Channel
get
Determine if a git reference satisfies the rules of a channel.
get
Determine if a git reference satisfies a channel's Git resource rules.
get
Get a Channel by ID
put
Update an existing Channel
delete
Delete a ChannelResource by ID
delete
Delete a ChannelResource by ID
CloudTemplate
1
post
Request the metadata (ie, parameters and values) for a cloud template (eg, cloudformation, terraform, azure ARM template)
CommunityActionTemplates
9
get
Get a list of Community Action Templates.
get
Get a Community Action Template by ID.
get
Get installed version of the template.
get
Get installed version of the template.
put
Update installed community step template to the latest version.
post
Install community step template.
put
Update installed community step template to the latest version.
post
Install community step template.
get
Get the logo associated with the community step template.
CompliancePolicies
8
get
Request the published versions for a policy
get
Request the published versions for a policy
post
Modify the activation status for a policy version
get
Request a paginated set of CompliancePolicyResource sorted by name
post
Create a new policy
get
Request a single CompliancePolicyResource by slug and git reference
put
Modify an existing policy
post
Create new version of policy
Configuration
5
get
Return a list of configuration section settings
get
Return a single configuration section for the given id
get
Return a structure that describes how to dynamically render the configuration section
get
Return the current configuration for a specific configuration section
put
Update the configuration values for a specific configuration section.
ConnectionAgents
9
get
List all registered Connection Agents
post
Register a Connection Agent
get
List all Connection Agent forwarding rules.
put
Create or update a Connection Agent forwarding rule, mapping an FQDN to a Connection Agent.
delete
Delete a Connection Agent forwarding rule.
get
Get a single registered Connection Agent by name
delete
Unregister a Connection Agent
post
Add a credential to an existing Connection Agent
delete
Remove a credential from a Connection Agent
Dashboard
6
get
Return information required to render the Octopus dashboard
get
Return the information required to render the dynamic dashboard. Deprecated.
get
Return information required to render the Octopus dashboard
get
Return the information required to render the dynamic dashboard. Deprecated.
get
Return information required to render the Octopus dashboard
get
Return the information required to render the dynamic dashboard. Deprecated.
DashboardConfiguration
6
get
Get dashboard configuration
put
Modify dashboard configuration
get
Get dashboard configuration
put
Modify dashboard configuration
get
Get dashboard configuration
put
Modify dashboard configuration
DeploymentFreeze
8
get
Get DeploymentFreezes
post
Create a new deployment freeze.
get
Get a deployment freeze by ID
put
Create a new deployment freeze.
delete
Delete a deployment freeze.
post
Override a deployment freeze to create a deployment.
post
Override a deployment freeze to create a deployment.
post
Override a deployment freeze to create a deployment.
DeploymentProcesses
40
get
List all the deployment processes
get
Get a Release Snapshot Template.
get
Get a specific snapshotted version of a deployment process
put
Modify a deployment process
get
Get the deployment process for a project
put
Modify a deployment process
get
Get all of the information necessary for creating or editing a release using this deployment process.
post
Validate the deployment process for common non-blocking issues, such as missing deployment targets for tags used within the process steps.
get
Get the deployment process for a version-controlled project
put
Modify a deployment process
get
Get all of the information necessary for creating or editing a release using this deployment process.
post
Validate the deployment process for common non-blocking issues, such as missing deployment targets for tags used within the process steps.
get
List all the deployment processes
get
Get a Release Snapshot Template.
get
Get a specific snapshotted version of a deployment process
put
Modify a deployment process
get
Get the deployment process for a project
put
Modify a deployment process
get
Get the resolved deployment process for a project.
get
Get all of the information necessary for creating or editing a release using this deployment process.
post
Validate the deployment process for common non-blocking issues, such as missing deployment targets for tags used within the process steps.
get
Get the deployment process for a version-controlled project
put
Modify a deployment process
get
Get the resolved deployment process for a version-controlled project
get
Get all of the information necessary for creating or editing a release using this deployment process.
post
Validate the deployment process for common non-blocking issues, such as missing deployment targets for tags used within the process steps.
get
List all the deployment processes
get
Get a Release Snapshot Template.
get
Get a specific snapshotted version of a deployment process
put
Modify a deployment process
get
Get the deployment process for a project
put
Modify a deployment process
get
Get the resolved deployment process for a project.
get
Get all of the information necessary for creating or editing a release using this deployment process.
post
Validate the deployment process for common non-blocking issues, such as missing deployment targets for tags used within the process steps.
get
Get the deployment process for a version-controlled project
put
Modify a deployment process
get
Get the resolved deployment process for a version-controlled project
get
Get all of the information necessary for creating or editing a release using this deployment process.
post
Validate the deployment process for common non-blocking issues, such as missing deployment targets for tags used within the process steps.
Deployments
19
get
Get a list of Deployments
post
Create a Deployment
post
Create a Deployment
get
Get a Deployment by ID.
delete
Delete an existing Deployment.
get
Get a list of Deployments
post
Create a Deployment
post
Create a new tenanted deployment.
post
Create a new untenanted deployment
post
Create a Deployment
get
Get a Deployment by ID.
delete
Delete an existing Deployment.
get
Get a list of Deployments
post
Create a Deployment
post
Create a new tenanted deployment.
post
Create a new untenanted deployment
post
Create a Deployment
get
Get a Deployment by ID.
delete
Delete an existing Deployment.
DeploymentSettings
18
get
Get deployment settings by ID.
put
Modify deployment settings
get
Get deployment settings by ID.
put
Modify deployment settings
get
Get deployment settings by ID.
put
Modify deployment settings
get
Get deployment settings by ID.
put
Modify deployment settings
get
Get deployment settings by ID.
put
Modify deployment settings
get
Get deployment settings by ID.
put
Modify deployment settings
get
Get deployment settings by ID.
put
Modify deployment settings
get
Get deployment settings by ID.
put
Modify deployment settings
get
Get deployment settings by ID.
put
Modify deployment settings
DeploymentTargets
45
get
List all of the registered machines in the supplied Octopus Deploy Space, from all environments. The results will be sorted alphabetically by name.
post
Create a MachineResource
get
Get a list of Deployment Targets
get
Get a list of Deployment Targets
get
Interrogate a deployment target for communication details so that it may be added to the installation.
get
Get all operating system names for deployment targets.
get
Get all operating system shell names for deployment targets.
get
List all of the registered machines in the supplied Octopus Deploy Space, from all environments. The results are sorted by health status, healthiest first, then alphabetically by name.
get
Get an existing Deployment Target.
delete
Delete an existing Deployment Target
get
Get a list of the latest deployments by project for the given Deployment Target
get
Get a list of Tasks for the given Deployment Target
get
Get a list of Tasks for the given Deployment Target
put
Modify an existing Deployment Target (identified by ID).
get
List all the variable set names (projects and library variable sets) that have variables that are scoped to only the given machine
get
List all of the registered machines in the supplied Octopus Deploy Space, from all environments. The results will be sorted alphabetically by name.
post
Create a MachineResource
get
Get a list of Deployment Targets
get
Get a list of Deployment Targets
get
Interrogate a deployment target for communication details so that it may be added to the installation.
get
Get all operating system names for deployment targets.
get
Get all operating system shell names for deployment targets.
get
List all of the registered machines in the supplied Octopus Deploy Space, from all environments. The results are sorted by health status, healthiest first, then alphabetically by name.
get
Get an existing Deployment Target.
delete
Delete an existing Deployment Target
get
Get a list of the latest deployments by project for the given Deployment Target
get
Get a list of Tasks for the given Deployment Target
get
Get a list of Tasks for the given Deployment Target
put
Modify an existing Deployment Target (identified by ID).
get
List all the variable set names (projects and library variable sets) that have variables that are scoped to only the given machine
get
List all of the registered machines in the supplied Octopus Deploy Space, from all environments. The results will be sorted alphabetically by name.
post
Create a MachineResource
get
Get a list of Deployment Targets
get
Get a list of Deployment Targets
get
Interrogate a deployment target for communication details so that it may be added to the installation.
get
Get all operating system names for deployment targets.
get
Get all operating system shell names for deployment targets.
get
List all of the registered machines in the supplied Octopus Deploy Space, from all environments. The results are sorted by health status, healthiest first, then alphabetically by name.
get
Get an existing Deployment Target.
delete
Delete an existing Deployment Target
get
Get a list of the latest deployments by project for the given Deployment Target
get
Get a list of Tasks for the given Deployment Target
get
Get a list of Tasks for the given Deployment Target
put
Modify an existing Deployment Target (identified by ID).
get
List all the variable set names (projects and library variable sets) that have variables that are scoped to only the given machine
DeploymentTargetTags
12
get
Get DeploymentTargetTags by DeploymentTargetTag IDs and Machine ID (deployment target ID).
post
Create a new DeploymentTargetTag
get
Get a DeploymentTargetTag by ID or Slug
delete
Delete a DeploymentTargetTag.
get
Get DeploymentTargetTags by DeploymentTargetTag IDs and Machine ID (deployment target ID).
post
Create a new DeploymentTargetTag
get
Get a DeploymentTargetTag by ID or Slug
delete
Delete a DeploymentTargetTag.
get
Get DeploymentTargetTags by DeploymentTargetTag IDs and Machine ID (deployment target ID).
post
Create a new DeploymentTargetTag
get
Get a DeploymentTargetTag by ID or Slug
delete
Delete a DeploymentTargetTag.
Deprecations
2
post
Toggle a deprecation on or off in Octopus Server. Used to test the impact of deprecations
post
Toggle a deprecation on or off in Octopus Server. Used to test the impact of deprecations
DirectoryServices
2
get
Search for Active Directory groups
get
Search for Active Directory users
DynamicExtensions
3
get
Request the current dynamic extensions feature metadata
get
Request the current dynamic extensions feature values
put
Modify the current dynamic extensions feature values.
Environments
47
get
Get a list of Environments.
post
Create a new environment.
get
Get a list of Environments
get
Get a list of Environments
put
/environments/sortorder
get
List all environments, including a summary of machine information
get
Get a list of Environments.
put
Modify an existing environment.
get
Get the environment custom settings metadata from the extensions.
get
List all the variable set names (projects and library variable sets) that have variables that are scoped to only the given environment
get
Get a specific Deployment Environment
delete
Delete an existing Environment
get
Return the list of machines in an environment that matches the filters requested by the user.
get
Get a list of Environments.
post
Create a new environment.
get
Get a list of Environments
get
Get a list of Environments
put
/{spaceId}/environments/sortorder
get
List all environments, including a summary of machine information
get
List all environments, including a summary of machine information
get
Get a list of Environments.
get
List 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
Modify an existing environment.
get
Get the environment custom settings metadata from the extensions.
get
List all the variable set names (projects and library variable sets) that have variables that are scoped to only the given environment
get
Get a specific Deployment Environment
delete
Delete an existing Environment
get
Return the list of machines in an environment that matches the filters requested by the user.
get
Get a specific Static, Parent or Ephemeral Environment by ID
get
List environments available for a project.
get
Get a list of Environments.
post
Create a new environment.
get
Get a list of Environments
get
Get a list of Environments
put
/spaces/{spaceIdentifier}/environments/sortorder
get
List all environments, including a summary of machine information
get
List all environments, including a summary of machine information
get
Get a list of Environments.
get
List 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
Modify an existing environment.
get
Get the environment custom settings metadata from the extensions.
get
List all the variable set names (projects and library variable sets) that have variables that are scoped to only the given environment
get
Get a specific Deployment Environment
delete
Delete an existing Environment
get
Return the list of machines in an environment that matches the filters requested by the user.
get
Get a specific Static, Parent or Ephemeral Environment by ID
get
List environments available for a project.
EphemeralEnvironments
16
post
Deprovision an ephemeral environment
post
Allow the creation of an ephemeral environment in a given space
post
Deprovision an ephemeral environment for a specific project
post
Mark a failed deprovisioning as successful for an ephemeral environment
post
Retry deprovisioning an ephemeral environment
post
Mark a failed provisioning as successful for an ephemeral environment
post
Retry provisioning an ephemeral environment
get
Get the status of an ephemeral environment for a given project
post
Deprovision an ephemeral environment
post
Allow the creation of an ephemeral environment in a given space
post
Deprovision an ephemeral environment for a specific project
post
Mark a failed deprovisioning as successful for an ephemeral environment
post
Retry deprovisioning an ephemeral environment
post
Mark a failed provisioning as successful for an ephemeral environment
post
Retry provisioning an ephemeral environment
get
Get the status of an ephemeral environment for a given project
EventRetention
5
get
Get the list of archived event files.
get
Get the list of archived event files.
get
Download an archived event file.
delete
Delete an archived event file.
delete
Delete an archived event file.
Events
18
get
Get a list of events
get
Return the list of event agents.
get
List event categories.
get
List subscription event document types.
get
List subscription event groups.
get
Get a single event by ID.
get
Get a list of events
get
Return the list of event agents.
get
List event categories.
get
List subscription event document types.
get
List subscription event groups.
get
Get a single event by ID.
get
Get a list of events
get
Return the list of event agents.
get
List event categories.
get
List subscription event document types.
get
List subscription event groups.
get
Get a single event by ID.
ExternalSecurityGroupProviders
1
get
/externalsecuritygroupproviders
FeaturesConfiguration
2
get
Get features configuration
put
Update features configuration.
FeatureToggles
14
get
Lists all feature toggles within a project
post
Creates a feature toggle within a project
post
Generates a feature toggle client identifier for a given project, environment, and tenant.
post
Rotates the feature toggle client identifier signing keys for a project.
get
Retrieves a feature toggle by ID
put
Modifies a feature toggle
delete
Deletes a feature toggle
get
Lists all feature toggles within a project
post
Creates a feature toggle within a project
post
Generates a feature toggle client identifier for a given project, environment, and tenant.
post
Rotates the feature toggle client identifier signing keys for a project.
get
Retrieves a feature toggle by ID
put
Modifies a feature toggle
delete
Deletes a feature toggle
Feeds
27
get
Get a list of feeds
post
Create a feed.
get
Get all Feeds
get
Get all feed statistics
get
Get a feed resource by ID.
put
Modify a feed by ID.
delete
Delete an existing Feed.
get
Search the specified feed for packages based on the provided search term
get
List available package versions for the specified feed and package.
get
Get a list of feeds
post
Create a feed.
get
Get all Feeds
get
Get all feed statistics
get
Get a feed resource by ID.
put
Modify a feed by ID.
delete
Delete an existing Feed.
get
Search the specified feed for packages based on the provided search term
get
List available package versions for the specified feed and package.
get
Get a list of feeds
post
Create a feed.
get
Get all Feeds
get
Get all feed statistics
get
Get a feed resource by ID.
put
Modify a feed by ID.
delete
Delete an existing Feed.
get
Search the specified feed for packages based on the provided search term
get
List available package versions for the specified feed and package.
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
get
/
get
/{spaceId}
Icons
7
get
Get details of all icons
get
Get all icon categories and icon IDs contained in each category
post
Modify the logo of a Space to be a specified icon
post
Modify the logo of a project to be a specified icon
post
Modify the logo of a tenant to be a specified icon
post
Modify the logo of a project to be a specified icon
post
Modify the logo of a tenant to be a specified icon
Insights
43
get
/insights/reports/{reportId}/logo
get
Get a list of Insights Reports
post
Create an Insights Report
post
Create an Insights Report
get
/{spaceId}/insights/reports/{id}
put
Update an existing Insights Report
delete
Delete an Insights Report by ID
get
/{spaceId}/insights/reports/{id}/v1
put
Update an existing Insights Report
delete
Delete an Insights Report by ID
get
Request Insights Deployments for a Report
get
Request Insights Deployments for a Report
get
/{spaceId}/insights/reports/{reportId}/logo
post
Update the logo associated with the report.
post
Modify the logo of an insights report to be a specified icon
post
Modify the logo of an insights report to be a specified icon
get
Get Insights metrics series for the Insights Report
get
Get Insights metrics series for the Insights Report
get
Get Insights Deployments for a Project
get
Get Insights Deployments for a Project
get
Get Insights metrics series for the project
get
Get Insights metrics series for the project
get
Get a list of Insights Reports
post
Create an Insights Report
post
Create an Insights Report
get
/spaces/{spaceIdentifier}/insights/reports/{id}
put
Update an existing Insights Report
delete
Delete an Insights Report by ID
get
/spaces/{spaceIdentifier}/insights/reports/{id}/v1
put
Update an existing Insights Report
delete
Delete an Insights Report by ID
get
Request Insights Deployments for a Report
get
Request Insights Deployments for a Report
get
/spaces/{spaceIdentifier}/insights/reports/{reportId}/logo
post
Update the logo associated with the report.
post
Modify the logo of an insights report to be a specified icon
post
Modify the logo of an insights report to be a specified icon
get
Get Insights metrics series for the Insights Report
get
Get Insights metrics series for the Insights Report
get
Get Insights Deployments for a Project
get
Get Insights Deployments for a Project
get
Get Insights metrics series for the project
get
Get Insights metrics series for the project
IntegratedAuthentication
1
get
/integrated-challenge
Interruptions
15
get
List interruptions for user attention. The results will be sorted by date from most recently to least recently created.
get
Get an Interruption by ID
get
Get the User that is currently responsible for this Interruption (if any).
put
Allow the current user to take responsibility for this interruption. Only users in one of the responsible teams on this interruption can take responsibility for it.
post
Submit a dictionary of form values for the interruption. Only the user with responsibility for this interruption can submit this form.
get
List interruptions for user attention. The results will be sorted by date from most recently to least recently created.
get
Get an Interruption by ID
get
Get the User that is currently responsible for this Interruption (if any).
put
Allow the current user to take responsibility for this interruption. Only users in one of the responsible teams on this interruption can take responsibility for it.
post
Submit a dictionary of form values for the interruption. Only the user with responsibility for this interruption can submit this form.
get
List interruptions for user attention. The results will be sorted by date from most recently to least recently created.
get
Get an Interruption by ID
get
Get the User that is currently responsible for this Interruption (if any).
put
Allow the current user to take responsibility for this interruption. Only users in one of the responsible teams on this interruption can take responsibility for it.
post
Submit a dictionary of form values for the interruption. Only the user with responsibility for this interruption can submit this form.
Invitations
6
post
Create an invitation to allow a new person to join this Octopus instance
get
Get an Invitation by ID.
post
Create an invitation to allow a new person to join this Octopus instance
get
Get an Invitation by ID.
post
Create an invitation to allow a new person to join this Octopus instance
get
Get an Invitation by ID.
JiraIntegration
2
post
/jiraintegration/connectivitycheck/connectapp
post
/jiraintegration/connectivitycheck/jira
JsonWebKeys
1
get
Get signing keys used by Octopus Server in JWK format
LDAP
2
get
Search for LDAP groups
get
Search for LDAP users
LetsEncrypt
2
get
Request the current Let's Encrypt configuration
put
Allow you to disable the Let's Encrypt configuration for this Octopus Server
LibraryVariableSets
27
get
List all of the library variable sets in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.
post
Create a new library variable set.
get
Get a list of Library Variable Sets
get
Get a list of Library Variable Sets
post
Get a list of Library Variable Sets
get
Get a Library Variable Set by ID.
put
Modify an existing library variable set.
delete
Delete an existing Library Variable Set.
get
List projects and deployments which are using an library variable set.
get
List all of the library variable sets in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.
post
Create a new library variable set.
get
Get a list of Library Variable Sets
get
Get a list of Library Variable Sets
post
Get a list of Library Variable Sets
get
Get a Library Variable Set by ID.
put
Modify an existing library variable set.
delete
Delete an existing Library Variable Set.
get
List projects and deployments which are using an library variable set.
get
List all of the library variable sets in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.
post
Create a new library variable set.
get
Get a list of Library Variable Sets
get
Get a list of Library Variable Sets
post
Get a list of Library Variable Sets
get
Get a Library Variable Set by ID.
put
Modify an existing library variable set.
delete
Delete an existing Library Variable Set.
get
List projects and deployments which are using an library variable set.
Licenses
5
get
Return the details of the current license in use by the Octopus Cluster.
put
Update the current Octopus cluster license.
get
Return a list of enabled features from the license
get
Get the status of the current Octopus license.
get
Get the usage of the current Octopus server.
Lifecycles
27
get
List the Lifecycles in the supplied Octopus Deploy Space in pages. The results will be sorted alphabetically by name.
post
Create a new Lifecycle.
get
List all the lifecycles in the supplied Octopus Deploy Space.
get
Get a list of Lifecycle previews
get
Get a specific Lifecycle
put
Modify a Lifecycle.
delete
Delete an existing Lifecycle
get
Get a Lifecycle preview by Lifecycle id.
get
Get all projects that use this lifecycle.
get
List the Lifecycles in the supplied Octopus Deploy Space in pages. The results will be sorted alphabetically by name.
post
Create a new Lifecycle.
get
List all the lifecycles in the supplied Octopus Deploy Space.
get
Get a list of Lifecycle previews
get
Get a specific Lifecycle
put
Modify a Lifecycle.
delete
Delete an existing Lifecycle
get
Get a Lifecycle preview by Lifecycle id.
get
Get all projects that use this lifecycle.
get
List the Lifecycles in the supplied Octopus Deploy Space in pages. The results will be sorted alphabetically by name.
post
Create a new Lifecycle.
get
List all the lifecycles in the supplied Octopus Deploy Space.
get
Get a list of Lifecycle previews
get
Get a specific Lifecycle
put
Modify a Lifecycle.
delete
Delete an existing Lifecycle
get
Get a Lifecycle preview by Lifecycle id.
get
Get all projects that use this lifecycle.
MachinePolicies
30
get
Get a paginated list of the Machine Policies in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.
post
Create a new Machine Policy
get
Get a list of Machine Policies
get
Get a template for a new Machine Policy, which includes any defaults.
get
Get a Machine Policy by ID
put
Modify an existing Machine Policy
delete
Delete the specified Machine Policy
get
Get a paginated list of the machines that belong to the given Machine Policy
delete
Delete the specified Machine Policy
get
Get a paginated list of the workers that belong to the given Machine Policy
get
Get a paginated list of the Machine Policies in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.
post
Create a new Machine Policy
get
Get a list of Machine Policies
get
Get a template for a new Machine Policy, which includes any defaults.
get
Get a Machine Policy by ID
put
Modify an existing Machine Policy
delete
Delete the specified Machine Policy
get
Get a paginated list of the machines that belong to the given Machine Policy
delete
Delete the specified Machine Policy
get
Get a paginated list of the workers that belong to the given Machine Policy
get
Get a paginated list of the Machine Policies in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.
post
Create a new Machine Policy
get
Get a list of Machine Policies
get
Get a template for a new Machine Policy, which includes any defaults.
get
Get a Machine Policy by ID
put
Modify an existing Machine Policy
delete
Delete the specified Machine Policy
get
Get a paginated list of the machines that belong to the given Machine Policy
delete
Delete the specified Machine Policy
get
Get a paginated list of the workers that belong to the given Machine Policy
MachineRoles
6
get
Get all machine roles that have been defined in this Octopus installation.
get
Get all machine roles that have been defined in this Octopus installation.
get
Get all machine roles that have been defined in this Octopus installation.
get
Get all machine roles that have been defined in this Octopus installation.
get
Get all machine roles that have been defined in this Octopus installation.
get
Get all machine roles that have been defined in this Octopus installation.
Machines
3
get
Get the status of the network connection between the Octopus server and a machine.
get
Get the status of the network connection between the Octopus server and a machine.
get
Get the status of the network connection between the Octopus server and a machine.
MaintenanceConfiguration
3
get
Get information about the maintenance configuration in use by the Octopus Server.
put
Update the maintenance configuration used by the Octopus Server.
put
Update the maintenance configuration used by the Octopus Server.
Migrations
2
post
Create and queue a migration import task, from an export created via the migration partial-export api.
post
Create and queue a partial-export migration task.
Nuget
2
put
Push packages to this endpoint using NuGet.exe or compatible tools.
put
Push packages to this endpoint using NuGet.exe or compatible tools.
Observability
32
post
Register and trusts new Kubernetes Monitor.
post
Request the Kubernetes monitor to start sending events for the specified resource
get
Request to fetch all the events for the specified session
post
Register and trusts new Kubernetes Monitor.
get
Get a Kubernetes Monitor by ID
delete
Delete a Kubernetes Monitor by ID
post
Request the Kubernetes monitor to start sending logs for the specified container
get
Request to fetch all the logs for the specified session
get
Request the live status for a Project/Environment/Tenant
get
Get a detailed summary of a live Kubernetes resource - either a top-level resource or a child resource
get
Request for retrieving the manifest for a live kubernetes resource
get
Request for retrieving the manifest for a live kubernetes resource
get
Request the live status for a Project/Environment/Tenant
get
Get a detailed summary of a live Kubernetes resource - either a top-level resource or a child resource
get
Request for retrieving the manifest for a live kubernetes resource
get
Request for retrieving the manifest for a live kubernetes resource
post
Register and trusts new Kubernetes Monitor.
post
Request the Kubernetes monitor to start sending events for the specified resource
get
Request to fetch all the events for the specified session
post
Register and trusts new Kubernetes Monitor.
get
Get a Kubernetes Monitor by ID
delete
Delete a Kubernetes Monitor by ID
post
Request the Kubernetes monitor to start sending logs for the specified container
get
Request to fetch all the logs for the specified session
get
Request the live status for a Project/Environment/Tenant
get
Get a detailed summary of a live Kubernetes resource - either a top-level resource or a child resource
get
Request for retrieving the manifest for a live kubernetes resource
get
Request for retrieving the manifest for a live kubernetes resource
get
Request the live status for a Project/Environment/Tenant
get
Get a detailed summary of a live Kubernetes resource - either a top-level resource or a child resource
get
Request for retrieving the manifest for a live kubernetes resource
get
Request for retrieving the manifest for a live kubernetes resource
OctopusServerNodes
8
get
Get a list of Octopus Server Nodes
get
Get all Octopus Server Nodes
get
Ping an octopus server node.
get
Return all octopus server nodes in the cluster including their status information
get
Get an Octopus Server Node by ID
put
Modify an existing OctopusServerNodeResource by ID
delete
Delete an existing Octopus Server Node
get
Return a count of the running tasks on an octopus server node
OpenIdConnect
1
get
Get OpenID Connect configuration
OpenIDConnect
15
post
/users/authenticate/AzureAD
post
/users/authenticate/GenericOidc
post
/users/authenticate/GoogleApps
post
/users/authenticate/OctopusID
post
/users/authenticate/Okta
get
/users/authenticatedToken/AzureAD
post
/users/authenticatedToken/AzureAD
get
/users/authenticatedToken/GenericOidc
post
/users/authenticatedToken/GenericOidc
get
/users/authenticatedToken/GoogleApps
post
/users/authenticatedToken/GoogleApps
get
/users/authenticatedToken/OctopusID
post
/users/authenticatedToken/OctopusID
get
/users/authenticatedToken/Okta
post
/users/authenticatedToken/Okta
OpenTelemetry
2
get
Request the open telemetry trace file exporter config
put
Modify OpenTelemetry trace file export configuration
Packages
42
get
List packages according to specified search criteria
get
Get the release notes for the specified package
get
Get the built in packages
delete
Bulk delete Packages
delete
Bulk delete Packages
get
Request a list of Release Notes for the specified Packages
post
Upload a package to the built in package feed
post
Validate a package intended for the built in package feed, but does not write the package.
get
Return package information for the specified package id.
delete
Delete the specified Package
get
Download the specified package from the built in feed
delete
Delete the specified Package
post
Upload a delta patch for the given file. Used to optimize file upload.
get
Request the delta-signature for a given package. Used to optimize file upload.
get
List packages according to specified search criteria
get
Get the release notes for the specified package
get
Get the built in packages
delete
Bulk delete Packages
delete
Bulk delete Packages
get
Request a list of Release Notes for the specified Packages
post
Upload a package to the built in package feed
post
Validate a package intended for the built in package feed, but does not write the package.
get
Return package information for the specified package id.
delete
Delete the specified Package
get
Download the specified package from the built in feed
delete
Delete the specified Package
post
Upload a delta patch for the given file. Used to optimize file upload.
get
Request the delta-signature for a given package. Used to optimize file upload.
get
List packages according to specified search criteria
get
Get the release notes for the specified package
get
Get the built in packages
delete
Bulk delete Packages
delete
Bulk delete Packages
get
Request a list of Release Notes for the specified Packages
post
Upload a package to the built in package feed
post
Validate a package intended for the built in package feed, but does not write the package.
get
Return package information for the specified package id.
delete
Delete the specified Package
get
Download the specified package from the built in feed
delete
Delete the specified Package
post
Upload a delta patch for the given file. Used to optimize file upload.
get
Request the delta-signature for a given package. Used to optimize file upload.
ParentEnvironments
8
post
Create a new parent environment.
put
Modify an existing parent environment.
get
Get a specific Parent Environment
delete
Delete an existing Parent Environment
post
Create a new parent environment.
put
Modify an existing parent environment.
get
Get a specific Parent Environment
delete
Delete an existing Parent Environment
Performance
2
get
Request the current performance configuration
put
Set the performance configuration
Permissions
1
get
Get all the available permissions and their descriptions and restrictions
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
post
Create a new process template in the provided source
get
Get the sharing configuration for a given process template
get
List the process template versions for a given process template
get
Retrieve a single published process template and its version by version mask (no space context)
get
Get a single process template by slug
put
Modify an existing process template
delete
Delete an existing process template
post
Share new process template to spaces
get
Get all the available variable names for a process template
post
Create a process template version
get
Retrieve a single process template and its version by version mask
get
Get the icon for a given process template version
get
Retrieve a single process template and its version by version mask
get
Get the icon for a given process template version
Progression
18
get
Return a list of runbook dashboard items, filtered by various criteria including projectIds, environmentIds, tenantIds, tenantTags, runbookIds, runbookTags, taskIds
get
Get the progress of a runbook in the environment lifecycle.
get
Get the progress of a runbook in the environment lifecycle.
get
Get the progress of a release in the environment lifecycle.
get
Get the progress of a release in the environment lifecycle.
get
Get the progress of a release in the environment lifecycle.
get
Return a list of runbook dashboard items, filtered by various criteria including projectIds, environmentIds, tenantIds, tenantTags, runbookIds, runbookTags, taskIds
get
Get the progress of a runbook in the environment lifecycle.
get
Get the progress of a runbook in the environment lifecycle.
get
Get the progress of a release in the environment lifecycle.
get
Get the progress of a release in the environment lifecycle.
get
Get the progress of a release in the environment lifecycle.
get
Return a list of runbook dashboard items, filtered by various criteria including projectIds, environmentIds, tenantIds, tenantTags, runbookIds, runbookTags, taskIds
get
Get the progress of a runbook in the environment lifecycle.
get
Get the progress of a runbook in the environment lifecycle.
get
Get the progress of a release in the environment lifecycle.
get
Get the progress of a release in the environment lifecycle.
get
Get the progress of a release in the environment lifecycle.
ProjectGroups
21
get
Get a paginated list of the Project Groups in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.
post
Create a new project group.
get
List the name and ID of all of the Project Groups in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.
get
Get a Project Group by ID
put
Modify an existing project group.
delete
Delete an existing Project Group
get
Get a paginated list of the Projects that belong to the given Project Group
get
Get a paginated list of the Project Groups in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.
post
Create a new project group.
get
List the name and ID of all of the Project Groups in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.
get
Get a Project Group by ID
put
Modify an existing project group.
delete
Delete an existing Project Group
get
Get a paginated list of the Projects that belong to the given Project Group
get
Get a paginated list of the Project Groups in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.
post
Create a new project group.
get
List the name and ID of all of the Project Groups in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.
get
Get a Project Group by ID
put
Modify an existing project group.
delete
Delete an existing Project Group
get
Get a paginated list of the Projects that belong to the given Project Group
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
post
Share a project template to spaces
ProjectTriggers
30
get
Get Project Triggers within a given Project
post
Create a new project trigger
get
Get project trigger by project id and trigger id
put
Modify a ProjectTriggerResource by ID
delete
Delete an existing Project Trigger
get
Get a list of Project Triggers.
post
Create a new project trigger
get
Get a Project Trigger by ID
put
Modify a ProjectTriggerResource by ID
delete
Delete an existing Project Trigger
get
Get Project Triggers within a given Project
post
Create a new project trigger
get
Get project trigger by project id and trigger id
put
Modify a ProjectTriggerResource by ID
delete
Delete an existing Project Trigger
get
Get a list of Project Triggers.
post
Create a new project trigger
get
Get a Project Trigger by ID
put
Modify a ProjectTriggerResource by ID
delete
Delete an existing Project Trigger
get
Get Project Triggers within a given Project
post
Create a new project trigger
get
Get project trigger by project id and trigger id
put
Modify a ProjectTriggerResource by ID
delete
Delete an existing Project Trigger
get
Get a list of Project Triggers.
post
Create a new project trigger
get
Get a Project Trigger by ID
put
Modify a ProjectTriggerResource by ID
delete
Delete an existing Project Trigger
Proxies
18
get
Get a list of Proxies
post
Create a Proxy in the specified Space
get
Get a list of Proxies
get
Get a Proxy by ID
put
Modify the specified Proxy in the specified Space
delete
Delete an existing Proxy by Id.
get
Get a list of Proxies
post
Create a Proxy in the specified Space
get
Get a list of Proxies
get
Get a Proxy by ID
put
Modify the specified Proxy in the specified Space
delete
Delete an existing Proxy by Id.
get
Get a list of Proxies
post
Create a Proxy in the specified Space
get
Get a list of Proxies
get
Get a Proxy by ID
put
Modify the specified Proxy in the specified Space
delete
Delete an existing Proxy by Id.
RateLimiting
3
get
List all rate limiting policies.
get
Get a rate limiting policy by ID.
put
Modify an existing rate limiting policy.
Releases
68
get
List all of the releases that belong to the given Channel.
get
List all of the releases that belong to the given Channel.
get
List all of the releases that belong to the given Project.
get
Get a list of Variable Sets included in the Release's current Variable Snapshot
get
Get a single release by project ID and version number.
get
Get a list of Releases for the given Space.
post
Create a Release
post
Create a Release
get
Get a Release by ID
put
Update an existing Release
delete
Delete an existing release, along with all of the deployments, tasks and other associated resources belonging to the release.
get
Get all of the information necessary for creating or editing a deployment for this release.
get
Get all defects for a release.
post
Record defect in a release.
post
Resolve defect in a release.
get
List all of the Deployments that belong to the given Release.
get
Get a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).
get
Get a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).
post
Return an array of documents that describes what steps will/won't be run during deployments to a given set of environments and tenants.
get
Get all of the information necessary for creating or editing a deployment for this release.
post
Update the release notes on an existing Release.
post
Update the Variable Snapshot for a Release
get
List all of the releases that belong to the given Channel.
get
List all of the releases that belong to the given Channel.
get
List all of the releases that belong to the given Project.
get
Get a list of Variable Sets included in the Release's current Variable Snapshot
get
Get a single release by project ID and version number.
get
Get a list of Releases for the given Space.
post
Create a Release
post
Create a Release
get
Get a Release by ID
put
Update an existing Release
delete
Delete an existing release, along with all of the deployments, tasks and other associated resources belonging to the release.
get
Get all of the information necessary for creating or editing a deployment for this release.
get
Get all defects for a release.
post
Record defect in a release.
post
Resolve defect in a release.
get
List all of the Deployments that belong to the given Release.
get
Get a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).
get
Get a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).
post
Return an array of documents that describes what steps will/won't be run during deployments to a given set of environments and tenants.
get
Get the list of Packages that are missing from the built-in feed for a release
get
Get all of the information necessary for creating or editing a deployment for this release.
post
Update the release notes on an existing Release.
post
Update the Variable Snapshot for a Release
get
List all of the releases that belong to the given Channel.
get
List all of the releases that belong to the given Channel.
get
List all of the releases that belong to the given Project.
get
Get a list of Variable Sets included in the Release's current Variable Snapshot
get
Get a single release by project ID and version number.
get
Get a list of Releases for the given Space.
post
Create a Release
post
Create a Release
get
Get a Release by ID
put
Update an existing Release
delete
Delete an existing release, along with all of the deployments, tasks and other associated resources belonging to the release.
get
Get all of the information necessary for creating or editing a deployment for this release.
get
Get all defects for a release.
post
Record defect in a release.
post
Resolve defect in a release.
get
List all of the Deployments that belong to the given Release.
get
Get a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).
get
Get a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).
post
Return an array of documents that describes what steps will/won't be run during deployments to a given set of environments and tenants.
get
Get the list of Packages that are missing from the built-in feed for a release
get
Get all of the information necessary for creating or editing a deployment for this release.
post
Update the release notes on an existing Release.
post
Update the Variable Snapshot for a Release
Reporting
3
get
Get an XML report of deployments
get
Get an XML report of deployments
get
Get an XML report of deployments
Retention
8
get
Get the default retention configuration
put
Update the default retention configuration.
get
Get the configured default retention policies for the given retention type
put
Modify a default retention policy.
get
Get the configured default retention policies for the given retention type
put
Modify a default retention policy.
get
Get the configured default retention policies for the given retention type
put
Modify a default retention policy.
RolloutGroups
10
get
Lists rollout groups within a project.
post
Creates a rollout group within a project.
get
Retrieves a rollout group by Id.
put
Modifies a rollout group.
delete
Deletes a rollout group.
get
Lists rollout groups within a project.
post
Creates a rollout group within a project.
get
Retrieves a rollout group by Id.
put
Modifies a rollout group.
delete
Deletes a rollout group.
RunbookProcesses
30
get
Get a list of Runbook Processes
get
Get the runbook process for the given ID
put
Modify a Runbook Process.
get
Get all of the information necessary for creating or editing a Runbook Snapshot using this Runbook Process
get
Get the runbook process for the given ID
put
Modify a Runbook Process.
get
Get a list of Runbook Processes
get
Get the runbook process for the given ID
put
Modify a Runbook Process.
get
Get all of the information necessary for creating or editing a Runbook Snapshot using this Runbook Process
get
Get a list of Runbook Processes
get
Get the runbook process for the given ID
put
Modify a Runbook Process.
get
Get all of the information necessary for creating or editing a Runbook Snapshot using this Runbook Process
get
Get the runbook process for the given ID
put
Modify a Runbook Process.
get
Get a list of Runbook Processes
get
Get the runbook process for the given ID
put
Modify a Runbook Process.
get
Get all of the information necessary for creating or editing a Runbook Snapshot using this Runbook Process
get
Get a list of Runbook Processes
get
Get the runbook process for the given ID
put
Modify a Runbook Process.
get
Get all of the information necessary for creating or editing a Runbook Snapshot using this Runbook Process
get
Get the runbook process for the given ID
put
Modify a Runbook Process.
get
Get a list of Runbook Processes
get
Get the runbook process for the given ID
put
Modify a Runbook Process.
get
Get all of the information necessary for creating or editing a Runbook Snapshot using this Runbook Process
RunbookRuns
33
get
Get a list of Runbook Runs
post
Create a new Runbook Run
get
Get a Runbook Run by ID
delete
Delete an existing Runbook Run
post
Create a new Runbook run based on an existing runbook run
post
Create a new Runbook Run
post
Create a new runbook run
get
Get a list of Runbook Runs
post
Create a new Runbook Run
get
Get a Runbook Run by ID
delete
Delete an existing Runbook Run
get
Get a list of Runbook Runs
post
Create a new Runbook Run
get
Get a Runbook Run by ID
delete
Delete an existing Runbook Run
post
Create a new Runbook run based on an existing runbook run
post
Create a new Runbook Run
post
Create a new runbook run
get
Get a list of Runbook Runs
post
Create a new Runbook Run
get
Get a Runbook Run by ID
delete
Delete an existing Runbook Run
get
Get a list of Runbook Runs
post
Create a new Runbook Run
get
Get a Runbook Run by ID
delete
Delete an existing Runbook Run
post
Create a new Runbook run based on an existing runbook run
post
Create a new Runbook Run
post
Create a new runbook run
get
Get a list of Runbook Runs
post
Create a new Runbook Run
get
Get a Runbook Run by ID
delete
Delete an existing Runbook Run
Runbooks
115
get
Retrieve a list of Runbooks that will be converted to Git, along with how many RunbookRun History records will be updated.
get
Retrieve a list of Runbooks that will be converted to Git, along with how many RunbookRun History records will be updated.
get
Get a paginated list of the Runbooks that belong to the given Project
post
Create a new Runbook or clone an existing Runbook.
get
Get a list of Runbooks for a Project
get
Get a Runbook by ID
put
Update an existing Runbook
delete
Delete an existing Runbook
get
Get a list of environments a Runbook can be run within, based on its EnvironmentScope.
get
Get a Runbook Run Preview for a Runbook
get
Get a Runbook Run Preview for a Runbook
get
Get all of the information necessary for creating or editing a Runbook Run for this Runbook (when you do not have a snapshot).
post
Run the published version of this Runbook
post
Get a list of Runbook Run Previews for a Runbook
get
Get all of the information necessary for creating or editing a Snapshot for a Runbook
get
Get a paginated list of the Runbooks that belong to the given Project
get
Get a Runbook by ID
put
Update an existing Runbook
delete
Delete an existing Runbook
get
Get a list of environments a Runbook can be run within, based on its EnvironmentScope.
get
Get a Runbook Run Preview for a Runbook
get
Get a Runbook Run Preview for a Runbook
get
Get all of the information necessary for creating or editing a Runbook Run for this Runbook (when you do not have a snapshot).
post
Get a list of Runbook Run Previews for a Runbook
get
Get all of the information necessary for creating or editing a Snapshot for a Runbook
get
Get a list of Runbooks
post
Create a new Runbook or clone an existing Runbook.
get
Get a list of Runbooks
get
Get a Runbook by ID
put
Update an existing Runbook
delete
Delete an existing Runbook
get
Get a list of environments a Runbook can be run within, based on its EnvironmentScope.
get
Get a Runbook Run Preview for a Runbook
get
Get a Runbook Run Preview for a Runbook
get
Get all of the information necessary for creating or editing a Runbook Run for this Runbook (when you do not have a snapshot).
post
Run the published version of this Runbook
get
Get all of the information necessary for creating or editing a Snapshot for a Runbook
get
Get a paginated list of the Runbooks that belong to the given Project
post
Create a new Runbook or clone an existing Runbook.
get
Get a list of Runbooks for a Project
post
Create a new Database Runbook
get
Get a Runbook by ID
put
Update an existing Runbook
delete
Delete an existing Runbook
get
Get a list of environments a Runbook can be run within, based on its EnvironmentScope.
get
Get a list of environments a Runbook can be run within, based on its EnvironmentScope.
get
Get a Runbook Run Preview for a Runbook
get
Get a Runbook Run Preview for a Runbook
get
Get all of the information necessary for creating or editing a Runbook Run for this Runbook (when you do not have a snapshot).
post
Run the published version of this Runbook
post
Get a list of Runbook Run Previews for a Runbook
get
Get all of the information necessary for creating or editing a Snapshot for a Runbook
get
Get a paginated list of the Runbooks that belong to the given Project
post
Create a new Git runbook
get
Get a Runbook by ID
put
Update an existing Runbook
delete
Delete an existing Runbook
get
Get a list of environments a Runbook can be run within, based on its EnvironmentScope.
get
Get a list of environments a Runbook can be run within, based on its EnvironmentScope.
get
Get a Runbook Run Preview for a Runbook
get
Get a Runbook Run Preview for a Runbook
get
Get all of the information necessary for creating or editing a Runbook Run for this Runbook (when you do not have a snapshot).
post
Get a list of Runbook Run Previews for a Runbook
get
Get all of the information necessary for creating or editing a Snapshot for a Runbook
get
Get a list of Runbooks
post
Create a new Runbook or clone an existing Runbook.
get
Get a list of Runbooks
get
Get a Runbook by ID
put
Update an existing Runbook
delete
Delete an existing Runbook
get
Get a list of environments a Runbook can be run within, based on its EnvironmentScope.
get
Get a Runbook Run Preview for a Runbook
get
Get a Runbook Run Preview for a Runbook
get
Get all of the information necessary for creating or editing a Runbook Run for this Runbook (when you do not have a snapshot).
post
Run the published version of this Runbook
get
Get all of the information necessary for creating or editing a Snapshot for a Runbook
get
Get a paginated list of the Runbooks that belong to the given Project
post
Create a new Runbook or clone an existing Runbook.
get
Get a list of Runbooks for a Project
post
Create a new Database Runbook
get
Get a Runbook by ID
put
Update an existing Runbook
delete
Delete an existing Runbook
get
Get a list of environments a Runbook can be run within, based on its EnvironmentScope.
get
Get a list of environments a Runbook can be run within, based on its EnvironmentScope.
get
Get a Runbook Run Preview for a Runbook
get
Get a Runbook Run Preview for a Runbook
get
Get all of the information necessary for creating or editing a Runbook Run for this Runbook (when you do not have a snapshot).
post
Run the published version of this Runbook
post
Get a list of Runbook Run Previews for a Runbook
get
Get all of the information necessary for creating or editing a Snapshot for a Runbook
get
Get a paginated list of the Runbooks that belong to the given Project
post
Create a new Git runbook
get
Get a Runbook by ID
put
Update an existing Runbook
delete
Delete an existing Runbook
get
Get a list of environments a Runbook can be run within, based on its EnvironmentScope.
get
Get a list of environments a Runbook can be run within, based on its EnvironmentScope.
get
Get a Runbook Run Preview for a Runbook
get
Get a Runbook Run Preview for a Runbook
get
Get all of the information necessary for creating or editing a Runbook Run for this Runbook (when you do not have a snapshot).
post
Get a list of Runbook Run Previews for a Runbook
get
Get all of the information necessary for creating or editing a Snapshot for a Runbook
get
Get a list of Runbooks
post
Create a new Runbook or clone an existing Runbook.
get
Get a list of Runbooks
get
Get a Runbook by ID
put
Update an existing Runbook
delete
Delete an existing Runbook
get
Get a list of environments a Runbook can be run within, based on its EnvironmentScope.
get
Get a Runbook Run Preview for a Runbook
get
Get a Runbook Run Preview for a Runbook
get
Get all of the information necessary for creating or editing a Runbook Run for this Runbook (when you do not have a snapshot).
post
Run the published version of this Runbook
get
Get all of the information necessary for creating or editing a Snapshot for a Runbook
RunbookSnapshots
77
get
Get a paginated list of all of the Runbook Snapshots that belong to the given Runbook.
get
Get a paginated list of all of the Runbook Snapshots that belong to the given Project.
post
Create a Runbook Snapshot
get
Get a single Runbook Snapshot by project ID and name.
put
Modify a Runbook Snapshot
delete
Delete an existing Runbook Snapshot
get
Get the runbook runs for the given snapshot.
get
Get a Runbook Run Preview for a Runbook Snapshot
get
Get a Runbook Run Preview for a Runbook Snapshot
get
Get a Runbook Run Template for a Runbook Snapshot
post
Update the variable snapshots for a Runbook Snapshot
post
Update the variable snapshots for a Runbook Snapshot
get
Get a list of Variable Sets included in the Runbook Snapshot's current Variable Snapshot
post
Get a list of Runbook Run Previews for a Runbook Snapshot
get
Get a paginated list of all of the Runbook Snapshots that belong to the given Runbook.
get
Get a paginated list of Runbook Snapshots
post
Create a Runbook Snapshot
get
Get a Runbook Snapshot by ID
put
Modify a Runbook Snapshot
delete
Delete an existing Runbook Snapshot
get
Get the runbook runs for the given snapshot.
get
Get a Runbook Run Preview for a Runbook Snapshot
get
Get a Runbook Run Preview for a Runbook Snapshot
get
Get a Runbook Run Template for a Runbook Snapshot
post
Update the variable snapshots for a Runbook Snapshot
get
Get the packages and Git references that were used in a Runbook run
get
Get a paginated list of all of the Runbook Snapshots that belong to the given Runbook.
get
Get a paginated list of all of the Runbook Snapshots that belong to the given Project.
post
Create a Runbook Snapshot
get
Get a single Runbook Snapshot by project ID and name.
put
Modify a Runbook Snapshot
delete
Delete an existing Runbook Snapshot
get
Get the runbook runs for the given snapshot.
get
Get a Runbook Run Preview for a Runbook Snapshot
get
Get a Runbook Run Preview for a Runbook Snapshot
get
Get a Runbook Run Template for a Runbook Snapshot
post
Update the variable snapshots for a Runbook Snapshot
post
Update the variable snapshots for a Runbook Snapshot
get
Get a list of Variable Sets included in the Runbook Snapshot's current Variable Snapshot
post
Get a list of Runbook Run Previews for a Runbook Snapshot
get
Get a paginated list of all of the Runbook Snapshots that belong to the given Runbook.
get
Get a paginated list of Runbook Snapshots
post
Create a Runbook Snapshot
get
Get a Runbook Snapshot by ID
put
Modify a Runbook Snapshot
delete
Delete an existing Runbook Snapshot
get
Get the runbook runs for the given snapshot.
get
Get a Runbook Run Preview for a Runbook Snapshot
get
Get a Runbook Run Preview for a Runbook Snapshot
get
Get a Runbook Run Template for a Runbook Snapshot
post
Update the variable snapshots for a Runbook Snapshot
get
Get the packages and Git references that were used in a Runbook run
get
Get a paginated list of all of the Runbook Snapshots that belong to the given Runbook.
get
Get a paginated list of all of the Runbook Snapshots that belong to the given Project.
post
Create a Runbook Snapshot
get
Get a single Runbook Snapshot by project ID and name.
put
Modify a Runbook Snapshot
delete
Delete an existing Runbook Snapshot
get
Get the runbook runs for the given snapshot.
get
Get a Runbook Run Preview for a Runbook Snapshot
get
Get a Runbook Run Preview for a Runbook Snapshot
get
Get a Runbook Run Template for a Runbook Snapshot
post
Update the variable snapshots for a Runbook Snapshot
post
Update the variable snapshots for a Runbook Snapshot
get
Get a list of Variable Sets included in the Runbook Snapshot's current Variable Snapshot
post
Get a list of Runbook Run Previews for a Runbook Snapshot
get
Get a paginated list of all of the Runbook Snapshots that belong to the given Runbook.
get
Get a paginated list of Runbook Snapshots
post
Create a Runbook Snapshot
get
Get a Runbook Snapshot by ID
put
Modify a Runbook Snapshot
delete
Delete an existing Runbook Snapshot
get
Get the runbook runs for the given snapshot.
get
Get a Runbook Run Preview for a Runbook Snapshot
get
Get a Runbook Run Preview for a Runbook Snapshot
get
Get a Runbook Run Template for a Runbook Snapshot
post
Update the variable snapshots for a Runbook Snapshot
ScheduledJobs
6
get
Get the status of all the scheduled jobs
get
Enable a scheduled job or the job scheduler
get
Disable a scheduled job or the job scheduler
get
Trigger a scheduled job immediately and waits for it to complete
get
Get the structured log for a scheduled job
get
Get the raw log for a scheduled job
ScopedUserRoles
15
get
List the name and ID of all of the scoped user roles in the supplied Octopus Deploy Space. The results will be sorted by name.
post
Create a scoped user role.
get
Get a Scoped User Role by ID.
put
Modify a scoped user role.
delete
Delete an existing Scoped User Role.
get
List the name and ID of all of the scoped user roles in the supplied Octopus Deploy Space. The results will be sorted by name.
post
Create a scoped user role.
get
Get a Scoped User Role by ID.
put
Modify a scoped user role.
delete
Delete an existing Scoped User Role.
get
List the name and ID of all of the scoped user roles in the supplied Octopus Deploy Space. The results will be sorted by name.
post
Create a scoped user role.
get
Get a Scoped User Role by ID.
put
Modify a scoped user role.
delete
Delete an existing Scoped User Role.
Server
3
get
Request the current server configuration
put
Set the server configuration
get
Request the current server configuration settings
ServerStatus
9
get
Get the status of Octopus Server.
get
Get counts of documents in the server
post
Force a GC collect.
post
Force a GC collect.
get
Get the general health of Octopus Server.
get
Retrieve the most recent high-priority log messages from this execution of the Octopus Server process.
get
Provide information about the Octopus Server process and the machine on which it is running.
get
Create a .zip archive containing an aggregate of the other system information APIs.
get
List timezones supported by the server.
ServerTaskApprovals
6
get
Gets a paginated list of server task approvals
get
Retrieves details of a specific server task approval by its ID.
get
Gets a server task approval and associated approvals by task id
get
Gets a paginated list of server task approvals
get
Retrieves details of a specific server task approval by its ID.
get
Gets a server task approval and associated approvals by task id
ServiceAccountOidcIdentities
5
post
Create new OIDC Identity for a Service Account
get
Get ServiceAccountOidcIdentities
get
Get ServiceAccountOidcIdentity by id
put
Modify ServiceAccountOidcIdentity
delete
Delete ServiceAccountOidcIdentity
Signing
5
get
Request the current signing key configuration
put
Set the signing key configuration
post
Create a new key that is pending activation.
post
Activate an existing pending signing key, making it the active signing key for the system.
post
Validate that the public signing keys are valid and can be used to verify signatures. This is intended to be used as a health check for external key hosting, and will return an error if the keys are invalid or expired.
SlackIntegration
8
get
/integrations/slack/channels
get
/integrations/slack/channels/resolve
get
/integrations/slack/configuration
delete
/integrations/slack/connection
post
/integrations/slack/connection/test
post
/integrations/slack/credentials
get
/integrations/slack/oauth/callback
get
/integrations/slack/oauth/start
Smtp
5
get
Get information about the SMTP (email) settings in use by the Octopus Server.
put
Update the SMTP settings used by the Octopus Server.
get
Check whether SMTP is configured with low privileges
get
Check whether SMTP is configured with low privileges
get
Get information about the SMTP (email) settings in use by the Octopus Server.
Spaces
49
get
Get a list of Spaces
post
Create a new Space
get
Get a list of Spaces
post
Create a new Space
get
Get a Space by ID
put
Update a Space
delete
Delete an existing Space.
get
Get the logo for the space with the given space ID.
put
Modify the logo of the space with the given space ID.
post
Modify the logo of the space with the given space ID.
get
Search in the supplied Octopus Deploy Space using the given keyword.
delete
Delete an existing Space.
get
Get a list of spaces available to the current authenticated user only.
get
Get a collection of Git credentials
post
Create a new Git credential
get
Get a collection of Git credentials
post
Create a new Git credential
get
Get a collection of Git credentials
post
Create a new Git credential
get
Get a specific Git credential
put
Modify an existing Git credential
delete
Delete an existing Git credential
get
Get usage of a specific Git credential
get
Get usage of a specific Git credential
get
Get a specific Git credential
put
Modify an existing Git credential
delete
Delete an existing Git credential
get
Get a specific Git credential
put
Modify an existing Git credential
get
Get the git references that match the given rule pattern for a project
get
Search in the supplied Octopus Deploy Space using the given keyword.
get
Get a collection of Git credentials
post
Create a new Git credential
get
Get a collection of Git credentials
post
Create a new Git credential
get
Get a collection of Git credentials
post
Create a new Git credential
get
Get a specific Git credential
put
Modify an existing Git credential
delete
Delete an existing Git credential
get
Get usage of a specific Git credential
get
Get usage of a specific Git credential
get
Get a specific Git credential
put
Modify an existing Git credential
delete
Delete an existing Git credential
get
Get a specific Git credential
put
Modify an existing Git credential
get
Get the git references that match the given rule pattern for a project
get
Search in the supplied Octopus Deploy Space using the given keyword.
SshKnownHosts
3
get
Get a list of SSH Known Hosts
post
Add new SSH Known Hosts from a list of entries
delete
Delete the specific SSH Known Host
Subscriptions
18
get
Get a list of Subscriptions
post
Create a new Subscription
get
Get all Subscriptions
get
Get a Subscription by ID
put
Update an existing Subscription
delete
Delete an existing Subscription
get
Get a list of Subscriptions
post
Create a new Subscription
get
Get all Subscriptions
get
Get a Subscription by ID
put
Update an existing Subscription
delete
Delete an existing Subscription
get
Get a list of Subscriptions
post
Create a new Subscription
get
Get all Subscriptions
get
Get a Subscription by ID
put
Update an existing Subscription
delete
Delete an existing Subscription
TagSets
21
get
Get a list of Tag Sets
post
Create a new Tag Set.
get
Get a list of Tag Sets
put
/tagsets/sortorder
get
Get a Tag Set by ID
put
Modify an existing Tag Set.
delete
Delete an existing Tag Set
get
Get a list of Tag Sets
post
Create a new Tag Set.
get
Get a list of Tag Sets
put
/{spaceId}/tagsets/sortorder
get
Get a Tag Set by ID
put
Modify an existing Tag Set.
delete
Delete an existing Tag Set
get
Get a list of Tag Sets
post
Create a new Tag Set.
get
Get a list of Tag Sets
put
/spaces/{spaceIdentifier}/tagsets/sortorder
get
Get a Tag Set by ID
put
Modify an existing Tag Set.
delete
Delete an existing Tag Set
Tasks
36
get
List all of the tasks in the supplied Octopus Deploy Space. The results will be sorted from newest to oldest.
post
Create a new Task.
post
Create a new task and execute it, using a given task as the input. Note that deployment tasks cannot be re-run.
get
List supported task types.
get
Get a single Task by ID.
post
Mark the given task as canceled.
get
Get a single task by ID, including the full task log as a tree of activity elements.
post
Prioritize given task to the top of the Task Queue
get
Get a list of tasks that this task is currently queued behind.
get
Get the full task log of a given resource as plain text. Useful when the log needs to be rendered to a console or sent as an email attachment.
post
Change the state of a task
get
Get messages for a single Task by Id
get
List all of the tasks in the supplied Octopus Deploy Space. The results will be sorted from newest to oldest.
post
Create a new Task.
post
Create a new task and execute it, using a given task as the input. Note that deployment tasks cannot be re-run.
get
List supported task types.
get
Get a single Task by ID.
post
Mark the given task as canceled.
get
Get a single task by ID, including the full task log as a tree of activity elements.
post
Prioritize given task to the top of the Task Queue
get
Get a list of tasks that this task is currently queued behind.
get
Get the full task log of a given resource as plain text. Useful when the log needs to be rendered to a console or sent as an email attachment.
post
Change the state of a task
get
Get messages for a single Task by Id
get
List all of the tasks in the supplied Octopus Deploy Space. The results will be sorted from newest to oldest.
post
Create a new Task.
post
Create a new task and execute it, using a given task as the input. Note that deployment tasks cannot be re-run.
get
List supported task types.
get
Get a single Task by ID.
post
Mark the given task as canceled.
get
Get a single task by ID, including the full task log as a tree of activity elements.
post
Prioritize given task to the top of the Task Queue
get
Get a list of tasks that this task is currently queued behind.
get
Get the full task log of a given resource as plain text. Useful when the log needs to be rendered to a console or sent as an email attachment.
post
Change the state of a task
get
Get messages for a single Task by Id
TeamMemberships
9
get
Get a list of Team Memberships for a user.
post
Preview Users that would belong to the specified Team
get
Get a list of Team Memberships for a user.
get
Get a list of Team Memberships for a user.
post
Preview Users that would belong to the specified Team
get
Get a list of Team Memberships for a user.
get
Get a list of Team Memberships for a user.
post
Preview Users that would belong to the specified Team
get
Get a list of Team Memberships for a user.
Teams
21
get
Get a list of Teams
post
Create a new team
get
Get a list of Teams
get
Get a Team by ID
put
Modify an existing Team
delete
Delete an existing Team.
get
Get a list of a Team's Scoped User Roles.
get
Get a list of Teams
post
Create a new team
get
Get a list of Teams
get
Get a Team by ID
put
Modify an existing Team
delete
Delete an existing Team.
get
Get a list of a Team's Scoped User Roles.
get
Get a list of Teams
post
Create a new team
get
Get a list of Teams
get
Get a Team by ID
put
Modify an existing Team
delete
Delete an existing Team.
get
Get a list of a Team's Scoped User Roles.
Telemetry
4
get
Get the latest telemetry data.
get
Get the last telemetry task
get
Get the Telemetry configuration
put
Update the Telemetry Configuration
Tenants
66
get
Get a list of tenants
post
Create a new Tenant.
get
List all tenants
get
Report back the status of multi-tenancy.
get
Check tenants for matching tags
get
Return a list of tenants who are missing required variables.
get
Get a tenant by it's Id
put
Modify an existing Tenant.
delete
Delete an existing Tenant.
get
Get the logo associated with the Tenant.
put
Modify the logo associated with the tenant.
post
Modify the logo associated with the tenant.
get
Get variables associated with the provided tenant ID.
put
Create or Update the variables associated with the tenant.
post
Create or Update the variables associated with the tenant.
get
Get the common variables associated with the tenant.
put
Create or Update the common variables associated with the tenant.
post
Create or Update the common variables associated with the tenant.
get
Get the project variables associated with the tenant.
put
Create or Update the project variables associated with the tenant.
post
Create or Update the project variables associated with the tenant.
get
List all of the tenant variables in the supplied Octopus Deploy Space. The results will be sorted alphabetically by id.
get
Get a list of tenants
post
Create a new Tenant.
get
List all tenants
get
Report back the status of multi-tenancy.
get
Check tenants for matching tags
get
Return a list of tenants who are missing required variables.
get
Get a tenant by it's Id
put
Modify an existing Tenant.
delete
Delete an existing Tenant.
get
Get the logo associated with the Tenant.
put
Modify the logo associated with the tenant.
post
Modify the logo associated with the tenant.
get
Get variables associated with the provided tenant ID.
put
Create or Update the variables associated with the tenant.
post
Create or Update the variables associated with the tenant.
get
Get the common variables associated with the tenant.
put
Create or Update the common variables associated with the tenant.
post
Create or Update the common variables associated with the tenant.
get
Get the project variables associated with the tenant.
put
Create or Update the project variables associated with the tenant.
post
Create or Update the project variables associated with the tenant.
get
List all of the tenant variables in the supplied Octopus Deploy Space. The results will be sorted alphabetically by id.
get
Get a list of tenants
post
Create a new Tenant.
get
List all tenants
get
Report back the status of multi-tenancy.
get
Check tenants for matching tags
get
Return a list of tenants who are missing required variables.
get
Get a tenant by it's Id
put
Modify an existing Tenant.
delete
Delete an existing Tenant.
get
Get the logo associated with the Tenant.
put
Modify the logo associated with the tenant.
post
Modify the logo associated with the tenant.
get
Get variables associated with the provided tenant ID.
put
Create or Update the variables associated with the tenant.
post
Create or Update the variables associated with the tenant.
get
Get the common variables associated with the tenant.
put
Create or Update the common variables associated with the tenant.
post
Create or Update the common variables associated with the tenant.
get
Get the project variables associated with the tenant.
put
Create or Update the project variables associated with the tenant.
post
Create or Update the project variables associated with the tenant.
get
List all of the tenant variables in the supplied Octopus Deploy Space. The results will be sorted alphabetically by id.
TokenExchange
1
post
Exchange an Oidc token for an access token that allows access to the API
Upgrade
2
get
Get information about the upgrade configuration in use by the Octopus Server.
put
Update the upgrade configuration used by the Octopus Server.
UserPermissions
9
get
Get the user's permission information
get
Get the user's permission information
get
Get a list of permissions for the currently authenticated user.
get
Get the user's permission information
get
Get the user's permission information
get
Get a list of permissions for the currently authenticated user.
get
Get the user's permission information
get
Get the user's permission information
get
Get a list of permissions for the currently authenticated user.
UserRoles
6
get
Get a list of User Roles.
post
Create a custom user role definition.
get
Get a list of User Roles.
get
Get a User Role by ID.
put
Modify an existing User Role
delete
Delete an existing User Role.
Users
15
get
Get a list of Users.
post
Create a new user.
get
Get a list of Users.
get
Provide the details of the enabled authentication providers and whether the current user can edit logins for the given user.
get
Provide the details of the enabled authentication providers and whether the current user can edit logins for the given user.
get
Search for users, using the authentication providers
get
Get the metadata to describe the claims/fields used by authentication providers that support identities.
post
Log in.
post
/users/logout
get
Get information about the current user.
post
Register a new user and responds with an authentication cookie. Unless the first administrator user is being registered, an invitation code must be provided.
get
Get a User by ID.
put
Modify an existing user.
delete
Delete an existing User
put
Revoke all sessions for a user.
Variables
27
get
Get a list of Variable Sets.
get
Get a list of Variable names.
get
Get a Variable Set preview
get
Get a Variable Set by Id
put
Update a Variable Set
get
Return a summary of the variables that will be migrated to Git.
post
Convert all non-sensitive project variables to be stored in Git rather than the database.
get
Get variables for a project.
put
Modify variables for the project
get
Get variables for a project.
put
Modify variables for the project
get
Get a list of Variable Sets.
get
Get a list of Variable names.
get
Get a Variable Set preview
get
Get a Variable Set by Id
put
Update a Variable Set
get
Return a summary of the variables that will be migrated to Git.
post
Convert all non-sensitive project variables to be stored in Git rather than the database.
get
Get variables for a project.
put
Modify variables for the project
get
Get variables for a project.
put
Modify variables for the project
get
Get a list of Variable Sets.
get
Get a list of Variable names.
get
Get a Variable Set preview
get
Get a Variable Set by Id
put
Update a Variable Set
VersionControl
2
post
Clear the local Git cache.
post
Clear the local Git cache.
Web
2
post
/jiraservicemanagement-integration/connectivity-test
post
/servicenow-integration/connectivity-test
WorkerPools
33
get
Get a list of Worker Pools.
post
Create a new Worker Pool.
get
Get a list of Worker Pools.
get
List the available Worker Types for the Dynamic Worker Pool
put
/workerpools/sortorder
get
List all worker pools, including a summary of worker information.
get
Get the available Worker Pool types.
get
Get a Worker Pool by ID.
put
Modify an existing worker pool.
delete
Delete an existing Worker Pool.
get
Get a list of WorkerResources for the given WorkerPoolResource
get
Get a list of Worker Pools.
post
Create a new Worker Pool.
get
Get a list of Worker Pools.
get
List the available Worker Types for the Dynamic Worker Pool
put
/{spaceId}/workerpools/sortorder
get
List all worker pools, including a summary of worker information.
get
Get the available Worker Pool types.
get
Get a Worker Pool by ID.
put
Modify an existing worker pool.
delete
Delete an existing Worker Pool.
get
Get a list of WorkerResources for the given WorkerPoolResource
get
Get a list of Worker Pools.
post
Create a new Worker Pool.
get
Get a list of Worker Pools.
get
List the available Worker Types for the Dynamic Worker Pool
put
/spaces/{spaceIdentifier}/workerpools/sortorder
get
List all worker pools, including a summary of worker information.
get
Get the available Worker Pool types.
get
Get a Worker Pool by ID.
put
Modify an existing worker pool.
delete
Delete an existing Worker Pool.
get
Get a list of WorkerResources for the given WorkerPoolResource
Workers
33
get
List all of the registered worker machines in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.
post
Create a new worker
get
Get a list of Workers.
get
Interrogate a machine for communication details so that it may be added to the installation.
get
Get all operating system names for workers. The result will be a string array.
get
Get all operating system shell names for workers. The result will be a string array.
get
List all of the registered worker machines in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.
get
Get a Worker by ID
put
Modify an existing worker machine.
delete
Delete an existing Worker.
get
Get the status of the network connection between the Octopus server and a worker.
get
List all of the registered worker machines in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.
post
Create a new worker
get
Get a list of Workers.
get
Interrogate a machine for communication details so that it may be added to the installation.
get
Get all operating system names for workers. The result will be a string array.
get
Get all operating system shell names for workers. The result will be a string array.
get
List all of the registered worker machines in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.
get
Get a Worker by ID
put
Modify an existing worker machine.
delete
Delete an existing Worker.
get
Get the status of the network connection between the Octopus server and a worker.
get
List all of the registered worker machines in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.
post
Create a new worker
get
Get a list of Workers.
get
Interrogate a machine for communication details so that it may be added to the installation.
get
Get all operating system names for workers. The result will be a string array.
get
Get all operating system shell names for workers. The result will be a string array.
get
List all of the registered worker machines in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.
get
Get a Worker by ID
put
Modify an existing worker machine.
delete
Delete an existing Worker.
get
Get the status of the network connection between the Octopus server and a worker.
WorkerTaskLeases
2
get
Get WorkerTaskLeases
get
Get WorkerTaskLeases
AccessTokens
Create an access token for the current user
post
/users/access-token
Response
Contains the created access token.
GenerateAccessTokenResponse
required
AccessToken
string
required