/
OC
octopus
/
Octopus Server API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 8h ago · Updated 3d ago
Swagger 2.0
2026-08-14
1,919
888
3.7 MB
dbbd6d1e3f1c
AccessTokens
1
post
Creates an access token for the current user
Accounts
41
get
Get a list of accounts.
post
Creates a new account - of the type defined by body content
get
Get a list of Accounts
get
Lists the Azure Environments provided by the SDK
put
Modifies the account identified by the accoutId
get
Get an Account by ID
delete
Deletes an existing Account
get
Retrieves the public key portion of the account's associated certificate, if present.
get
Lists the Resource Groups associated with an Azure account.
get
Lists the storage accounts associated with an Azure account.
get
Lists projects and deployments which are using an account.
delete
Deletes an existing Account
get
Lists the websites associated with an Azure account.
get
Lists the slots associated with an Azure Web Site.
get
Get the account types this Octopus Server supports
get
Get a list of accounts.
post
Creates a new account - of the type defined by body content
get
Get a list of Accounts
put
Modifies the account identified by the accoutId
get
Get an Account by ID
delete
Deletes an existing Account
get
Retrieves the public key portion of the account's associated certificate, if present.
get
Lists the Resource Groups associated with an Azure account.
get
Lists the storage accounts associated with an Azure account.
get
Lists projects and deployments which are using an account.
delete
Deletes an existing Account
get
Lists the websites associated with an Azure account.
get
Lists the slots associated with an Azure Web Site.
get
Get a list of accounts.
post
Creates a new account - of the type defined by body content
get
Get a list of Accounts
put
Modifies the account identified by the accoutId
get
Get an Account by ID
delete
Deletes an existing Account
get
Retrieves the public key portion of the account's associated certificate, if present.
get
Lists the Resource Groups associated with an Azure account.
get
Lists the storage accounts associated with an Azure account.
get
Lists projects and deployments which are using an account.
delete
Deletes an existing Account
get
Lists the websites associated with an Azure account.
get
Lists 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
Lists all available action templates including built-in, custom and community contributed step templates.
get
Get an Action Template by ID
put
Modifies an existing action template.
delete
Deletes an existing Action Template and all its versions.
post
Updates deployment and runbook actions to a specific version of the action template
post
Creates a server task to update deployment and runbook actions to a specific version of the action template
get
Gets the logo associated with the latest version of action template.
put
Updates the logo associated with the latest version of the action template.
post
Updates the logo associated with the latest version of the action template.
get
Gets usages for an Action Template.
get
Get an Action Template by ID
delete
Deletes 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
Gets 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
Lists all available action templates including built-in, custom and community contributed step templates.
get
Get an Action Template by ID
put
Modifies an existing action template.
delete
Deletes an existing Action Template and all its versions.
post
Updates deployment and runbook actions to a specific version of the action template
post
Creates a server task to update deployment and runbook actions to a specific version of the action template
get
Gets the logo associated with the latest version of action template.
put
Updates the logo associated with the latest version of the action template.
post
Updates the logo associated with the latest version of the action template.
get
Gets usages for an Action Template.
get
Get an Action Template by ID
delete
Deletes 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
Gets 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
Lists all available action templates including built-in, custom and community contributed step templates.
get
Get an Action Template by ID
put
Modifies an existing action template.
delete
Deletes an existing Action Template and all its versions.
post
Updates deployment and runbook actions to a specific version of the action template
post
Creates a server task to update deployment and runbook actions to a specific version of the action template
get
Gets the logo associated with the latest version of action template.
put
Updates the logo associated with the latest version of the action template.
post
Updates the logo associated with the latest version of the action template.
get
Gets usages for an Action Template.
get
Get an Action Template by ID
delete
Deletes 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
Gets the logo associated with specific version of the action template.
ApiKeys
5
get
Get a list of API Keys for a given User
post
Generates 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
Revokes 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
Lists 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
Modifies an existing artifact.
delete
Deletes an existing Artifact
get
Gets the content associated with an artifact.
put
/artifacts/{id}/content
get
Lists 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
Modifies an existing artifact.
delete
Deletes an existing Artifact
get
Gets the content associated with an artifact.
put
/{spaceId}/artifacts/{id}/content
get
Lists 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
Modifies an existing artifact.
delete
Deletes an existing Artifact
get
Gets the content associated with an artifact.
put
/spaces/{spaceIdentifier}/artifacts/{id}/content
AuditStream
2
get
Gets the audit stream configuration
put
Modifies the audit stream configuration
Authentication
2
get
Get authentication providers
post
Given a URL query string, determines whether an external server (.e.g Okta) has initiated login and if so the provider's name
AzureDevOps
1
post
/azuredevopsissuetracker/connectivitycheck
Branches
21
get
Requests 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
Requests a list of Git Tags for the project
get
Gets an individual Git Tag; searching for it by Name
get
Requests 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
Requests a list of Git Tags for the project
get
Gets an individual Git Tag; searching for it by Name
get
Requests 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
Requests a list of Git Tags for the project
get
Gets an individual Git Tag; searching for it by Name
BuildInformation
15
get
Retrieves a list of build information records describing the vcs information for a given package
post
Creates or updates a specific build information record describing the vcs information for a given package
delete
Bulk deletes specific Build Information records.
get
Retrieves a specific build information record describing the vcs information for a given package
delete
Deletes a specific Build Information record.
get
Retrieves a list of build information records describing the vcs information for a given package
post
Creates or updates a specific build information record describing the vcs information for a given package
delete
Bulk deletes specific Build Information records.
get
Retrieves a specific build information record describing the vcs information for a given package
delete
Deletes a specific Build Information record.
get
Retrieves a list of build information records describing the vcs information for a given package
post
Creates or updates a specific build information record describing the vcs information for a given package
delete
Bulk deletes specific Build Information records.
get
Retrieves a specific build information record describing the vcs information for a given package
delete
Deletes a specific Build Information record.
Capabilities
2
get
Asks the server to return a list of all the Capabilities (Commands and Requests) it supports.
get
Asks 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
Creates a new certificate.
get
Get a list of Certificates
get
Get the global Certificate
post
Create a self-signed Certificate
get
Lists 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
Deletes an existing Certificate
post
Archives an existing Certificate.
post
Archives an existing Certificate.
get
Exports the certificate
post
Replaces an existing Certificate with another
post
Unarchives an existing archived Certificate.
post
Unarchives an existing archived Certificate.
get
/certificates/{id}/usages
get
Requests 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
Creates a new certificate.
get
Get a list of Certificates
post
Create a self-signed Certificate
get
Lists 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
Deletes an existing Certificate
post
Archives an existing Certificate.
post
Archives an existing Certificate.
get
Exports the certificate
post
Replaces an existing Certificate with another
post
Unarchives an existing archived Certificate.
post
Unarchives an existing archived Certificate.
get
/{spaceId}/certificates/{id}/usages
get
List X.509 certificates managed by Octopus
post
Creates a new certificate.
get
Get a list of Certificates
post
Create a self-signed Certificate
get
Lists 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
Deletes an existing Certificate
post
Archives an existing Certificate.
post
Archives an existing Certificate.
get
Exports the certificate
post
Replaces an existing Certificate with another
post
Unarchives an existing archived Certificate.
post
Unarchives an existing archived Certificate.
get
/spaces/{spaceIdentifier}/certificates/{id}/usages
Channels
52
get
Get a list of Channels
post
Creates 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
Tests Channel version rules
post
Tests Channel version rules
get
Get a Channel by ID
put
Updates an existing Channel
delete
Delete a ChannelResource by ID
get
Get a list of ChannelResources for the given ProjectResource
post
Creates a Channel
get
Get a Channel by ID
put
Updates an existing Channel
delete
Delete a ChannelResource by ID
delete
Delete a ChannelResource by ID
get
Get a list of Channels
post
Creates 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
Tests Channel version rules
post
Tests Channel version rules
get
Get a Channel by ID
put
Updates an existing Channel
delete
Delete a ChannelResource by ID
get
Get a list of ChannelResources for the given ProjectResource
post
Creates a Channel
get
Represents a request to determine if a git reference satisfies the rules of a channel.
get
Represents a request to determine if a git reference satisfies channel's Git resource rules.
get
Get a Channel by ID
put
Updates an existing Channel
delete
Delete a ChannelResource by ID
delete
Delete a ChannelResource by ID
get
Get a list of Channels
post
Creates 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
Tests Channel version rules
post
Tests Channel version rules
get
Get a Channel by ID
put
Updates an existing Channel
delete
Delete a ChannelResource by ID
get
Get a list of ChannelResources for the given ProjectResource
post
Creates a Channel
get
Represents a request to determine if a git reference satisfies the rules of a channel.
get
Represents a request to determine if a git reference satisfies channel's Git resource rules.
get
Get a Channel by ID
put
Updates an existing Channel
delete
Delete a ChannelResource by ID
delete
Delete a ChannelResource by ID
CloudTemplate
1
post
Requests 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
Gets installed version of the template.
get
Gets installed version of the template.
put
Updates installed community step template to the latest version.
post
Installs community step template.
put
Updates installed community step template to the latest version.
post
Installs community step template.
get
Gets 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
Requests a paginated set of CompliancePolicyResource sorted by name
post
Create a new policy
get
Requests a single CompliancePolicyResource by slug and git reference
put
Modifies an existing policy
post
Create new version of policy
Configuration
5
get
Returns a list of configuration section settings
get
Returns a single configuration section for the given id
get
Returns a structure that describes how to dynamically render the configuration section
get
Returns the current configuration for a specific configuration section
put
Updates 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
Returns information required to render the Octopus dashboard
get
Returns the information required to render the dynamic dashboard. Deprecated.
get
Returns information required to render the Octopus dashboard
get
Returns the information required to render the dynamic dashboard. Deprecated.
get
Returns information required to render the Octopus dashboard
get
Returns 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
Creates a new deployment freeze.
get
Get a deployment freeze by ID
put
Creates a new deployment freeze.
delete
Deletes 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
Lists all the deployment processes
get
Get a Release Snapshot Template.
get
Gets a specific snapshotted version of a deployment process
put
Modifies a deployment process
get
Gets the deployment process for a project
put
Modifies a deployment process
get
Gets all of the information necessary for creating or editing a release using this deployment process.
post
Validates the deployment process for common non-blocking issues, such as missing deployment targets for tags used within the process steps.
get
Gets the deployment process for a version-controlled project
put
Modifies a deployment process
get
Gets all of the information necessary for creating or editing a release using this deployment process.
post
Validates the deployment process for common non-blocking issues, such as missing deployment targets for tags used within the process steps.
get
Lists all the deployment processes
get
Get a Release Snapshot Template.
get
Gets a specific snapshotted version of a deployment process
put
Modifies a deployment process
get
Gets the deployment process for a project
put
Modifies a deployment process
get
Gets the resolved deployment process for a project.
get
Gets all of the information necessary for creating or editing a release using this deployment process.
post
Validates the deployment process for common non-blocking issues, such as missing deployment targets for tags used within the process steps.
get
Gets the deployment process for a version-controlled project
put
Modifies a deployment process
get
Gets the resolved deployment process for a version-controlled project
get
Gets all of the information necessary for creating or editing a release using this deployment process.
post
Validates the deployment process for common non-blocking issues, such as missing deployment targets for tags used within the process steps.
get
Lists all the deployment processes
get
Get a Release Snapshot Template.
get
Gets a specific snapshotted version of a deployment process
put
Modifies a deployment process
get
Gets the deployment process for a project
put
Modifies a deployment process
get
Gets the resolved deployment process for a project.
get
Gets all of the information necessary for creating or editing a release using this deployment process.
post
Validates the deployment process for common non-blocking issues, such as missing deployment targets for tags used within the process steps.
get
Gets the deployment process for a version-controlled project
put
Modifies a deployment process
get
Gets the resolved deployment process for a version-controlled project
get
Gets all of the information necessary for creating or editing a release using this deployment process.
post
Validates 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
Deletes 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
Deletes 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
Deletes an existing Deployment.
DeploymentSettings
18
get
Gets deployment settings by ID.
put
Modifies deployment settings
get
Gets deployment settings by ID.
put
Modifies deployment settings
get
Gets deployment settings by ID.
put
Modifies deployment settings
get
Gets deployment settings by ID.
put
Modifies deployment settings
get
Gets deployment settings by ID.
put
Modifies deployment settings
get
Gets deployment settings by ID.
put
Modifies deployment settings
get
Gets deployment settings by ID.
put
Modifies deployment settings
get
Gets deployment settings by ID.
put
Modifies deployment settings
get
Gets deployment settings by ID.
put
Modifies deployment settings
DeploymentTargets
45
get
Lists 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
Gets all operating system names for deployment targets.
get
Gets all operating system shell names for deployment targets.
get
Lists all of the registered machines in the supplied Octopus Deploy Space, from all environments. The results will be sorted alphabetically by name.
get
Get an existing Deployment Target.
delete
Deletes 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
Modifies an existing Deployment Target (identified by ID).
get
Lists all the variable set names (projects and library variable sets) that have variables that are scoped to only the given machine
get
Lists 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
Gets all operating system names for deployment targets.
get
Gets all operating system shell names for deployment targets.
get
Lists all of the registered machines in the supplied Octopus Deploy Space, from all environments. The results will be sorted alphabetically by name.
get
Get an existing Deployment Target.
delete
Deletes 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
Modifies an existing Deployment Target (identified by ID).
get
Lists all the variable set names (projects and library variable sets) that have variables that are scoped to only the given machine
get
Lists 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
Gets all operating system names for deployment targets.
get
Gets all operating system shell names for deployment targets.
get
Lists all of the registered machines in the supplied Octopus Deploy Space, from all environments. The results will be sorted alphabetically by name.
get
Get an existing Deployment Target.
delete
Deletes 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
Modifies an existing Deployment Target (identified by ID).
get
Lists 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
Toggles a deprecation on or off in Octopus Server. Used to test the impact of deprecations
post
Toggles 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
Requests the current dynamic extensions feature metadata
get
Requests the current dynamic extensions feature values
put
Modifies the current dynamic extensions feature values.
Environments
47
get
Get a list of Environments.
post
Creates a new environment.
get
Get a list of Environments
get
Get a list of Environments
put
/environments/sortorder
get
Lists all environments, including a summary of machine information
get
Get a list of Environments.
put
Modifies an existing environment.
get
Gets the environment custom settings metadata from the extensions.
get
Lists all the variable set names (projects and library variable sets) that have variables that are scoped to only the given environment
get
Gets a specific Deployment Environment
delete
Deletes an existing Environment
get
Returns the list of machines in an environment that matches the filters requested by the user.
get
Get a list of Environments.
post
Creates a new environment.
get
Get a list of Environments
get
Get a list of Environments
put
/{spaceId}/environments/sortorder
get
Lists all environments, including a summary of machine information
get
Lists all environments, including a summary of machine information
get
Get a list of Environments.
get
Lists Static, Parent and Ephemeral Environments in the supplied Octopus Deploy Space. The results will be sorted by the `SortOrder` field on each environment (which is set to a MaxValue integer for Ephemeral Environments).
put
Modifies an existing environment.
get
Gets the environment custom settings metadata from the extensions.
get
Lists all the variable set names (projects and library variable sets) that have variables that are scoped to only the given environment
get
Gets a specific Deployment Environment
delete
Deletes an existing Environment
get
Returns the list of machines in an environment that matches the filters requested by the user.
get
Gets a specific Static, Parent or Ephemeral Environment by ID
get
Lists environments available for a project.
get
Get a list of Environments.
post
Creates a new environment.
get
Get a list of Environments
get
Get a list of Environments
put
/spaces/{spaceIdentifier}/environments/sortorder
get
Lists all environments, including a summary of machine information
get
Lists all environments, including a summary of machine information
get
Get a list of Environments.
get
Lists Static, Parent and Ephemeral Environments in the supplied Octopus Deploy Space. The results will be sorted by the `SortOrder` field on each environment (which is set to a MaxValue integer for Ephemeral Environments).
put
Modifies an existing environment.
get
Gets the environment custom settings metadata from the extensions.
get
Lists all the variable set names (projects and library variable sets) that have variables that are scoped to only the given environment
get
Gets a specific Deployment Environment
delete
Deletes an existing Environment
get
Returns the list of machines in an environment that matches the filters requested by the user.
get
Gets a specific Static, Parent or Ephemeral Environment by ID
get
Lists environments available for a project.
EphemeralEnvironments
16
post
Deprovision an ephemeral environment
post
Allows the creation of an ephemeral environment in a given space
post
Deprovision an ephemeral environment for a specific project
post
Command to mark a failed deprovisioning as successful for an ephemeral environment
post
Command to retry deprovisioning an ephemeral environment
post
Command to mark a failed provisioning as successful for an ephemeral environment
post
Command to retry provisioning an ephemeral environment
get
Gets the status of an ephemeral environment for a given project
post
Deprovision an ephemeral environment
post
Allows the creation of an ephemeral environment in a given space
post
Deprovision an ephemeral environment for a specific project
post
Command to mark a failed deprovisioning as successful for an ephemeral environment
post
Command to retry deprovisioning an ephemeral environment
post
Command to mark a failed provisioning as successful for an ephemeral environment
post
Command to retry provisioning an ephemeral environment
get
Gets 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
Returns the list of event agents.
get
Lists event categories.
get
Lists subscription event document types.
get
Lists subscription event groups.
get
Gets a single event by ID.
get
Get a list of events
get
Returns the list of event agents.
get
Lists event categories.
get
Lists subscription event document types.
get
Lists subscription event groups.
get
Gets a single event by ID.
get
Get a list of events
get
Returns the list of event agents.
get
Lists event categories.
get
Lists subscription event document types.
get
Lists subscription event groups.
get
Gets 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
Searches the specified feed for packages based on the provided search term
get
Lists 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
Searches the specified feed for packages based on the provided search term
get
Lists 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
Searches the specified feed for packages based on the provided search term
get
Lists 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
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
Used to indicate that a GitHub App Connection should be deleted
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
Used to indicate that a GitHub App Connection should be deleted
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
Modifies the logo of a Space to be a specified icon
post
Modifies the logo of a project to be a specified icon
post
Modifies the logo of a tenant to be a specified icon
post
Modifies the logo of a project to be a specified icon
post
Modifies 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
Requests Insights Deployments for a Report
get
Requests Insights Deployments for a Report
get
/{spaceId}/insights/reports/{reportId}/logo
post
Updates the logo associated with the report.
post
Modifies the logo of an insights report to be a specified icon
post
Modifies 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
Requests Insights Deployments for a Report
get
Requests Insights Deployments for a Report
get
/spaces/{spaceIdentifier}/insights/reports/{reportId}/logo
post
Updates the logo associated with the report.
post
Modifies the logo of an insights report to be a specified icon
post
Modifies 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
Lists 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
Gets the User that is currently responsible for this Interruption (if any).
put
Allows 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
Submits a dictionary of form values for the interruption. Only the user with responsibility for this interruption can submit this form.
get
Lists 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
Gets the User that is currently responsible for this Interruption (if any).
put
Allows 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
Submits a dictionary of form values for the interruption. Only the user with responsibility for this interruption can submit this form.
get
Lists 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
Gets the User that is currently responsible for this Interruption (if any).
put
Allows 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
Submits 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
Gets signing keys used by Octopus Server in JWK format
LDAP
2
get
Search for LDAP groups
get
Search for LDAP users
LetsEncrypt
2
get
Requests the current Let's Encrypt configuration
put
Allows you to disable the Let's Encrypt configuration for this Octopus Server
LibraryVariableSets
27
get
Lists all of the library variable sets in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.
post
Creates 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
Modifies an existing library variable set.
delete
Deletes an existing Library Variable Set.
get
Lists projects and deployments which are using an library variable set.
get
Lists all of the library variable sets in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.
post
Creates 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
Modifies an existing library variable set.
delete
Deletes an existing Library Variable Set.
get
Lists projects and deployments which are using an library variable set.
get
Lists all of the library variable sets in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.
post
Creates 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
Modifies an existing library variable set.
delete
Deletes an existing Library Variable Set.
get
Lists projects and deployments which are using an library variable set.
Licenses
5
get
Returns the details of the current license in use by the Octopus Cluster.
put
Update the current Octopus cluster license.
get
Returns 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
A paginated list of the Lifecycles in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.
post
Create a new Lifecycle.
get
Lists all the lifecycles in the supplied Octopus Deploy Space.
get
Get a list of Lifecycle previews
get
Gets a specific Lifecycle
put
Modify a Lifecycle.
delete
Deletes an existing Lifecycle
get
Gets a Lifecycle preview by Lifecycle id.
get
Gets all projects that use this lifecycle.
get
A paginated list of the Lifecycles in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.
post
Create a new Lifecycle.
get
Lists all the lifecycles in the supplied Octopus Deploy Space.
get
Get a list of Lifecycle previews
get
Gets a specific Lifecycle
put
Modify a Lifecycle.
delete
Deletes an existing Lifecycle
get
Gets a Lifecycle preview by Lifecycle id.
get
Gets all projects that use this lifecycle.
get
A paginated list of the Lifecycles in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.
post
Create a new Lifecycle.
get
Lists all the lifecycles in the supplied Octopus Deploy Space.
get
Get a list of Lifecycle previews
get
Gets a specific Lifecycle
put
Modify a Lifecycle.
delete
Deletes an existing Lifecycle
get
Gets a Lifecycle preview by Lifecycle id.
get
Gets 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
Creates a new Machine Policy
get
Get a list of Machine Policies
get
Gets a template for a new Machine Policy, which includes any defaults.
get
Get a Machine Policy by ID
put
Modifies an existing Machine Policy
delete
Deletes the specified Machine Policy
get
Gets a paginated list of the machines that belong to the given Machine Policy
delete
Deletes the specified Machine Policy
get
Gets 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
Creates a new Machine Policy
get
Get a list of Machine Policies
get
Gets a template for a new Machine Policy, which includes any defaults.
get
Get a Machine Policy by ID
put
Modifies an existing Machine Policy
delete
Deletes the specified Machine Policy
get
Gets a paginated list of the machines that belong to the given Machine Policy
delete
Deletes the specified Machine Policy
get
Gets 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
Creates a new Machine Policy
get
Get a list of Machine Policies
get
Gets a template for a new Machine Policy, which includes any defaults.
get
Get a Machine Policy by ID
put
Modifies an existing Machine Policy
delete
Deletes the specified Machine Policy
get
Gets a paginated list of the machines that belong to the given Machine Policy
delete
Deletes the specified Machine Policy
get
Gets a paginated list of the workers that belong to the given Machine Policy
MachineRoles
6
get
Gets all machine roles that have been defined in this Octopus installation.
get
Gets all machine roles that have been defined in this Octopus installation.
get
Gets all machine roles that have been defined in this Octopus installation.
get
Gets all machine roles that have been defined in this Octopus installation.
get
Gets all machine roles that have been defined in this Octopus installation.
get
Gets 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
Gets information about the maintenance configuration in use by the Octopus Server.
put
Updates the maintenance configuration used by the Octopus Server.
put
Updates the maintenance configuration used by the Octopus Server.
Migrations
2
post
Creates and queues a migration import task, from an export created via the migration partial-export api.
post
Creates and queues a partial-export migration task.
Nuget
2
put
Octopus allows NuGet.exe and compatible tools to push packages to this endpoint.
put
Octopus allows NuGet.exe and compatible tools to push packages to this endpoint.
Observability
32
post
Registers and trusts new Kubernetes Monitor.
post
Command to request the Kubernetes monitor to start sending events for the specified resource
get
Request to fetch all the events for the specified session
post
Registers and trusts new Kubernetes Monitor.
get
Get a Kubernetes Monitor by ID
delete
Delete a Kubernetes Monitor by ID
post
Command to 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
Gets 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
Gets 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
Registers and trusts new Kubernetes Monitor.
post
Command to request the Kubernetes monitor to start sending events for the specified resource
get
Request to fetch all the events for the specified session
post
Registers and trusts new Kubernetes Monitor.
get
Get a Kubernetes Monitor by ID
delete
Delete a Kubernetes Monitor by ID
post
Command to 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
Gets 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
Gets 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
Pings an octopus server node.
get
Returns 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
Deletes an existing Octopus Server Node
get
Returns a count of the running tasks on an octopus server node
OpenIdConnect
1
get
Gets 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
Requests the open telemetry trace file exporter config
put
The command to modify OpenTelemetry trace file export configuration
Packages
42
get
Lists packages according to specified search criteria
get
Gets the release notes for the specified package
get
Get the built in packages
delete
Bulk deletes Packages
delete
Bulk deletes Packages
get
Request a list of Release Notes for the specified Packages
post
Uploads a package to the built in package feed
post
Validates a package intended for the built in package feed, but does not write the package.
get
Returns package information for the specified package id.
delete
Deletes the specified Package
get
Downloads the specified package from the built in feed
delete
Deletes the specified Package
post
Uploads a delta patch for the given file. Used to optimize file upload.
get
Requests the delta-signature for a given package. Used to optimize file upload.
get
Lists packages according to specified search criteria
get
Gets the release notes for the specified package
get
Get the built in packages
delete
Bulk deletes Packages
delete
Bulk deletes Packages
get
Request a list of Release Notes for the specified Packages
post
Uploads a package to the built in package feed
post
Validates a package intended for the built in package feed, but does not write the package.
get
Returns package information for the specified package id.
delete
Deletes the specified Package
get
Downloads the specified package from the built in feed
delete
Deletes the specified Package
post
Uploads a delta patch for the given file. Used to optimize file upload.
get
Requests the delta-signature for a given package. Used to optimize file upload.
get
Lists packages according to specified search criteria
get
Gets the release notes for the specified package
get
Get the built in packages
delete
Bulk deletes Packages
delete
Bulk deletes Packages
get
Request a list of Release Notes for the specified Packages
post
Uploads a package to the built in package feed
post
Validates a package intended for the built in package feed, but does not write the package.
get
Returns package information for the specified package id.
delete
Deletes the specified Package
get
Downloads the specified package from the built in feed
delete
Deletes the specified Package
post
Uploads a delta patch for the given file. Used to optimize file upload.
get
Requests the delta-signature for a given package. Used to optimize file upload.
ParentEnvironments
8
post
Creates a new parent environment.
put
Modifies an existing parent environment.
get
Gets a specific Parent Environment
delete
Deletes an existing Parent Environment
post
Creates a new parent environment.
put
Modifies an existing parent environment.
get
Gets a specific Parent Environment
delete
Deletes an existing Parent Environment
Performance
2
get
Requests the current performance configuration
put
Sets the performance configuration
Permissions
1
get
Gets all the available permissions and their descriptions and restrictions
PlatformHub
46
get
Gets Platform Hub accounts
post
Create a new Platform Hub account
get
Gets a specific Platform Hub account
put
Modify an existing Platform Hub account
delete
Delete an existing Platform Hub account
get
Gets Platform Hub certificates.
post
Creates a new Platform Hub certificate.
post
Creates a self-signed Platform Hub certificate.
get
Gets a Platform Hub certificate by ID or Thumbprint.
put
Modifies an existing Platform Hub certificate.
delete
Deletes an existing archived Platform Hub certificate.
post
Archives an existing Platform Hub certificate.
get
Exports the Platform Hub certificate.
post
Replaces an existing Platform Hub certificate with another.
post
Unarchives an existing archived Platform Hub certificate.
get
Gets usages for a Platform Hub certificate.
get
Get a list of Platform Hub Feeds
post
Creates 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
Searches the specified platform hub feed for packages based on the provided search term
get
Lists available package versions for the specified platform hub feed and package.
get
Gets Platform Hub Git credentials
post
Create a new Platform Hub Git credential
get
Gets Platform Hub Git credentials (V2)
post
Create a new Platform Hub Git credential
get
Gets a specific Platform Hub Git credential
put
Modify an existing Platform Hub Git credential
delete
Delete an existing Platform Hub Git credential
get
Gets a specific Platform Hub Git credential (V2)
put
Modify an existing Platform Hub Git credential
get
Requests the list of Branches for the Platform Hub
post
Create a branch given the base git ref, and the new branch's name
get
Requests 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
Deletes 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
Command to update the platform hub's existing version control settings configuration
get
Gets 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
Gets the sharing configuration for a given process template
get
Lists 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
Modifies an existing process template
delete
Deletes an existing process template
post
Command to share new process template to spaces
get
Get all the available variable names for a process template
post
Creates a process template version
get
Retrieve a single process template and its version by version mask
get
Gets the icon for a given process template version
get
Retrieve a single process template and its version by version mask
get
Gets the icon for a given process template version
Progression
18
get
Returns a list of runbook dashboard items, filtered by various criteria including projectIds, environmentIds, tenantIds, tenantTags, runbookIds, runbookTags, taskIds
get
Gets the progress of a runbook in the environment lifecycle.
get
Gets the progress of a runbook in the environment lifecycle.
get
Gets the progress of a release in the environment lifecycle.
get
Gets the progress of a release in the environment lifecycle.
get
Gets the progress of a release in the environment lifecycle.
get
Returns a list of runbook dashboard items, filtered by various criteria including projectIds, environmentIds, tenantIds, tenantTags, runbookIds, runbookTags, taskIds
get
Gets the progress of a runbook in the environment lifecycle.
get
Gets the progress of a runbook in the environment lifecycle.
get
Gets the progress of a release in the environment lifecycle.
get
Gets the progress of a release in the environment lifecycle.
get
Gets the progress of a release in the environment lifecycle.
get
Returns a list of runbook dashboard items, filtered by various criteria including projectIds, environmentIds, tenantIds, tenantTags, runbookIds, runbookTags, taskIds
get
Gets the progress of a runbook in the environment lifecycle.
get
Gets the progress of a runbook in the environment lifecycle.
get
Gets the progress of a release in the environment lifecycle.
get
Gets the progress of a release in the environment lifecycle.
get
Gets the progress of a release in the environment lifecycle.
ProjectGroups
21
get
Gets a paginated list of the Project Groups in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.
post
Creates a new project group.
get
Lists 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
Modifies an existing project group.
delete
Deletes an existing Project Group
get
Gets a paginated list of the Projects that belong to the given Project Group
get
Gets a paginated list of the Project Groups in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.
post
Creates a new project group.
get
Lists 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
Modifies an existing project group.
delete
Deletes an existing Project Group
get
Gets a paginated list of the Projects that belong to the given Project Group
get
Gets a paginated list of the Project Groups in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.
post
Creates a new project group.
get
Lists 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
Modifies an existing project group.
delete
Deletes an existing Project Group
get
Gets a paginated list of the Projects that belong to the given Project Group
Projects
62
get
Lists all of the projects in the supplied Octopus Deploy Space, from all project groups. The results will be sorted alphabetically by name.
post
Creates a new project.
get
Lists all of the projects in the supplied Octopus Deploy Space.
get
Gets 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
Modifies an existing Project
delete
Deletes an existing Project
post
Tests the Git settings to make sure we can connect.
post
Converts an existing project to store its configuration in version control.
post
Validates the provided git ref
put
Updates the logo associated with the project.
post
Updates the logo associated with the project.
get
Gets the custom settings metadata from the extensions.
get
Gets a summary of project-specific information.
get
Gets a summary of project-specific information.
get
Gets a summary of project-specific information.
get
Gets a summary of project-specific information.
get
Get a Project by ID or slug.
get
Lists all of the projects in the supplied Octopus Deploy Space, from all project groups. The results will be sorted alphabetically by name.
post
Creates a new project.
get
Lists all of the projects in the supplied Octopus Deploy Space.
get
Gets 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
Modifies an existing Project
delete
Deletes an existing Project
post
Tests the Git settings to make sure we can connect.
post
Converts an existing project to store its configuration in version control.
post
Converts all Runbooks to be stored in Git rather than the database.
post
Validates the provided git ref
put
Updates the logo associated with the project.
post
Updates the logo associated with the project.
get
Gets the custom settings metadata from the extensions.
get
Gets a summary of project-specific information.
get
Gets a summary of project-specific information.
get
Gets a summary of project-specific information.
get
Gets a summary of project-specific information.
get
Get a Project by ID or slug.
get
Lists all of the projects in the supplied Octopus Deploy Space, from all project groups. The results will be sorted alphabetically by name.
post
Creates a new project.
get
Lists all of the projects in the supplied Octopus Deploy Space.
get
Gets 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
Modifies an existing Project
delete
Deletes an existing Project
post
Tests the Git settings to make sure we can connect.
post
Converts an existing project to store its configuration in version control.
post
Converts all Runbooks to be stored in Git rather than the database.
post
Validates the provided git ref
put
Updates the logo associated with the project.
post
Updates the logo associated with the project.
get
Gets the custom settings metadata from the extensions.
get
Gets a summary of project-specific information.
get
Gets a summary of project-specific information.
get
Gets a summary of project-specific information.
get
Gets a summary of project-specific information.
get
Get a Project by ID or slug.
ProjectTemplates
1
post
Command to share a project template to spaces
ProjectTriggers
30
get
Gets Project Triggers within a given Project
post
Creates a new project trigger
get
Get project trigger by project id and trigger id
put
Modify a ProjectTriggerResource by ID
delete
Deletes an existing Project Trigger
get
Get a list of Project Triggers.
post
Creates a new project trigger
get
Get a Project Trigger by ID
put
Modify a ProjectTriggerResource by ID
delete
Deletes an existing Project Trigger
get
Gets Project Triggers within a given Project
post
Creates a new project trigger
get
Get project trigger by project id and trigger id
put
Modify a ProjectTriggerResource by ID
delete
Deletes an existing Project Trigger
get
Get a list of Project Triggers.
post
Creates a new project trigger
get
Get a Project Trigger by ID
put
Modify a ProjectTriggerResource by ID
delete
Deletes an existing Project Trigger
get
Gets Project Triggers within a given Project
post
Creates a new project trigger
get
Get project trigger by project id and trigger id
put
Modify a ProjectTriggerResource by ID
delete
Deletes an existing Project Trigger
get
Get a list of Project Triggers.
post
Creates a new project trigger
get
Get a Project Trigger by ID
put
Modify a ProjectTriggerResource by ID
delete
Deletes an existing Project Trigger
Proxies
18
get
Get a list of Proxies
post
Creates a Proxy in the specified Space
get
Get a list of Proxies
get
Get a Proxy by ID
put
Modifies the specified Proxy in the specified Space
delete
Deletes an existing Proxy by Id.
get
Get a list of Proxies
post
Creates a Proxy in the specified Space
get
Get a list of Proxies
get
Get a Proxy by ID
put
Modifies the specified Proxy in the specified Space
delete
Deletes an existing Proxy by Id.
get
Get a list of Proxies
post
Creates a Proxy in the specified Space
get
Get a list of Proxies
get
Get a Proxy by ID
put
Modifies the specified Proxy in the specified Space
delete
Deletes 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
Lists all of the releases that belong to the given Channel.
get
Lists all of the releases that belong to the given Channel.
get
Lists 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
Gets a single release by project ID and version number.
get
Get a list of Releases for the given Space.
post
Create a Release
post
Creates a Release
get
Get a Release by ID
put
Updates an existing Release
delete
Deletes an existing release, along with all of the deployments, tasks and other associated resources belonging to the release.
get
Gets all of the information necessary for creating or editing a deployment for this release.
get
Gets all defects for a release.
post
Record defect in a release.
post
Resolve defect in a release.
get
Lists all of the Deployments that belong to the given Release.
get
Gets a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).
get
Gets a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).
post
Returns an array of documents that describes what steps will/won't be run during deployments to a given set of environments and tenants.
get
Gets all of the information necessary for creating or editing a deployment for this release.
post
Updates the release notes on an existing Release.
post
Updates the Variable Snapshot for a Release
get
Lists all of the releases that belong to the given Channel.
get
Lists all of the releases that belong to the given Channel.
get
Lists 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
Gets a single release by project ID and version number.
get
Get a list of Releases for the given Space.
post
Create a Release
post
Creates a Release
get
Get a Release by ID
put
Updates an existing Release
delete
Deletes an existing release, along with all of the deployments, tasks and other associated resources belonging to the release.
get
Gets all of the information necessary for creating or editing a deployment for this release.
get
Gets all defects for a release.
post
Record defect in a release.
post
Resolve defect in a release.
get
Lists all of the Deployments that belong to the given Release.
get
Gets a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).
get
Gets a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).
post
Returns an array of documents that describes what steps will/won't be run during deployments to a given set of environments and tenants.
get
Gets the list of Packages that are missing from the built-in feed for a release
get
Gets all of the information necessary for creating or editing a deployment for this release.
post
Updates the release notes on an existing Release.
post
Updates the Variable Snapshot for a Release
get
Lists all of the releases that belong to the given Channel.
get
Lists all of the releases that belong to the given Channel.
get
Lists 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
Gets a single release by project ID and version number.
get
Get a list of Releases for the given Space.
post
Create a Release
post
Creates a Release
get
Get a Release by ID
put
Updates an existing Release
delete
Deletes an existing release, along with all of the deployments, tasks and other associated resources belonging to the release.
get
Gets all of the information necessary for creating or editing a deployment for this release.
get
Gets all defects for a release.
post
Record defect in a release.
post
Resolve defect in a release.
get
Lists all of the Deployments that belong to the given Release.
get
Gets a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).
get
Gets a document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied).
post
Returns an array of documents that describes what steps will/won't be run during deployments to a given set of environments and tenants.
get
Gets the list of Packages that are missing from the built-in feed for a release
get
Gets all of the information necessary for creating or editing a deployment for this release.
post
Updates the release notes on an existing Release.
post
Updates the Variable Snapshot for a Release
Reporting
3
get
Gets an XML report of deployments
get
Gets an XML report of deployments
get
Gets an XML report of deployments
Retention
8
get
Get the default retention configuration
put
Updates 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
Modifies a Runbook Process.
get
Gets 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
Modifies a Runbook Process.
get
Get a list of Runbook Processes
get
Get the runbook process for the given ID
put
Modifies a Runbook Process.
get
Gets 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
Modifies a Runbook Process.
get
Gets 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
Modifies a Runbook Process.
get
Get a list of Runbook Processes
get
Get the runbook process for the given ID
put
Modifies a Runbook Process.
get
Gets 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
Modifies a Runbook Process.
get
Gets 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
Modifies a Runbook Process.
get
Get a list of Runbook Processes
get
Get the runbook process for the given ID
put
Modifies a Runbook Process.
get
Gets all of the information necessary for creating or editing a Runbook Snapshot using this Runbook Process
RunbookRuns
33
get
Gets a list of Runbook Runs
post
Creates a new Runbook Run
get
Get a Runbook Run by ID
delete
Deletes an existing Runbook Run
post
Create a new Runbook run based on an existing runbook run
post
Creates a new Runbook Run
post
Create a new runbook run
get
Gets a list of Runbook Runs
post
Creates a new Runbook Run
get
Get a Runbook Run by ID
delete
Deletes an existing Runbook Run
get
Gets a list of Runbook Runs
post
Creates a new Runbook Run
get
Get a Runbook Run by ID
delete
Deletes an existing Runbook Run
post
Create a new Runbook run based on an existing runbook run
post
Creates a new Runbook Run
post
Create a new runbook run
get
Gets a list of Runbook Runs
post
Creates a new Runbook Run
get
Get a Runbook Run by ID
delete
Deletes an existing Runbook Run
get
Gets a list of Runbook Runs
post
Creates a new Runbook Run
get
Get a Runbook Run by ID
delete
Deletes an existing Runbook Run
post
Create a new Runbook run based on an existing runbook run
post
Creates a new Runbook Run
post
Create a new runbook run
get
Gets a list of Runbook Runs
post
Creates a new Runbook Run
get
Get a Runbook Run by ID
delete
Deletes an existing Runbook Run
Runbooks
115
get
Retrieves a list of Runbooks that will be converted to Git, along with how many RunbookRun History records will be updated.
get
Retrieves 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
Gets a list of Runbooks for a Project
get
Get a Runbook by ID
put
Updates an existing Runbook
delete
Deletes 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
Gets all of the information necessary for creating or editing a Runbook Run for this Runbook (when you do not have a snapshot).
post
Runs the published version of this Runbook
post
Get a list of Runbook Run Previews for a Runbook
get
Gets 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
Updates an existing Runbook
delete
Deletes 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
Gets 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
Gets 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
Updates an existing Runbook
delete
Deletes 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
Gets all of the information necessary for creating or editing a Runbook Run for this Runbook (when you do not have a snapshot).
post
Runs the published version of this Runbook
get
Gets 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
Gets a list of Runbooks for a Project
post
Create a new Database Runbook
get
Get a Runbook by ID
put
Updates an existing Runbook
delete
Deletes 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
Gets all of the information necessary for creating or editing a Runbook Run for this Runbook (when you do not have a snapshot).
post
Runs the published version of this Runbook
post
Get a list of Runbook Run Previews for a Runbook
get
Gets 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
Creates a new Git runbook
get
Get a Runbook by ID
put
Updates an existing Runbook
delete
Deletes 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
Gets 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
Gets 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
Updates an existing Runbook
delete
Deletes 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
Gets all of the information necessary for creating or editing a Runbook Run for this Runbook (when you do not have a snapshot).
post
Runs the published version of this Runbook
get
Gets 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
Gets a list of Runbooks for a Project
post
Create a new Database Runbook
get
Get a Runbook by ID
put
Updates an existing Runbook
delete
Deletes 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
Gets all of the information necessary for creating or editing a Runbook Run for this Runbook (when you do not have a snapshot).
post
Runs the published version of this Runbook
post
Get a list of Runbook Run Previews for a Runbook
get
Gets 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
Creates a new Git runbook
get
Get a Runbook by ID
put
Updates an existing Runbook
delete
Deletes 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
Gets 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
Gets 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
Updates an existing Runbook
delete
Deletes 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
Gets all of the information necessary for creating or editing a Runbook Run for this Runbook (when you do not have a snapshot).
post
Runs the published version of this Runbook
get
Gets all of the information necessary for creating or editing a Snapshot for a Runbook
RunbookSnapshots
77
get
Gets a paginated list of all of the Runbook Snapshots that belong to the given Runbook.
get
Gets a paginated list of all of the Runbook Snapshots that belong to the given Project.
post
Create a Runbook Snapshot
get
Gets a single Runbook Snapshot by project ID and name.
put
Modifies a Runbook Snapshot
delete
Deletes an existing Runbook Snapshot
get
Get the runbook runs for the given snapshot.
get
Gets a Runbook Run Preview for a Runbook Snapshot
get
Gets a Runbook Run Preview for a Runbook Snapshot
get
Gets 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
Gets 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
Modifies a Runbook Snapshot
delete
Deletes an existing Runbook Snapshot
get
Get the runbook runs for the given snapshot.
get
Gets a Runbook Run Preview for a Runbook Snapshot
get
Gets a Runbook Run Preview for a Runbook Snapshot
get
Gets 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
Gets a paginated list of all of the Runbook Snapshots that belong to the given Runbook.
get
Gets a paginated list of all of the Runbook Snapshots that belong to the given Project.
post
Create a Runbook Snapshot
get
Gets a single Runbook Snapshot by project ID and name.
put
Modifies a Runbook Snapshot
delete
Deletes an existing Runbook Snapshot
get
Get the runbook runs for the given snapshot.
get
Gets a Runbook Run Preview for a Runbook Snapshot
get
Gets a Runbook Run Preview for a Runbook Snapshot
get
Gets 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
Gets 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
Modifies a Runbook Snapshot
delete
Deletes an existing Runbook Snapshot
get
Get the runbook runs for the given snapshot.
get
Gets a Runbook Run Preview for a Runbook Snapshot
get
Gets a Runbook Run Preview for a Runbook Snapshot
get
Gets 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
Gets a paginated list of all of the Runbook Snapshots that belong to the given Runbook.
get
Gets a paginated list of all of the Runbook Snapshots that belong to the given Project.
post
Create a Runbook Snapshot
get
Gets a single Runbook Snapshot by project ID and name.
put
Modifies a Runbook Snapshot
delete
Deletes an existing Runbook Snapshot
get
Get the runbook runs for the given snapshot.
get
Gets a Runbook Run Preview for a Runbook Snapshot
get
Gets a Runbook Run Preview for a Runbook Snapshot
get
Gets 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
Gets 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
Modifies a Runbook Snapshot
delete
Deletes an existing Runbook Snapshot
get
Get the runbook runs for the given snapshot.
get
Gets a Runbook Run Preview for a Runbook Snapshot
get
Gets a Runbook Run Preview for a Runbook Snapshot
get
Gets 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
Enables a scheduled job or the job scheduler
get
Disables a scheduled job or the job scheduler
get
Triggers a scheduled job immediately and waits for it to complete
get
Gets the structured log for a scheduled job
get
Gets the raw log for a scheduled job
ScopedUserRoles
15
get
Lists 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
Deletes an existing Scoped User Role.
get
Lists 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
Deletes an existing Scoped User Role.
get
Lists 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
Deletes an existing Scoped User Role.
Server
3
get
Requests the current server configuration
put
Sets the server configuration
get
Requests the current server configuration settings
ServerStatus
9
get
Get the status of Octopus Server.
get
Get counts of documents in the server
post
Forces a GC collect.
post
Forces a GC collect.
get
Get the general health of Octopus Server.
get
Retrieves the most recent high-priority log messages from this execution of the Octopus Server process.
get
Provides information about the Octopus Server process and the machine on which it is running.
get
Creates a .zip archive containing an aggregate of the other system information APIs.
get
Lists 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
Requests the current signing key configuration
put
Sets 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
Validates 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
Gets information about the SMTP (email) settings in use by the Octopus Server.
put
Updates the SMTP settings used by the Octopus Server.
get
A low privilege check to determine if SMTP is configured
get
A low privilege check to determine if SMTP is configured
get
Gets information about the SMTP (email) settings in use by the Octopus Server.
Spaces
49
get
Get a list of Spaces
post
Creates a new Space
get
Get a list of Spaces
post
Creates a new Space
get
Get a Space by ID
put
Updates a Space
delete
Deletes an existing Space.
get
Gets the logo for the space with the given space ID.
put
Modifies the logo of the space with the given space ID.
post
Modifies the logo of the space with the given space ID.
get
Searches in the supplied Octopus Deploy Space using the given keyword.
delete
Deletes an existing Space.
get
Gets 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
Gets a specific Git credential
put
Modify an existing Git credential
delete
Delete an existing Git credential
get
Gets usage of a specific Git credential
get
Gets usage of a specific Git credential
get
Gets a specific Git credential
put
Modify an existing Git credential
delete
Delete an existing Git credential
get
Gets a specific Git credential
put
Modify an existing Git credential
get
Gets the git references that match the given rule pattern for a project
get
Searches 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
Gets a specific Git credential
put
Modify an existing Git credential
delete
Delete an existing Git credential
get
Gets usage of a specific Git credential
get
Gets usage of a specific Git credential
get
Gets a specific Git credential
put
Modify an existing Git credential
delete
Delete an existing Git credential
get
Gets a specific Git credential
put
Modify an existing Git credential
get
Gets the git references that match the given rule pattern for a project
get
Searches in the supplied Octopus Deploy Space using the given keyword.
SshKnownHosts
3
get
Gets a list of SSH Known Hosts
post
Adds new SSH Known Hosts from a list of entries
delete
Deletes the specific SSH Known Host
Subscriptions
18
get
Get a list of Subscriptions
post
Creates a new Subscription
get
Get all Subscriptions
get
Get a Subscription by ID
put
Updates an existing Subscription
delete
Deletes an existing Subscription
get
Get a list of Subscriptions
post
Creates a new Subscription
get
Get all Subscriptions
get
Get a Subscription by ID
put
Updates an existing Subscription
delete
Deletes an existing Subscription
get
Get a list of Subscriptions
post
Creates a new Subscription
get
Get all Subscriptions
get
Get a Subscription by ID
put
Updates an existing Subscription
delete
Deletes an existing Subscription
TagSets
21
get
Get a list of Tag Sets
post
Creates a new Tag Set.
get
Get a list of Tag Sets
put
/tagsets/sortorder
get
Get a Tag Set by ID
put
Modifies an existing Tag Set.
delete
Deletes an existing Tag Set
get
Get a list of Tag Sets
post
Creates a new Tag Set.
get
Get a list of Tag Sets
put
/{spaceId}/tagsets/sortorder
get
Get a Tag Set by ID
put
Modifies an existing Tag Set.
delete
Deletes an existing Tag Set
get
Get a list of Tag Sets
post
Creates a new Tag Set.
get
Get a list of Tag Sets
put
/spaces/{spaceIdentifier}/tagsets/sortorder
get
Get a Tag Set by ID
put
Modifies an existing Tag Set.
delete
Deletes an existing Tag Set
Tasks
36
get
Lists all of the tasks in the supplied Octopus Deploy Space. The results will be sorted from newest to oldest.
post
Creates a new Task.
post
Creates a new task and executes it, using a given task as the input. Note that deployment tasks cannot be re-run.
get
Lists supported task types.
get
Get a single Task by ID.
post
Marks the given task as canceled.
get
Gets 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
Gets a list of tasks that this task is currently queued behind.
get
Gets 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
Lists all of the tasks in the supplied Octopus Deploy Space. The results will be sorted from newest to oldest.
post
Creates a new Task.
post
Creates a new task and executes it, using a given task as the input. Note that deployment tasks cannot be re-run.
get
Lists supported task types.
get
Get a single Task by ID.
post
Marks the given task as canceled.
get
Gets 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
Gets a list of tasks that this task is currently queued behind.
get
Gets 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
Lists all of the tasks in the supplied Octopus Deploy Space. The results will be sorted from newest to oldest.
post
Creates a new Task.
post
Creates a new task and executes it, using a given task as the input. Note that deployment tasks cannot be re-run.
get
Lists supported task types.
get
Get a single Task by ID.
post
Marks the given task as canceled.
get
Gets 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
Gets a list of tasks that this task is currently queued behind.
get
Gets 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
Gets a list of Team Memberships for a user.
post
Preview Users that would belong to the specified Team
get
Gets a list of Team Memberships for a user.
get
Gets a list of Team Memberships for a user.
post
Preview Users that would belong to the specified Team
get
Gets a list of Team Memberships for a user.
get
Gets a list of Team Memberships for a user.
post
Preview Users that would belong to the specified Team
get
Gets a list of Team Memberships for a user.
Teams
21
get
Gets a list of Teams
post
Create a new team
get
Get a list of Teams
get
Get a Team by ID
put
Modifies an existing Team
delete
Deletes an existing Team.
get
Get a list of a Team's Scoped User Roles.
get
Gets a list of Teams
post
Create a new team
get
Get a list of Teams
get
Get a Team by ID
put
Modifies an existing Team
delete
Deletes an existing Team.
get
Get a list of a Team's Scoped User Roles.
get
Gets a list of Teams
post
Create a new team
get
Get a list of Teams
get
Get a Team by ID
put
Modifies an existing Team
delete
Deletes 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
Updates the Telemetry Configuration
Tenants
66
get
Gets a list of tenants
post
Creates a new Tenant.
get
Lists all tenants
get
Reports back the status of multi-tenancy.
get
Checks tenants for matching tags
get
Returns a list of tenants who are missing required variables.
get
Get a tenant by it's Id
put
Modifies an existing Tenant.
delete
Deletes an existing Tenant.
get
Gets the logo associated with the Tenant.
put
Modifies the logo associated with the tenant.
post
Modifies the logo associated with the tenant.
get
Gets variables associated with the provided tenant ID.
put
Creates or Updates the variables associated with the tenant.
post
Creates or Updates the variables associated with the tenant.
get
Gets the common variables associated with the tenant.
put
Creates or Updates the common variables associated with the tenant.
post
Creates or Updates the common variables associated with the tenant.
get
Gets the project variables associated with the tenant.
put
Creates or Updates the project variables associated with the tenant.
post
Creates or Updates the project variables associated with the tenant.
get
Lists all of the tenant variables in the supplied Octopus Deploy Space. The results will be sorted alphabetically by id.
get
Gets a list of tenants
post
Creates a new Tenant.
get
Lists all tenants
get
Reports back the status of multi-tenancy.
get
Checks tenants for matching tags
get
Returns a list of tenants who are missing required variables.
get
Get a tenant by it's Id
put
Modifies an existing Tenant.
delete
Deletes an existing Tenant.
get
Gets the logo associated with the Tenant.
put
Modifies the logo associated with the tenant.
post
Modifies the logo associated with the tenant.
get
Gets variables associated with the provided tenant ID.
put
Creates or Updates the variables associated with the tenant.
post
Creates or Updates the variables associated with the tenant.
get
Gets the common variables associated with the tenant.
put
Creates or Updates the common variables associated with the tenant.
post
Creates or Updates the common variables associated with the tenant.
get
Gets the project variables associated with the tenant.
put
Creates or Updates the project variables associated with the tenant.
post
Creates or Updates the project variables associated with the tenant.
get
Lists all of the tenant variables in the supplied Octopus Deploy Space. The results will be sorted alphabetically by id.
get
Gets a list of tenants
post
Creates a new Tenant.
get
Lists all tenants
get
Reports back the status of multi-tenancy.
get
Checks tenants for matching tags
get
Returns a list of tenants who are missing required variables.
get
Get a tenant by it's Id
put
Modifies an existing Tenant.
delete
Deletes an existing Tenant.
get
Gets the logo associated with the Tenant.
put
Modifies the logo associated with the tenant.
post
Modifies the logo associated with the tenant.
get
Gets variables associated with the provided tenant ID.
put
Creates or Updates the variables associated with the tenant.
post
Creates or Updates the variables associated with the tenant.
get
Gets the common variables associated with the tenant.
put
Creates or Updates the common variables associated with the tenant.
post
Creates or Updates the common variables associated with the tenant.
get
Gets the project variables associated with the tenant.
put
Creates or Updates the project variables associated with the tenant.
post
Creates or Updates the project variables associated with the tenant.
get
Lists all of the tenant variables in the supplied Octopus Deploy Space. The results will be sorted alphabetically by id.
TokenExchange
1
post
Exchanges an Oidc token for an access token that allows access to the API
Upgrade
2
get
Gets information about the upgrade configuration in use by the Octopus Server.
put
Updates the upgrade configuration used by the Octopus Server.
UserPermissions
9
get
Gets the user's permission information
get
Gets the user's permission information
get
Gets a list of permissions for the currently authenticated user.
get
Gets the user's permission information
get
Gets the user's permission information
get
Gets a list of permissions for the currently authenticated user.
get
Gets the user's permission information
get
Gets the user's permission information
get
Gets 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
Modifies an existing User Role
delete
Deletes an existing User Role.
Users
15
get
Get a list of Users.
post
Creates a new user.
get
Get a list of Users.
get
Provides the details of the enabled authentication providers and whether the current user can edit logins for the given user.
get
Provides the details of the enabled authentication providers and whether the current user can edit logins for the given user.
get
Searches for users, using the authentication providers
get
Gets the metadata to describe the claims/fields used by authentication providers that support identities.
post
A command resource used for logging in.
post
/users/logout
get
Gets information about the current user.
post
Registers 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
Modifies an existing user.
delete
Deletes an existing User
put
Revokes 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
Updates a Variable Set
get
Returns a summary of the variables that will be migrated to Git.
post
Converts all non-sensitive project variables to be stored in Git rather than the database.
get
Gets variables for a project.
put
Modifies variables for the project
get
Gets variables for a project.
put
Modifies 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
Updates a Variable Set
get
Returns a summary of the variables that will be migrated to Git.
post
Converts all non-sensitive project variables to be stored in Git rather than the database.
get
Gets variables for a project.
put
Modifies variables for the project
get
Gets variables for a project.
put
Modifies 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
Updates a Variable Set
VersionControl
2
post
Clears the local Git cache.
post
Clears 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
Creates a new Worker Pool.
get
Get a list of Worker Pools.
get
Lists the available Worker Types for the Dynamic Worker Pool
put
/workerpools/sortorder
get
Lists all worker pools, including a summary of worker information.
get
Gets the available Worker Pool types.
get
Get a Worker Pool by ID.
put
Modifies an existing worker pool.
delete
Deletes an existing Worker Pool.
get
Get a list of WorkerResources for the given WorkerPoolResource
get
Get a list of Worker Pools.
post
Creates a new Worker Pool.
get
Get a list of Worker Pools.
get
Lists the available Worker Types for the Dynamic Worker Pool
put
/{spaceId}/workerpools/sortorder
get
Lists all worker pools, including a summary of worker information.
get
Gets the available Worker Pool types.
get
Get a Worker Pool by ID.
put
Modifies an existing worker pool.
delete
Deletes an existing Worker Pool.
get
Get a list of WorkerResources for the given WorkerPoolResource
get
Get a list of Worker Pools.
post
Creates a new Worker Pool.
get
Get a list of Worker Pools.
get
Lists the available Worker Types for the Dynamic Worker Pool
put
/spaces/{spaceIdentifier}/workerpools/sortorder
get
Lists all worker pools, including a summary of worker information.
get
Gets the available Worker Pool types.
get
Get a Worker Pool by ID.
put
Modifies an existing worker pool.
delete
Deletes an existing Worker Pool.
get
Get a list of WorkerResources for the given WorkerPoolResource
Workers
33
get
Lists 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
Gets all operating system names for workers. The result will be a string array.
get
Gets all operating system shell names for workers. The result will be a string array.
get
Lists 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
Modifies 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
Lists 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
Gets all operating system names for workers. The result will be a string array.
get
Gets all operating system shell names for workers. The result will be a string array.
get
Lists 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
Modifies 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
Lists 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
Gets all operating system names for workers. The result will be a string array.
get
Gets all operating system shell names for workers. The result will be a string array.
get
Lists 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
Modifies 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
Creates an access token for the current user
post
/users/access-token
Response
Contains the created access token.
GenerateAccessTokenResponse
required
AccessToken
string
required