Octopus Deploy

Octopus Deploy REST API

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.

GitHub

Documentation

📖
Documentation
https://octopus.com/docs/octopus-rest-api
📖
GettingStarted
https://octopus.com/docs/octopus-rest-api/getting-started-with-the-octopus-rest-api
📖
APIReference
https://octopus.com/docs/octopus-rest-api

Other Resources

🔗
API Key
https://octopus.com/docs/octopus-rest-api/how-to-create-an-api-key
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/octopus-deploy/refs/heads/main/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/rest-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

API entry from apis.yml

apis.yml Raw ↑ 
aid: octopus-deploy:rest-api
name: Octopus Deploy REST API
description: 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.
humanURL: https://octopus.com/docs/octopus-rest-api
baseURL: https://your-octopus.example/api
tags:
- Deployment
- Releases
- Project
- Environments
- Runbooks
- Variables
- APIKeys
tags_raw:
- Deployments
- Releases
- Projects
- Environments
- Runbooks
- Variables
- API Key
properties:
- type: Documentation
  url: https://octopus.com/docs/octopus-rest-api
- type: GettingStarted
  url: https://octopus.com/docs/octopus-rest-api/getting-started-with-the-octopus-rest-api
- type: API Key
  url: https://octopus.com/docs/octopus-rest-api/how-to-create-an-api-key
- type: APIReference
  url: https://octopus.com/docs/octopus-rest-api