@folderharbor/sdk
    Preparing search index...

    Class ConfigResource

    Methods for reading and updating a FolderHarbor server's configuration

    Constructors

    Methods

    • Edits the server's configuration.

      Parameters

      Returns Promise<void>

      config:edit

      If your session is invalid, expired, or for a locked account

      If you don't have permission to take this admin action

      If anything else went wrong, either in the process of requesting, or in the response from the server

      await client.admin.config.edit({ 
        ftp: { 
          enabled: true,
          ssl: true
        },
        failedLoginLimit: 5
      });

    • Gets the server's current configuration.

      Returns Promise<FHServerConfig>

      The current configuration of the server

      config:read

      If your session is invalid, expired, or for a locked account

      If you don't have permission to take this admin action

      If anything else went wrong, either in the process of requesting, or in the response from the server

      const config = await client.admin.config.read();
    Constructors
    Methods