/v0/ftp/settings | Qumulo Documentation

Endpoint

/v0/ftp/settings

GET

Retrieve the current FTP server settings. To see server status on all nodes, use Get FTP Server Status.

Parameters

This resource has no parameters.

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "ftp_api_config",
  "type": "object",
  "properties": {
    "enabled": {
      "description": "When enabled, the cluster allows FTP connections.",
      "type": "boolean"
    },
    "check_remote_host": {
      "description": "When enabled, the cluster ensures that all connections for a session come from the same host. Disabling this allows for FXP.",
      "type": "boolean"
    },
    "log_operations": {
      "description": "log_operations",
      "type": "boolean"
    },
    "chroot_users": {
      "description": "chroot_users",
      "type": "boolean"
    },
    "allow_unencrypted_connections": {
      "description": "allow_unencrypted_connections",
      "type": "boolean"
    },
    "expand_wildcards": {
      "description": "When enabled, LIST and NLST commands support posix-like shell wild cards on the final directory component.",
      "type": "boolean"
    },
    "anonymous_user": {
      "description": "anonymous_user",
      "type": "object",
      "properties": {
        "id_type": {
          "type": "string",
          "enum": [
            "LOCAL_USER",
            "LOCAL_GROUP",
            "NFS_GID",
            "NFS_UID",
            "SMB_SID",
            "INTERNAL",
            "QUMULO_OPERATOR"
          ],
          "description": "id_type:\n * `INTERNAL` - INTERNAL,\n * `LOCAL_GROUP` - LOCAL_GROUP,\n * `LOCAL_USER` - LOCAL_USER,\n * `NFS_GID` - NFS_GID,\n * `NFS_UID` - NFS_UID,\n * `QUMULO_OPERATOR` - QUMULO_OPERATOR,\n * `SMB_SID` - SMB_SID"
        },
        "id_value": {
          "description": "id_value",
          "type": "string"
        }
      }
    },
    "greeting": {
      "description": "Greeting to display with the 220 successful connection message.",
      "type": "string"
    }
  }
}

PUT

Modify the current FTP server settings. To see server status on all nodes, use Get FTP Server Status.

Parameters

Name	Description	Required
`If-Match`	ETag for expected version	No

Request

Schema

{
  "description": "ftp_api_config",
  "type": "object",
  "properties": {
    "enabled": {
      "description": "When enabled, the cluster allows FTP connections.",
      "type": "boolean"
    },
    "check_remote_host": {
      "description": "When enabled, the cluster ensures that all connections for a session come from the same host. Disabling this allows for FXP.",
      "type": "boolean"
    },
    "log_operations": {
      "description": "log_operations",
      "type": "boolean"
    },
    "chroot_users": {
      "description": "chroot_users",
      "type": "boolean"
    },
    "allow_unencrypted_connections": {
      "description": "allow_unencrypted_connections",
      "type": "boolean"
    },
    "expand_wildcards": {
      "description": "When enabled, LIST and NLST commands support posix-like shell wild cards on the final directory component.",
      "type": "boolean"
    },
    "anonymous_user": {
      "description": "anonymous_user",
      "type": "object",
      "properties": {
        "id_type": {
          "type": "string",
          "enum": [
            "LOCAL_USER",
            "LOCAL_GROUP",
            "NFS_GID",
            "NFS_UID",
            "SMB_SID",
            "INTERNAL",
            "QUMULO_OPERATOR"
          ],
          "description": "id_type:\n * `INTERNAL` - INTERNAL,\n * `LOCAL_GROUP` - LOCAL_GROUP,\n * `LOCAL_USER` - LOCAL_USER,\n * `NFS_GID` - NFS_GID,\n * `NFS_UID` - NFS_UID,\n * `QUMULO_OPERATOR` - QUMULO_OPERATOR,\n * `SMB_SID` - SMB_SID"
        },
        "id_value": {
          "description": "id_value",
          "type": "string"
        }
      }
    },
    "greeting": {
      "description": "Greeting to display with the 220 successful connection message.",
      "type": "string"
    }
  }
}

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "ftp_api_config",
  "type": "object",
  "properties": {
    "enabled": {
      "description": "When enabled, the cluster allows FTP connections.",
      "type": "boolean"
    },
    "check_remote_host": {
      "description": "When enabled, the cluster ensures that all connections for a session come from the same host. Disabling this allows for FXP.",
      "type": "boolean"
    },
    "log_operations": {
      "description": "log_operations",
      "type": "boolean"
    },
    "chroot_users": {
      "description": "chroot_users",
      "type": "boolean"
    },
    "allow_unencrypted_connections": {
      "description": "allow_unencrypted_connections",
      "type": "boolean"
    },
    "expand_wildcards": {
      "description": "When enabled, LIST and NLST commands support posix-like shell wild cards on the final directory component.",
      "type": "boolean"
    },
    "anonymous_user": {
      "description": "anonymous_user",
      "type": "object",
      "properties": {
        "id_type": {
          "type": "string",
          "enum": [
            "LOCAL_USER",
            "LOCAL_GROUP",
            "NFS_GID",
            "NFS_UID",
            "SMB_SID",
            "INTERNAL",
            "QUMULO_OPERATOR"
          ],
          "description": "id_type:\n * `INTERNAL` - INTERNAL,\n * `LOCAL_GROUP` - LOCAL_GROUP,\n * `LOCAL_USER` - LOCAL_USER,\n * `NFS_GID` - NFS_GID,\n * `NFS_UID` - NFS_UID,\n * `QUMULO_OPERATOR` - QUMULO_OPERATOR,\n * `SMB_SID` - SMB_SID"
        },
        "id_value": {
          "description": "id_value",
          "type": "string"
        }
      }
    },
    "greeting": {
      "description": "Greeting to display with the 220 successful connection message.",
      "type": "string"
    }
  }
}

