logo

Additional SFTP Users

Enable or disable additional SFTP accounts

SecuritybearerAuth
Request
Request Body schema: application/json
required
enabled
required
boolean
Responses
202

Toggling status for additional SFTP accounts in progress

401

No or invalid API key provided to the request

500

Error occurred while trying to toggle status for additional SFTP accounts

put/sites/environments/{env_id}/additional-sftp-accounts/toggle-status
Request samples
application/json
{
  • "enabled": true
}
Response samples
application/json
{
  • "operation_id": "sftp-accounts:toggle-status-54fb80af-576c-4fdc-ba4f-b596c83f15a1",
  • "message": "Updating Additional SFTP Accounts Status in progress",
  • "status": 202
}

Add additional SFTP account

SecuritybearerAuth
Request
Request Body schema: application/json
required
username
required
string
password
required
string >= 16 characters
root_directory
string
Default: "/"
permission
string
Default: "read"
Enum: "read" "write"
Responses
200

Adding additional SFTP account successful

401

No or invalid API key provided to the request

500

Error occurred while trying to add additional SFTP account

post/sites/environments/{env_id}/additional-sftp-accounts
Request samples
application/json
{
  • "username": "test-user",
  • "password": "R8zXwT@#bV!kJq9^",
  • "root_directory": "/dir_1",
  • "permission": "write"
}
Response samples
application/json
{
  • "operation_id": "sftp-accounts:add-additional-sftp-account-54fb80af-576c-4fdc-ba4f-b596c83f15a1",
  • "message": "Adding Additional SFTP Account in progress",
  • "status": 202
}

Get list of additional SFTP accounts

SecuritybearerAuth
Responses
200

Successfully found additional SFTP accounts

401

No or invalid API key provided to the request

404

Could not find the additional SFTP accounts or the user does not have permissions to retrieve data

500

Error occurred while retrieving additional SFTP accounts

get/sites/environments/{env_id}/additional-sftp-accounts
Request samples 
Response samples 
application/json
{
  • "environment": {
    }
}
Remove additional SFTP account
SecuritybearerAuth 
Responses 
202
Removing additional SFTP account in progress


401
No or invalid API key provided to the request


500
Error occurred while trying to remove additional SFTP account


delete/sites/environments/additional-sftp-accounts/{sftp_account_id}
Request samples 
Response samples 
application/json
{
  • "operation_id": "sftp-accounts:remove-additional-sftp-account-54fb80af-576c-4fdc-ba4f-b596c83f15a1",
  • "message": "Removing Additional SFTP Account in progress",
  • "status": 202
}
➔ Next to Backups