v6

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-29251563.8 KB

sftp-credentials

Update SFTP credentials

put/headless/sftp/credentials/{id}/

Path parameters

idstring uuid required

Example:ee5d0e45-b098-47bc-8217-e93790243dfa

SFTP credentials ID

Request body

hostnamestring required

portinteger required

userstring required

auth_type'PASSWORD' | 'KEY' required

passwordstring

Optional - omit or use empty string to preserve existing password

private_keystring

Optional - omit or use empty string to preserve existing key

Example request

{
  "hostname": "sftp.example.com",
  "port": 22,
  "user": "sftpuser",
  "auth_type": "PASSWORD",
  "password": "new-secure-password-123",
  "private_key": "-----BEGIN OPENSSH PRIVATE KEY-----\nb3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABlwAAAAdzc2gtcn\n...\n-----END OPENSSH PRIVATE KEY-----"
}

Response

SFTP credentials updated

idstring uuid

hostnamestring required

portinteger required

userstring required

auth_type'PASSWORD' | 'KEY' required

key_fingerprintstring nullable

Example response

{
  "id": "ee5d0e45-b098-47bc-8217-e93790243dfa",
  "hostname": "sftp.example.com",
  "port": 22,
  "user": "sftpuser",
  "auth_type": "PASSWORD",
  "key_fingerprint": "SHA256:abc123..."
}