Skip to main content
POST
/
sites
/
environments
/
{env_id}
/
additional-sftp-accounts
Add additional SFTP account
curl --request POST \
  --url https://api.kinsta.com/v2/sites/environments/{env_id}/additional-sftp-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "test-user",
  "password": "R8zXwT@#bV!kJq9^",
  "root_directory": "/dir_1",
  "permission": "write"
}
'
{
  "operation_id": "sftp-accounts:add-additional-sftp-account-54fb80af-576c-4fdc-ba4f-b596c83f15a1",
  "message": "Adding Additional SFTP Account in progress",
  "status": 202
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

env_id
string
required
Example:

"54fb80af-576c-4fdc-ba4f-b596c83f15a1"

Body

application/json
username
string
required
Example:

"test-user"

password
string
required
Minimum string length: 16
Example:

"R8zXwT@#bV!kJq9^"

root_directory
string
default:/
Example:

"/dir_1"

permission
enum<string>
default:read
Available options:
read,
write
Example:

"write"

Response

Adding additional SFTP account successful

operation_id
string
required
Example:

"sftp-accounts:add-additional-sftp-account-54fb80af-576c-4fdc-ba4f-b596c83f15a1"

message
string
required
Example:

"Adding Additional SFTP Account in progress"

status
number
required
Example:

202