Sign in
App Connections

Create a Windows (SMB) Connection.

post/api/v1/app-connections/smb

Request body

method'credentials' required

The method used to authenticate with Windows (SMB).

namestring required

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

descriptionstring nullable

An optional description for the Windows (SMB) Connection.

projectIdstring

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

isPlatformManagedCredentialsfalse

Not supported for Windows (SMB) Connections.

gatewayIdstring uuid nullable

The Gateway ID to use for this connection.

gatewayPoolIdstring uuid nullable

The Gateway Pool ID to use for this connection.

isAutoRotationEnabledfalse

Not supported for Windows (SMB) Connections.

rotation'null' nullable

Not supported for Windows (SMB) Connections.

Response

Default Response

Changes

Changed in 1 of the 22 revisions of this API.112

  • 5dbb77aad0f5112See the full diff
    • ▲

      added subschema #1 subschema #2 to the request body allOf list

      request-body-all-of-added

    • ●

      removed subschema #1 subschema #2 from the request body allOf list

      request-body-all-of-removed

    • ○

      added subschema #1: Windows (SMB) to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      removed subschema #1: SMB from the response property anyOf list for the response status

      response-property-any-of-removed