Skip to main content
POST
/
v1
/
delivery
Configure SFTP Delivery
curl --request POST \
  --url https://api.lobstr.io/v1/delivery \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "ftp_fields.host": "<string>",
  "ftp_fields.port": 123,
  "ftp_fields.username": "<string>",
  "ftp_fields.password": "<string>",
  "ftp_fields.directory": "<string>",
  "ftp_fields.is_active": true
}
'
{
  "ftp_fields.host": "<string>",
  "ftp_fields.port": 123,
  "ftp_fields.username": "<string>",
  "ftp_fields.password": "<string>",
  "ftp_fields.directory": "<string>",
  "ftp_fields.is_active": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.lobstr.io/llms.txt

Use this file to discover all available pages before exploring further.

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

​
Authorization
string
required
Your API authentication token. Value: Token YOUR_API_KEY
​
Content-Type
string
required
Must be application/json. Value: application/json

​
Query Parameters

​
squid
string
required
The unique identifier (hash) of the squid for which to configure SFTP delivery. Example: c106a44a98044ef18acc59986ae10967

​
Request Body

​
ftp_fields.host
string
required
SFTP server hostname or IP address. Example: "sftp.example.com"
​
ftp_fields.port
integer
required
SFTP server port number (default is 22). Example: 22
​
ftp_fields.username
string
required
Username for SFTP authentication. Example: "user"
​
ftp_fields.password
string
required
Password for SFTP authentication. Example: "myC00lP@ssword"
​
ftp_fields.directory
string
required
Target directory path on the SFTP server where files will be uploaded. Example: "/upload/path"
​
ftp_fields.is_active
boolean
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
Ensure your SFTP server is accessible from lobstr.io’s servers. Check firewall rules and IP allowlists if connection fails.
Use the Test SFTP endpoint to verify your credentials and server connectivity before activating automatic delivery.
The directory path must exist on the server. Lobstr will not create directories automatically.
Store SFTP credentials securely. While they’re returned in API responses, treat them as sensitive data.
Set is_active to false to temporarily disable SFTP delivery without removing your configuration.

​
Code Examples

curl -X POST "https://api.lobstr.io/v1/delivery?squid=YOUR_SQUID_HASH" \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "ftp_fields": {
      "host": "sftp.example.com",
      "port": 22,
      "username": "user",
      "password": "password",
      "directory": "/upload/path",
      "is_active": true
    }
  }'

​
Response

201
{
  "ftp_fields": {
    "host": "sftp.example.com",
    "port": 22,
    "username": "user",
    "password": "password",
    "directory": "/upload/path"
  }
}