Octopus Deploy Documentation

Octopus.Client

Last updated

Octopus.Client is an open source .NET library that makes it easy to write C# programs or PowerShell scripts that manipulate the Octopus Deploy REST API.

Because the Octopus Deploy application itself is built entirely on the API, any programming language that can make HTTP requests to the API can do anything that could be done by a user of the application itself.

Octopus.Client is published on NuGet. The package contains both a .NET Framework build as well as a .NET Standard build. The .NET Framework build targets 4.5.2, and the .NET Standard build is cross-platform and compatible with a variety of runtimes, including .NET Core and can be used from PowerShell Core.

Details for where to find the API, how to authenticate, and the resources that are available can be found on the API documentation site, and swagger documentation is also available.

Octopus.Client Examples

We have many examples showing how to use Octopus.Client in both our API examples, and on the OctopusDeploy-API GitHub repository.

In this section

The following topics are explained further in this section:

Need support? We're here to help.