# Octopus Deploy REST API

**Canonical:** https://apis.io/apis/octopus-deploy/rest-api/  
**Provider:** Octopus Deploy — https://apis.io/providers/octopus-deploy/  
**Base URL:** https://your-octopus.example/api  
**Documentation:** https://octopus.com/docs/octopus-rest-api

Octopus Deploy REST API is one of 7 APIs that [Octopus Deploy](https://apis.io/providers/octopus-deploy/) publishes on the [APIs.io](https://apis.io/) network. Tagged areas include Deployment, Releases, Project, Environments, and Runbooks. The published artifact set on APIs.io includes API documentation, a getting-started guide, and an API reference.

REST API exposing projects, environments, releases, deployments, runbooks, accounts, certificates, tenants, variables, packages, and tasks managed by an Octopus Deploy server or Octopus Cloud instance. Authentication uses an API key passed via the X-Octopus-ApiKey header.

## Machine-readable artifacts (5)

- **Documentation** — https://octopus.com/docs/octopus-rest-api
- **GettingStarted** — https://octopus.com/docs/octopus-rest-api/getting-started-with-the-octopus-rest-api
- **API Key** — https://octopus.com/docs/octopus-rest-api/how-to-create-an-api-key
- **APIReference** — https://octopus.com/docs/octopus-rest-api
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/octopus-deploy/refs/heads/main/apis.yml

## Other Octopus Deploy APIs (6)

- [Octopus Deploy Accounts API](https://apis.io/apis/octopus-deploy/octopus-deploy-accounts-api/)
- [Octopus Deploy Environments API](https://apis.io/apis/octopus-deploy/octopus-deploy-environments-api/)
- [Octopus Deploy Feeds API](https://apis.io/apis/octopus-deploy/octopus-deploy-feeds-api/)
- [Octopus Deploy Machines API](https://apis.io/apis/octopus-deploy/octopus-deploy-machines-api/)
- [Octopus Deploy Projects API](https://apis.io/apis/octopus-deploy/octopus-deploy-projects-api/)
- [Octopus Deploy Root API](https://apis.io/apis/octopus-deploy/octopus-deploy-root-api/)

## Tags

Deployment, Releases, Project, Environments, Runbooks, Variables, APIKeys

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/octopus-deploy/rest-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/octopus-deploy/.