Resource URL: /platform/<<version=3>>/protocols/ftp/settings

    Overview: This resource represents global configuration for FTP.

     Methods: GET, PUT

********************************************************************************

Method GET: Retrieve the FTP settings.

       URL: GET /platform/<<version=3>>/protocols/ftp/settings

There are no query arguments for this method.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "type": "object", 
      "properties": {
        "settings": {
          "type": "object", 
          "description": "FTP settings.", 
          "properties": {
            "allow_dirlists": {
              "type": "boolean", 
              "description": "If set to false, all directory list commands will return a permission denied error."
            }, 
            "session_support": {
              "type": "boolean", 
              "description": "If enabled, maintain login sessions for each user through Pluggable Authentication Modules (PAM). Disabling this option prevents the ability to do automatic home directory creation if that functionality were otherwise available."
            }, 
            "file_create_perm": {
              "minimum": 0, 
              "type": "integer", 
              "description": "The permissions with which uploaded files are created. Umasks are applied on top of this value.", 
              "maximum": 511
            }, 
            "user_config_dir": {
              "type": "string", 
              "description": "Specifies the directory where per-user config overrides can be found."
            }, 
            "allow_anon_access": {
              "type": "boolean", 
              "description": "Controls whether anonymous logins are permitted or not."
            }, 
            "allow_writes": {
              "type": "boolean", 
              "description": "This controls whether any FTP commands which change the filesystem are allowed or not."
            }, 
            "local_root_path": {
              "type": "string", 
              "description": "This option represents a directory in /ifs which vsftpd will try to change into after a local login."
            }, 
            "service": {
              "type": "boolean", 
              "description": "This field controls whether the FTP daemon is running."
            }, 
            "allow_anon_upload": {
              "type": "boolean", 
              "description": "Controls whether anonymous users will be permitted to upload files."
            }, 
            "server_to_server": {
              "type": "boolean", 
              "description": "If enabled, allow server-to-server (FXP) transfers."
            }, 
            "anon_chown_username": {
              "type": "string", 
              "description": "This is the name of the user who is given ownership of anonymously uploaded files."
            }, 
            "connect_timeout": {
              "minimum": 30, 
              "type": "integer", 
              "description": "The timeout, in seconds, for a remote client to respond to our PORT style data connection.", 
              "maximum": 600
            }, 
            "allow_local_access": {
              "type": "boolean", 
              "description": "Controls whether local logins are permitted or not."
            }, 
            "always_chdir_homedir": {
              "type": "boolean", 
              "description": "This controls whether FTP will always initially change directories to the home directory of the user, regardless of whether it is chroot-ing."
            }, 
            "dirlist_names": {
              "enum": [
                "numeric", 
                "textual", 
                "hide"
              ], 
              "type": "string", 
              "description": "When set to 'hide',  all user and group information in directory listings will be displayed as 'ftp'. When set to 'textual', textual names are shown in the user and group fields of directory listings. When set to 'numeric', numeric IDs are show in the user and group fields of directory listings."
            }, 
            "accept_timeout": {
              "minimum": 30, 
              "type": "integer", 
              "description": "The timeout, in seconds, for a remote client to establish a PASV style data connection.", 
              "maximum": 600
            }, 
            "anon_root_path": {
              "type": "string", 
              "description": "This option represents a directory in /ifs which vsftpd will try to change into after an anonymous login."
            }, 
            "anon_umask": {
              "minimum": 0, 
              "type": "integer", 
              "description": "The value that the umask for file creation is set to for anonymous users.", 
              "maximum": 511
            }, 
            "allow_downloads": {
              "type": "boolean", 
              "description": "If set to false, all downloads requests will return a permission denied error."
            }, 
            "denied_user_list": {
              "items": {
                "type": "string"
              }, 
              "type": "array", 
              "description": "A list of uses that will be denied access."
            }, 
            "data_timeout": {
              "minimum": 30, 
              "type": "integer", 
              "description": "The timeout, in seconds, which is roughly the maximum time we permit data transfers to stall for with no progress. If the timeout triggers, the remote client is kicked off.", 
              "maximum": 600
            }, 
            "limit_anon_passwords": {
              "type": "boolean", 
              "description": "This field determines whether the anon_password_list is used."
            }, 
            "chroot_exception_list": {
              "items": {
                "type": "string"
              }, 
              "type": "array", 
              "description": "A list of users that are not chrooted when logging in."
            }, 
            "anon_password_list": {
              "items": {
                "type": "string"
              }, 
              "type": "array", 
              "description": "A list of passwords for anonymous users."
            }, 
            "local_umask": {
              "minimum": 0, 
              "type": "integer", 
              "description": "The value that the umask for file creation is set to for local users.", 
              "maximum": 511
            }, 
            "session_timeout": {
              "minimum": 30, 
              "type": "integer", 
              "description": "The timeout, in seconds, which is roughly the maximum time we permit data transfers to stall for with no progress. If the timeout triggers, the remote client is kicked off.", 
              "maximum": 600
            }, 
            "chroot_local_mode": {
              "enum": [
                "all", 
                "none", 
                "all-with-exceptions", 
                "none-with-exceptions"
              ], 
              "type": "string", 
              "description": "If set to 'all', all local users will be (by default) placed in a chroot() jail in their home directory after login. If set to 'all-with-exceptions', all local users except those listed in the chroot exception list (isi ftp chroot-exception-list) will be placed in a chroot() jail in their home directory after login. If set to 'none', no local users will be chrooted by default. If set to 'none-with-exceptions', only the local users listed in the chroot exception list (isi ftp chroot-exception-list) will be place in a chroot() jail in their home directory after login."
            }, 
            "dirlist_localtime": {
              "type": "boolean", 
              "description": "If enabled, display directory listings with the time in your local time zone. The default is to display GMT. The times returned by the MDTM FTP command are also affected by this option."
            }, 
            "ascii_mode": {
              "enum": [
                "off", 
                "upload", 
                "download", 
                "both"
              ], 
              "type": "string", 
              "description": "Controls whether ascii mode data transfers are honored for various types of requests."
            }
          }
        }
      }
    }
  ]
}

