Skip to content

Clarify ConfigureServer permission required for Connection Agent API key #3442

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
harrisonmeister wants to merge 1 commit into
base: main
Choose a base branch
from
+2 −2
Open

Clarify ConfigureServer permission required for Connection Agent API key #3442

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/pages/docs/octopus-cloud/connection-agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Default.astro
pubDate: 2026-05-21
modDate: 2026-07-20
modDate: 2026-09-02
title: Connection Agent
navOrder: 67
description: How to set up and manage a Connection Agent to connect your Octopus Cloud instance to privately hosted internal applications
Expand Down Expand Up @@ -64,7 +64,7 @@ By default, you can register up to 5 Connection Agents per instance. [Contact ou
**IMPORTANT - Protect your Private Key:** The generated `.pem` file is your private key and must be kept secret. It lets Connection Agent authenticate and proxy requests from Octopus Cloud. If the private key is compromised, immediately [rotate your private key](#rotate-the-agents-key).
:::

1. [Create an API key](https://octopus.com/docs/api/authentication/create-an-api-key) with a short expiry date on your Octopus Cloud instance. This API key will only be used to register the Connection Agent.
1. [Create an API key](https://octopus.com/docs/api/authentication/create-an-api-key) with a short expiry date on your Octopus Cloud instance. This API key will only be used to register the Connection Agent, and must have `ConfigureServer` permission (the same permission required for all Connection Agent actions - see [Prerequisites](#prerequisites)).

1. Register the Connection Agent with your Octopus Cloud instance. This command doesn't need to be run on the same infrastructure you intend to run the Connection Agent on.

Expand Down