Skip to content

Commit 1ea080f

Browse files
Merge pull request #3442 from OctopusDeploy/mh/ca-perms
Clarify ConfigureServer permission required for Connection Agent API key
2 parents 56c6a52 + 1ae0b6a commit 1ea080f

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

src/pages/docs/octopus-cloud/connection-agent.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: src/layouts/Default.astro
33
pubDate: 2026-05-21
4-
modDate: 2026-07-20
4+
modDate: 2026-09-02
55
title: Connection Agent
66
navOrder: 67
77
description: How to set up and manage a Connection Agent to connect your Octopus Cloud instance to privately hosted internal applications
@@ -64,7 +64,7 @@ By default, you can register up to 5 Connection Agents per instance. [Contact ou
6464
**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).
6565
:::
6666

67-
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.
67+
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)).
6868

6969
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.
7070

0 commit comments

Comments
 (0)