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

Path Parameters

connectionId
string<uuid>
required

The ID of the Windows (WinRM) Connection to be updated.

Body

application/json
credentials
object
name
string

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

Required string length: 1 - 64
description
string | null

The updated description of the Windows (WinRM) Connection.

Maximum string length: 256
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