Test endpoints
Explore endpoints interactively via Swagger - served by your own instance.
Text
https://<your-octopus-url>/swaggerui/Our docs cover the latest version of the Octopus REST API. If you’re on a Long Term Support (LTS) version, some endpoints and values may differ. Use the Swagger UI served by your own instance (see above) as the source of truth for your version.
Common tasks
Create a project
POST /api/{spaceId}/projects
Create a release
POST /api/{spaceId}/releases
Create a deployment
POST /api/{spaceId}/deployments
Upload a package
POST /api/{spaceId}/packages/raw
Create a new runbook
POST /api/{spaceId}/projects/{projectId}/runbooks
Run a runbook
POST /api/{spaceId}/runbookRuns
API clients
Go
Go API Client for Octopus Deploy.
.NET
.NET C# API Client for Octopus Deploy.
Typescript
TypeScript API Client for Octopus Deploy.
