Skip to content

Sftp Key Instructions

GET
/blueprints/sftp/key-instructions

The partner key-pair instructions the deploy wizard shows beside the SFTP user rows (Feature B). Catalog data, pre-apply, so no endpoint hostname and no connect line. An optional username keys the key-file names; a malformed one renders the generic placeholder form.

username
Any of:
string
st_session
Any of:
string

Successful Response

SftpKeyInstructions

Step-by-step guidance for one transfer partner (one SFTP user).

object
algorithm
required
Algorithm
string
connect_command
Any of:
string
keygen_command
required
Keygen Command
string
steps
required
Steps
Array<string>
username
required
Username
string

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string