Skip to main content
POST
/
api
/
v1
/
app-connections
/
octopus-deploy
cURL
curl --request POST \
  --url https://us.infisical.com/api/v1/app-connections/octopus-deploy \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "api-key",
  "credentials": {
    "instanceUrl": "<string>",
    "apiKey": "<string>"
  },
  "name": "<string>",
  "description": "<string>",
  "projectId": "<string>",
  "isPlatformManagedCredentials": false,
  "gatewayId": "<unknown>",
  "isAutoRotationEnabled": false,
  "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",
    "app": "octopus-deploy",
    "method": "api-key",
    "credentials": {
      "instanceUrl": "<string>"
    },
    "description": "<string>",
    "version": 1,
    "isPlatformManagedCredentials": false,
    "gatewayId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "projectId": "<string>",
    "isAutoRotationEnabled": false,
    "rotation": {
      "rotationInterval": 123,
      "rotationStatus": "success",
      "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.com/docs/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.

Body

application/json
​
method
enum<string>
required

The method used to authenticate with Octopus Deploy.

Available options:
api-key
​
credentials
object
required

The credentials used to connect with Octopus Deploy.

​
name
string
required

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

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

An optional description for the Octopus Deploy Connection.

Maximum string length: 256
​
projectId
string

The ID of the project to create the Octopus Deploy Connection in.

​
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