aid: octopus-deploy
name: Octopus Deploy
description: >-
  Octopus Deploy is a continuous delivery and release orchestration platform
  for managing deployments across development, test, and production
  environments to virtual machines, containers, Kubernetes, and cloud
  services. The platform handles environments, tenants, runbooks, release
  promotion, and approvals for both regulated and high-velocity teams. The
  Octopus REST API provides programmatic access to projects, environments,
  releases, deployments, runbooks, variables, accounts, and tasks via
  API-key authentication.
type: Index
accessModel:
  pricing: unknown
  onboarding: self-serve
  trial: false
  try_now: false
  public: false
  label: Self-serve signup
  confidence: medium
  source:
  - authentication
  generated: '2026-07-22'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/octopus-deploy.png
tags:
  - DevOps
  - Continuous Delivery
  - Deployment Automation
  - Release Management
  - Runbooks
  - CI/CD
url: >-
  https://raw.githubusercontent.com/api-evangelist/octopus-deploy/refs/heads/main/apis.yml
created: '2026-05-11'
modified: '2026-05-19'
specificationVersion: '0.23'
apis:
- 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:
  - 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
- aid: octopus-deploy:octopus-deploy-accounts-api
  name: Octopus Deploy Accounts API
  description: The Accounts API from Octopus Deploy — 1 operation(s) for accounts.
  humanURL: https://octopus.com/docs/octopus-rest-api
  baseURL: https://your-octopus.example/api
  tags:
  - Accounts
  properties:
  - type: OpenAPI
    url: openapi/octopus-deploy-accounts-api-openapi.yml
- aid: octopus-deploy:octopus-deploy-environments-api
  name: Octopus Deploy Environments API
  description: The Environments API from Octopus Deploy — 1 operation(s) for environments.
  humanURL: https://octopus.com/docs/octopus-rest-api
  baseURL: https://your-octopus.example/api
  tags:
  - Environments
  properties:
  - type: OpenAPI
    url: openapi/octopus-deploy-environments-api-openapi.yml
- aid: octopus-deploy:octopus-deploy-feeds-api
  name: Octopus Deploy Feeds API
  description: The Feeds API from Octopus Deploy — 1 operation(s) for feeds.
  humanURL: https://octopus.com/docs/octopus-rest-api
  baseURL: https://your-octopus.example/api
  tags:
  - Feeds
  properties:
  - type: OpenAPI
    url: openapi/octopus-deploy-feeds-api-openapi.yml
- aid: octopus-deploy:octopus-deploy-machines-api
  name: Octopus Deploy Machines API
  description: The Machines API from Octopus Deploy — 1 operation(s) for machines.
  humanURL: https://octopus.com/docs/octopus-rest-api
  baseURL: https://your-octopus.example/api
  tags:
  - Machines
  properties:
  - type: OpenAPI
    url: openapi/octopus-deploy-machines-api-openapi.yml
- aid: octopus-deploy:octopus-deploy-projects-api
  name: Octopus Deploy Projects API
  description: The Projects API from Octopus Deploy — 1 operation(s) for projects.
  humanURL: https://octopus.com/docs/octopus-rest-api
  baseURL: https://your-octopus.example/api
  tags:
  - Projects
  properties:
  - type: OpenAPI
    url: openapi/octopus-deploy-projects-api-openapi.yml
- aid: octopus-deploy:octopus-deploy-root-api
  name: Octopus Deploy Root API
  description: The Root API from Octopus Deploy — 1 operation(s) for root.
  humanURL: https://octopus.com/docs/octopus-rest-api
  baseURL: https://your-octopus.example/api
  tags:
  - Root
  properties:
  - type: OpenAPI
    url: openapi/octopus-deploy-root-api-openapi.yml
common:
  - type: AgenticAccess
    url: agentic-access/octopus-deploy-agentic-access.yml
  - type: TrustCenter
    url: security/octopus-deploy-trust-center.yml
  - type: VulnerabilityDisclosure
    url: security/octopus-deploy-vulnerability-disclosure.yml
  - type: DomainSecurity
    url: security/octopus-deploy-domain-security.yml
  - type: Authentication
    url: authentication/octopus-deploy-authentication.yml
  - type: OAuthScopes
    url: scopes/octopus-deploy-scopes.yml
  - type: LinkedIn
    url: https://www.linkedin.com/company/octopus-deploy
  - type: Website
    url: https://octopus.com
  - type: Documentation
    url: https://octopus.com/docs
  - type: API Documentation
    url: https://octopus.com/docs/octopus-rest-api
  - type: Pricing
    url: https://octopus.com/pricing
  - type: Signup
    url: https://octopus.com/start
  - type: Login
    url: https://octopus.com/login
  - type: Support
    url: https://octopus.com/support
  - type: Blog
    url: https://octopus.com/blog
  - type: GitHubOrganization
    url: https://github.com/OctopusDeploy
  - type: CLI
    url: https://github.com/OctopusDeploy/cli
  - type: SDKs
    url: https://github.com/OctopusDeploy/OctopusClients
  - name: MCP Server
    url: https://github.com/OctopusDeploy/mcp-server
    type: MCPServer
  - type: LlmsText
    url: https://octopus.com/llms.txt
maintainers:
  - FN: Kin Lane
    email: kin@apievangelist.com