Octopus Deploy integration
Octopus Deploy (Octopus Cloud or a self-hosted Octopus Server) release and deployment automation. Browse spaces, projects, channels, environments, lifecycles, tenants, deployment targets, workers and packages; create releases, deploy them (tenanted or not), run runbooks, follow, cancel or re-run the resulting tasks, and answer manual interventions. Not exposed: variables, accounts, certificates, feeds and Git credentials (secrets), task logs, configuration edits (full-replace PUTs), deletes, users and teams, server administration, and machine endpoints (host and port details). Every call acts with the permissions of the API key's user; Octopus may rate-limit requests (429) per its rate limiting policies. Authentication: an Octopus API key (API-...) sent in the X-Octopus-ApiKey header, plus your Octopus Server host name.
Say what should happen.
The workflow builds itself.
What you can do with Octopus Deploy
Each of these is one operation on one endpoint, available both as a workflow step and as a tool an AI agent can call on its own. Nothing bundles several operations into one action, so what a run did stays readable afterwards.
Most endpoints run on the free plan. A few, mainly the ones that publish on your behalf, need a paid plan.
Release, 6 operations
create_releaseCreate releasePOSTCreates a real release of a project on the Octopus instance (it does not deploy it). Returns ReleaseId and ReleaseVersion; deploy it with create_deployment.get_project_release_by_versionGet project release by versionGETReturns a project's release by its version number (such as 1.2.3) rather than its release id.get_releaseGet releaseGETReturns one release: version, project, channel, release notes, selected package versions and creation time.list_channel_releasesList channel releasesGETLists the releases created in a channel, newest first, 30 per page (skip/take).list_project_releasesList project releasesGETLists a project's releases, newest first, 30 per page (skip/take). searchByVersion filters by partial version.list_releasesList releasesGETLists every release of a space across projects, newest first, 30 per page (skip/take).
Task, 6 operations
cancel_taskCancel taskPOSTCancels a queued or running task (a deployment or runbook run in progress is stopped). Returns the task.get_taskGet taskGETReturns a task's State (Queued, Executing, Success, Failed, Canceled, TimedOut), its times, duration, error message and whether it waits on an interruption.list_deployment_target_tasksList deployment target tasksGETLists the tasks (deployments, health checks and others) that involved a deployment target, 30 per page.list_tasksList tasksGETLists server tasks (deployments, runbook runs, health checks and others) newest first, 30 per page, filtered by state, project, environment, tenant or date.list_tasks_queued_aheadList tasks queued aheadGETLists the tasks a queued task is waiting behind, 30 per page.rerun_taskRerun taskPOSTRe-runs a finished task by creating and starting a new task from it, which acts on the real servers and services again; deployment tasks cannot be re-run. Returns the new task.
Deployment, 5 operations
create_deploymentCreate deploymentPOSTDeploys an existing release of a project to one or more environments (untenanted). Starts real deployments; returns their DeploymentId and ServerTaskId.create_tenanted_deploymentCreate tenanted deploymentPOSTDeploys an existing release of a project to one environment for the given tenants or tenant tags. Starts real deployments; returns their ids.get_deploymentGet deploymentGETReturns one deployment: release, environment, tenant, TaskId (poll get_task for state) and the options it ran with.list_deploymentsList deploymentsGETLists the deployments of a space, newest first, 30 per page, filtered by project, environment, channel, tenant or task state.list_release_deploymentsList release deploymentsGETLists the deployments of a release, newest first, 30 per page; each carries its TaskId (poll get_task for the outcome).
Environment, 4 operations
get_environmentGet environmentGETReturns one environment: name, description, sort order and guided failure and dynamic infrastructure settings.list_environmentsList environmentsGETLists the environments of a space in their sort order, 10 per page by default (skip/take).list_project_environmentsList project environmentsGETLists the environments a project can deploy to; skip and take are required by Octopus here.list_runbook_environmentsList runbook environmentsGETLists the environments a runbook can be run in, based on its environment scope.
Interruption, 4 operations
get_interruptionGet interruptionGETReturns one interruption: title, the task it blocks, whether it is pending, who may act and the Form elements it expects.list_interruptionsList interruptionsGETLists interruptions (manual interventions and guided failures waiting for a person), newest first, 30 per page. pendingOnly=true keeps the open ones.submit_interruptionSubmit interruptionPOSTAnswers an interruption the API key's user is responsible for: Result Proceed or Abort (manual intervention), or Guidance Fail, Retry, Ignore or Exclude (guided failure). The real deployment or runbook run then resumes or stops.take_interruption_responsibilityTake interruption responsibilityPUTMakes the API key's user responsible for an interruption, which is required before submit_interruption. Only members of its responsible teams may.
Project, 4 operations
get_projectGet projectGETReturns a project by id or slug: name, project group, lifecycle, versioning strategy, tenanted mode and other settings.list_all_projectsList all projectsGETLists every project of a space in one unpaginated array, optionally limited to some project ids.list_project_group_projectsList project group projectsGETLists the projects that belong to a project group, 30 per page (skip/take).list_projectsList projectsGETLists the projects of a space, sorted by name, 30 per page (skip/take). Filter by partialName or ids.
Deployment target, 3 operations
get_deployment_targetGet deployment targetGETReturns one deployment target: name, roles, environments, tenants, health status and disabled flag. Its connection endpoint is not returned.list_deployment_targetsList deployment targetsGETLists the deployment targets (machines) of a space, sorted by name, 30 per page, with health status and roles. Connection endpoints are not returned.list_environment_deployment_targetsList environment deployment targetsGETLists the deployment targets in an environment, 20 per page, filtered by health status, role, tag, tenant or name. Connection endpoints are not returned.
Runbook run, 3 operations
get_runbook_runGet runbook runGETReturns one runbook run: runbook, snapshot, environment, tenant and TaskId (poll get_task for its state).list_runbook_runsList runbook runsGETLists a project's runbook runs, 30 per page, filtered by runbook, environment, tenant or task state. Poll get_task with a run's TaskId for its state.run_runbookRun runbookPOSTRuns a project's runbook in one or more environments (published snapshot unless Snapshot is set). Starts real runs; returns RunbookRunId and ServerTaskId per run.
Worker, 3 operations
get_workerGet workerGETReturns one worker: name, worker pools, health status and disabled flag. Its connection endpoint is not returned.list_worker_pool_workersList worker pool workersGETLists the workers of a worker pool, 20 per page, with health status. Connection endpoints are not returned.list_workersList workersGETLists the workers of a space, sorted by name, 30 per page, with health status and pools. Connection endpoints are not returned.
Channel, 2 operations
get_channelGet channelGETReturns one channel of a project: name, lifecycle, default flag and package version rules.list_project_channelsList project channelsGETLists a project's channels (release streams with their own lifecycle and package version rules), 30 per page.
Event, 2 operations
get_eventGet eventGETReturns one audit event: category, message, who did it and when, and the related documents.list_eventsList eventsGETLists the audit events of a space, newest first, 30 per page, filtered by date, project, environment, category, user or related document.
Lifecycle, 2 operations
get_lifecycleGet lifecycleGETReturns one lifecycle with its phases and release and tentacle retention policies.list_lifecyclesList lifecyclesGETLists the lifecycles of a space (ordered phases of environments a release goes through), 30 per page.
Package, 2 operations
list_built_in_packagesList built in packagesGETLists packages in the space's built-in package repository, 30 per page.search_feed_packagesSearch feed packagesGETSearches a package feed for package ids matching a term.
Project group, 2 operations
get_project_groupGet project groupGETReturns one project group: name, description and environment restrictions.list_project_groupsList project groupsGETLists the name and id of every project group in a space, sorted by name.
Runbook, 2 operations
get_runbookGet runbookGETReturns one runbook: name, description, environment scope, published snapshot id and run retention policy.list_project_runbooksList project runbooksGETLists a project's runbooks, 30 per page, filtered by partial name or runbook tags.
Space, 2 operations
get_spaceGet spaceGETReturns one space: name, description, whether it is the default space, and its space manager teams and members.list_spacesList spacesGETLists the Octopus spaces visible to the API key's user, 30 per page (skip/take). Every other tool needs a space id such as Spaces-1 from here.
Tenant, 2 operations
get_tenantGet tenantGETReturns one tenant: name, description, tags and the projects and environments it is connected to.list_tenantsList tenantsGETLists the tenants of a space, sorted by name, 30 per page, filtered by project, tags, name or disabled status.
Worker pool, 2 operations
get_worker_poolGet worker poolGETReturns one worker pool: name, type, description and whether it is the default pool.list_worker_poolsList worker poolsGETLists the name and id of every worker pool of a space, in sort order.
Artifact, 1 operation
list_artifactsList artifactsGETLists artifacts (files collected by deployments and runbook runs), 30 per page, filtered by related document. File content is not downloaded.
Dashboard, 1 operation
get_dashboardGet dashboardGETReturns the space dashboard: projects, environments, tenants and the latest deployment of each project to each environment.
Deployment target summary, 1 operation
get_deployment_target_summaryGet deployment target summaryGETCounts the deployment targets of a space by target type and health status.
Deployment template, 1 operation
get_release_deployment_templateGet release deployment templateGETReturns what a release can be deployed to right now: promotable environments, tenant promotions and prompted variables.
Package version, 1 operation
list_feed_package_versionsList feed package versionsGETLists the available versions of a package in a feed, 30 per page by default (skip/take).
Project progression, 1 operation
get_project_progressionGet project progressionGETReturns, per environment and channel of a project, the latest releases and deployments (3 per combination by default, releaseHistoryCount up to 100).
Project summary, 1 operation
get_project_summaryGet project summaryGETReturns whether a project has a deployment process, has runbooks and has ever been deployed successfully.
Release progression, 1 operation
get_release_progressionGet release progressionGETReturns a release's progress through its lifecycle: each phase, its environments and the deployments done there.
Runbook snapshot, 1 operation
list_runbook_snapshotsList runbook snapshotsGETLists a project's runbook snapshots (frozen versions of a runbook process), newest first, 30 per page.
Tag set, 1 operation
list_tag_setsList tag setsGETLists every tag set of a space with its tags (used for tenant and target tags, written TagSetName/TagName).
Trigger, 1 operation
list_project_triggersList project triggersGETLists a project's triggers (scheduled or event-based deployments and runbook runs), 30 per page.
Use Octopus Deploy from Claude Code, Cursor or Codex
Connect Octopus Deploy in LiveContext, create an API key in Settings, then add the LiveContext MCP server to your client. Its Octopus Deploy operations become tools the client can call, next to every other integration you connected.
claude mcp add --transport http livecontext https://livecontext.ai/mcp --header "X-API-Key: YOUR_API_KEY"[mcp_servers.livecontext]
url = "https://livecontext.ai/mcp"
[mcp_servers.livecontext.http_headers]
"X-API-Key" = "YOUR_API_KEY"{
"mcpServers": {
"livecontext": {
"type": "http",
"url": "https://livecontext.ai/mcp",
"headers": {
"X-API-Key": "YOUR_API_KEY"
}
}
}
}How to connect Octopus Deploy
- Create your workspace
Sign up free. Nothing to install.
- Connect Octopus Deploy once
Add your Octopus Deploy connection in Settings. Every tool from this integration reuses it, and secrets are encrypted at rest and visible only to you.
- Describe the job in chat
The workflow builds itself in front of you and picks the endpoints it needs. Drag the steps yourself on the canvas whenever you would rather be explicit.
Octopus Deploy integration FAQ
What can you do with the Octopus Deploy integration?
LiveContext exposes 67 operations on Octopus Deploy, covering release, task, deployment and environment.
