v6

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

sftp-credentials

Retrieve SFTP credentials

get/headless/sftp/credentials/{id}/

Path parameters

idstring uuid required

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

SFTP credentials ID

Response

SFTP credentials details

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..."
}