Skip to main content
PATCH
/
api
/
v1
/
app-connections
/
octopus-deploy
/
{connectionId}
cURL
curl --request PATCH \
  --url https://us.infisical.com/api/v1/app-connections/octopus-deploy/{connectionId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "gatewayId": "<unknown>",
  "rotation": "<unknown>"
}
'
{
  "appConnection": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "credentials": {
      "instanceUrl": "<string>"
    },
    "description": "<string>",
    "version": 1,
    "isPlatformManagedCredentials": false,
    "gatewayId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "projectId": "<string>",
    "isAutoRotationEnabled": false,
    "rotation": {
      "rotationInterval": 123,
      "rotateAtUtc": {
        "hours": 123,
        "minutes": 123
      },
      "lastRotationMessage": "<string>",
      "nextRotationAt": "2023-11-07T05:31:56Z"
    },
    "credentialsHash": "<string>",
    "project": {
      "name": "<string>",
      "id": "<string>",
      "type": "<string>",
      "slug": "<string>"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://infisical-docs-self-host-infra.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Check out the configuration docs for Octopus Deploy Connections to learn how to obtain the required credentials.

Path Parameters

​
connectionId
string<uuid>
required

The ID of the Octopus Deploy Connection to be updated.

Body

application/json
​
credentials
object

The credentials used to connect with Octopus Deploy.

​
name
string

The updated name of the Octopus Deploy Connection. Must be slug-friendly.

Required string length: 1 - 64
​
description
string | null

The updated description of the Octopus Deploy Connection.

Maximum string length: 256
​
isPlatformManagedCredentials
enum<boolean>

Not supported for Octopus Deploy Connections.

Available options:
false
​
gatewayId

Not supported for Octopus Deploy Connections.

​
isAutoRotationEnabled
enum<boolean>

Not supported for Octopus Deploy Connections.

Available options:
false
​
rotation

Not supported for Octopus Deploy Connections.

Response

Default Response

​
appConnection
Octopus Deploy (API Key) · object
required