PATCH

Modify the current FTP server settings. To see server status on all nodes, use Get FTP Server Status.

Parameters

Name	Description	Required
`If-Match`	ETag for expected version	No

Request

Schema

{
  "description": "ftp_api_config",
  "type": "object",
  "properties": {
    "enabled": {
      "description": "When enabled, the cluster allows FTP connections.",
      "type": "boolean"
    },
    "check_remote_host": {
      "description": "When enabled, the cluster ensures that all connections for a session come from the same host. Disabling this allows for FXP.",
      "type": "boolean"
    },
    "log_operations": {
      "description": "log_operations",
      "type": "boolean"
    },
    "chroot_users": {
      "description": "chroot_users",
      "type": "boolean"
    },
    "allow_unencrypted_connections": {
      "description": "allow_unencrypted_connections",
      "type": "boolean"
    },
    "expand_wildcards": {
      "description": "When enabled, LIST and NLST commands support posix-like shell wild cards on the final directory component.",
      "type": "boolean"
    },
    "anonymous_user": {
      "description": "anonymous_user",
      "type": "object",
      "properties": {
        "id_type": {
          "type": "string",
          "enum": [
            "LOCAL_USER",
            "LOCAL_GROUP",
            "NFS_GID",
            "NFS_UID",
            "SMB_SID",
            "INTERNAL",
            "QUMULO_OPERATOR"
          ],
          "description": "id_type:\n * `INTERNAL` - INTERNAL,\n * `LOCAL_GROUP` - LOCAL_GROUP,\n * `LOCAL_USER` - LOCAL_USER,\n * `NFS_GID` - NFS_GID,\n * `NFS_UID` - NFS_UID,\n * `QUMULO_OPERATOR` - QUMULO_OPERATOR,\n * `SMB_SID` - SMB_SID"
        },
        "id_value": {
          "description": "id_value",
          "type": "string"
        }
      }
    },
    "greeting": {
      "description": "Greeting to display with the 220 successful connection message.",
      "type": "string"
    }
  }
}

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "ftp_api_config",
  "type": "object",
  "properties": {
    "enabled": {
      "description": "When enabled, the cluster allows FTP connections.",
      "type": "boolean"
    },
    "check_remote_host": {
      "description": "When enabled, the cluster ensures that all connections for a session come from the same host. Disabling this allows for FXP.",
      "type": "boolean"
    },
    "log_operations": {
      "description": "log_operations",
      "type": "boolean"
    },
    "chroot_users": {
      "description": "chroot_users",
      "type": "boolean"
    },
    "allow_unencrypted_connections": {
      "description": "allow_unencrypted_connections",
      "type": "boolean"
    },
    "expand_wildcards": {
      "description": "When enabled, LIST and NLST commands support posix-like shell wild cards on the final directory component.",
      "type": "boolean"
    },
    "anonymous_user": {
      "description": "anonymous_user",
      "type": "object",
      "properties": {
        "id_type": {
          "type": "string",
          "enum": [
            "LOCAL_USER",
            "LOCAL_GROUP",
            "NFS_GID",
            "NFS_UID",
            "SMB_SID",
            "INTERNAL",
            "QUMULO_OPERATOR"
          ],
          "description": "id_type:\n * `INTERNAL` - INTERNAL,\n * `LOCAL_GROUP` - LOCAL_GROUP,\n * `LOCAL_USER` - LOCAL_USER,\n * `NFS_GID` - NFS_GID,\n * `NFS_UID` - NFS_UID,\n * `QUMULO_OPERATOR` - QUMULO_OPERATOR,\n * `SMB_SID` - SMB_SID"
        },
        "id_value": {
          "description": "id_value",
          "type": "string"
        }
      }
    },
    "greeting": {
      "description": "Greeting to display with the 220 successful connection message.",
      "type": "string"
    }
  }
}