Table Of Contents

Previous topic

DHCP

Next topic

NAT

Ftp

The FTP API allow you to control the Freebox ftp server settings

Ftp Errors

When attempting to access the FTP API, you may encounter the following errors:

error_code Description
internal_error Internal error

Ftp Config

FtpConfig has the following attributes:

FtpConfig
enabled bool

is the FTP server enabled

allow_anonymous bool

can anonymous user log in

allow_anonymous_write bool

can anonymous user write data

password string Write-only

user password

Ftp config API

Get the current Ftp configuration

GET /api/v3/ftp/config/

Get the FtpConfig

Example request:

GET /api/v3/ftp/config/ HTTP/1.1
Host: mafreebox.freebox.fr

Example response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
    "success": true,
    "result": {
        "enabled": false,
        "allow_anonymous": false,
        "allow_anonymous_write": false
    }
}

Update the FTP configuration

PUT /api/v3/ftp/config/

Update the FtpConfig

Example request:

PUT /api/v3/ftp/config/ HTTP/1.1
Host: mafreebox.freebox.fr
{
   "enabled": true
}

Example response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
    "success": true,
    "result": {
        "enabled": true,
        "allow_anonymous": false,
        "allow_anonymous_write": false
    }
}