POST/v1/delivery?squid={squid_hash}

Configure SFTP Delivery

Set up secure SFTP server delivery for squid run results

Configure SFTP delivery to securely store run results on your own SFTP server. Results will be automatically uploaded to your specified server and directory when runs complete.

Headers

Key	Value	Required
Authorization	Token YOUR_API_KEY	Yes
Content-Type	application/json	Yes

Request Body

ftp_fields.hoststring

Required

SFTP server hostname or IP address

Example: sftp.example.com

ftp_fields.portinteger

Required

SFTP server port number (default is 22)

Example: 22

ftp_fields.usernamestring

Required

Username for SFTP authentication

Example: user

ftp_fields.passwordstring

Required

Password for SFTP authentication

Example: myC00lP@ssword

ftp_fields.directorystring

Required

Target directory path on the SFTP server where files will be uploaded

Example: /upload/path

ftp_fields.is_activeboolean

Required

Set to true to enable SFTP delivery, false to disable

Example: true

Response Field Explanations

ftp_fields.host

string

SFTP server hostname

Example: sftp.example.com

ftp_fields.port

integer

SFTP server port

Example: 22

ftp_fields.username

string

SFTP username

Example: user

ftp_fields.password

string

SFTP password (returned in response)

Example: myC00lP@ssword

ftp_fields.directory

string

Target directory path

Example: /upload/path

ftp_fields.is_active

boolean

Whether SFTP delivery is active

Example: true

Parameters

squidstring

Required

The unique identifier (hash) of the squid for which to configure SFTP delivery

Example: c106a44a98044ef18acc59986ae10967

Warning

Ensure your SFTP server is accessible from lobstr.io's servers. Check firewall rules and IP allowlists if connection fails.

Pro Tip

Use the Test SFTP endpoint to verify your credentials and server connectivity before activating automatic delivery.

Note

The directory path must exist on the server. Lobstr will not create directories automatically.

Warning

Store SFTP credentials securely. While they're returned in API responses, treat them as sensitive data.

Pro Tip

Set is_active to false to temporarily disable SFTP delivery without removing your configuration.