********************************************************************************

Method PUT: Modify the FTP settings. All input fields are optional, but one or
            more must be supplied.

       URL: PUT /platform/<<version=3>>/protocols/ftp/settings

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "description": "FTP settings.", 
  "properties": {
    "allow_dirlists": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "If set to false, all directory list commands will return a permission denied error."
        }
      ]
    }, 
    "session_support": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "If enabled, maintain login sessions for each user through Pluggable Authentication Modules (PAM). Disabling this option prevents the ability to do automatic home directory creation if that functionality were otherwise available."
        }
      ]
    }, 
    "file_create_perm": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "The permissions with which uploaded files are created. Umasks are applied on top of this value.", 
          "maximum": 511
        }
      ]
    }, 
    "user_config_dir": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "string", 
          "description": "Specifies the directory where per-user config overrides can be found."
        }
      ]
    }, 
    "allow_anon_access": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Controls whether anonymous logins are permitted or not."
        }
      ]
    }, 
    "allow_writes": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "This controls whether any FTP commands which change the filesystem are allowed or not."
        }
      ]
    }, 
    "local_root_path": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "string", 
          "description": "This option represents a directory in /ifs which vsftpd will try to change into after a local login."
        }
      ]
    }, 
    "service": {
      "type": "boolean", 
      "description": "This field controls whether the FTP daemon is running."
    }, 
    "allow_anon_upload": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Controls whether anonymous users will be permitted to upload files."
        }
      ]
    }, 
    "server_to_server": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "If enabled, allow server-to-server (FXP) transfers."
        }
      ]
    }, 
    "anon_chown_username": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "string", 
          "description": "This is the name of the user who is given ownership of anonymously uploaded files."
        }
      ]
    }, 
    "connect_timeout": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 30, 
          "type": "integer", 
          "description": "The timeout, in seconds, for a remote client to respond to our PORT style data connection.", 
          "maximum": 600
        }
      ]
    }, 
    "allow_local_access": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Controls whether local logins are permitted or not."
        }
      ]
    }, 
    "always_chdir_homedir": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "This controls whether FTP will always initially change directories to the home directory of the user, regardless of whether it is chroot-ing."
        }
      ]
    }, 
    "dirlist_names": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "enum": [
            "numeric", 
            "textual", 
            "hide"
          ], 
          "type": "string", 
          "description": "When set to 'hide',  all user and group information in directory listings will be displayed as 'ftp'. When set to 'textual', textual names are shown in the user and group fields of directory listings. When set to 'numeric', numeric IDs are show in the user and group fields of directory listings."
        }
      ]
    }, 
    "accept_timeout": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 30, 
          "type": "integer", 
          "description": "The timeout, in seconds, for a remote client to establish a PASV style data connection.", 
          "maximum": 600
        }
      ]
    }, 
    "anon_root_path": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "string", 
          "description": "This option represents a directory in /ifs which vsftpd will try to change into after an anonymous login."
        }
      ]
    }, 
    "anon_umask": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "The value that the umask for file creation is set to for anonymous users.", 
          "maximum": 511
        }
      ]
    }, 
    "allow_downloads": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "If set to false, all downloads requests will return a permission denied error."
        }
      ]
    }, 
    "denied_user_list": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "items": {
            "type": "string"
          }, 
          "type": "array", 
          "description": "A list of uses that will be denied access."
        }
      ]
    }, 
    "data_timeout": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 30, 
          "type": "integer", 
          "description": "The timeout, in seconds, which is roughly the maximum time we permit data transfers to stall for with no progress. If the timeout triggers, the remote client is kicked off.", 
          "maximum": 600
        }
      ]
    }, 
    "limit_anon_passwords": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "This field determines whether the anon_password_list is used."
        }
      ]
    }, 
    "chroot_exception_list": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "items": {
            "type": "string"
          }, 
          "type": "array", 
          "description": "A list of users that are not chrooted when logging in."
        }
      ]
    }, 
    "anon_password_list": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "items": {
            "type": "string"
          }, 
          "type": "array", 
          "description": "A list of passwords for anonymous users."
        }
      ]
    }, 
    "local_umask": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "The value that the umask for file creation is set to for local users.", 
          "maximum": 511
        }
      ]
    }, 
    "session_timeout": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 30, 
          "type": "integer", 
          "description": "The timeout, in seconds, which is roughly the maximum time we permit data transfers to stall for with no progress. If the timeout triggers, the remote client is kicked off.", 
          "maximum": 600
        }
      ]
    }, 
    "chroot_local_mode": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "enum": [
            "all", 
            "none", 
            "all-with-exceptions", 
            "none-with-exceptions"
          ], 
          "type": "string", 
          "description": "If set to 'all', all local users will be (by default) placed in a chroot() jail in their home directory after login. If set to 'all-with-exceptions', all local users except those listed in the chroot exception list (isi ftp chroot-exception-list) will be placed in a chroot() jail in their home directory after login. If set to 'none', no local users will be chrooted by default. If set to 'none-with-exceptions', only the local users listed in the chroot exception list (isi ftp chroot-exception-list) will be place in a chroot() jail in their home directory after login."
        }
      ]
    }, 
    "dirlist_localtime": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "If enabled, display directory listings with the time in your local time zone. The default is to display GMT. The times returned by the MDTM FTP command are also affected by this option."
        }
      ]
    }, 
    "ascii_mode": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "enum": [
            "off", 
            "upload", 
            "download", 
            "both"
          ], 
          "type": "string", 
          "description": "Controls whether ascii mode data transfers are honored for various types of requests."
        }
      ]
    }
  }
}

There is no JSON response body for this method.
