Skip to main content
POST
cURL
Check out the configuration docs for SSH Connections to learn how to obtain the required credentials.

Body

application/json
method
enum<string>
required

The method used to authenticate with SSH.

Available options:
password
credentials
object
required

The credentials used to connect with SSH.

name
string
required

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

Required string length: 1 - 64
configuration
object
description
string | null

An optional description for the SSH Connection.

Maximum string length: 256
projectId
string

The ID of the project to create the SSH Connection in.

isPlatformManagedCredentials
enum<boolean>

Not supported for SSH Connections.

Available options:
false
gatewayId
string<uuid> | null

The Gateway ID to use for this connection.

gatewayPoolId
string<uuid> | null

The Gateway Pool ID to use for this connection.

isAutoRotationEnabled
enum<boolean>

Not supported for SSH Connections.

Available options:
false
rotation

Not supported for SSH Connections.

Response

Default Response

appConnection
SSH (Password) · object
required