v6

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

Test SFTP connection

post/headless/sftp/credentials/{id}/test_connection/

Path parameters

idstring uuid required
Example:ee5d0e45-b098-47bc-8217-e93790243dfa

SFTP credentials ID

Response

Connection test result

successboolean
errorstring

Example response

{
  "success": true,
  "error": "Connection refused"
}