Skip to content
StackTaktDocs

Get Sftp Key Instructions

GET
/deployments/{deployment_id}/sftp/key-instructions

Per-user partner key-pair instructions for an existing SFTP endpoint (Feature B). Each block carries the exact ssh-keygen command; once the server is applied and captured in evidence, it also carries the partner’s sftp connect line with the resolved public hostname.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
deployment_id
required
Deployment Id
string format: uuid
Section titled “Cookie Parameters ”
st_session
Any of:
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

DeploymentKeyInstructions

Every SFTP user’s key-pair instructions for one existing deployment, plus the resolved endpoint hostname (null before the server is applied and captured in evidence).

object
deployment_id
required
Deployment Id
string format: uuid
hostname
required
Any of:
string
users
required
Users
Array<object>
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

422

Section titled “422 ”

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