Skip to main content
POST
cURL
Check out the configuration docs for Windows (WinRM) Connections to learn how to obtain the required credentials.

Body

application/json
method
enum<string>
required
Available options:
username-password
credentials
object
required
name
string
required

The name of the Windows (WinRM) Connection to create. Must be slug-friendly.

Required string length: 1 - 64
description
string | null

An optional description for the Windows (WinRM) Connection.

Maximum string length: 256
projectId
string

The ID of the project to create the Windows (WinRM) Connection in.

isPlatformManagedCredentials
enum<boolean>

Not supported for Windows (WinRM) 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 Windows (WinRM) Connections.

Available options:
false
rotation

Not supported for Windows (WinRM) Connections.

Response

Default Response

appConnection
Windows (WinRM) (Username and Password) · object
required