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

Other Resources

🔗
Getting Started
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
🔗
API Reference
https://octopus.com/docs/octopus-rest-api

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:
- Deployments
- Releases
- Projects
- Environments
- Runbooks
- Variables
- API Key
properties:
- type: Documentation
  url: https://octopus.com/docs/octopus-rest-api
- type: Getting Started
  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: API Reference
  url: https://octopus.com/docs/octopus-rest-api