# WEKA REST API and equivalent CLI commands To maximize your success with the REST API, it's essential to familiarize yourself with the comprehensive documentation. This valuable resource provides in-depth insights into the subject matter. Moreover, each REST API method corresponds to a CLI command. Additionally, many parameters accessible through the CLI are equally accessible when using the REST API. Run the CLI command help for details. This ensures a smooth and consistent experience across both interfaces. ## Active Directory Related information: [user-management](https://docs.weka.io/4.3/operation-guide/user-management "mention") | Task | REST API | CLI | | ---------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | ------------------------- | | **Update Active Directory:** Change the cluster's configuration to use a different Active Directory server or modify its settings. | [PUT ​/activeDirectory](https://api.docs.weka.io/?urls.primaryName=4.3#/Active%20directory/updateLdapActiveDirectory) | `weka user ldap setup-ad` | ## Alerts Related information: [alerts](https://docs.weka.io/4.3/operation-guide/alerts "mention") | Task | REST API | CLI | | ---------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | | **View all alerts:** Get a complete list of active alerts, including silenced ones. | [GET ​/alerts](https://api.docs.weka.io/?urls.primaryName=4.3#/Alerts/getAlerts) | `weka alerts` | | **List possible alerts:** See all types of alerts the cluster can generate. | [GET ​/alerts​/types](https://api.docs.weka.io/?urls.primaryName=4.3#/Alerts/getAlertsTypes) | `weka alerts types` | | **List alert types with actions:** View different alert types and their recommended troubleshooting steps. | [GET ​/alerts​/description](https://api.docs.weka.io/?urls.primaryName=4.3#/Alerts/getAlertDescription) | `weka alerts describe` | | **Mute alerts by type:** Silence specific types of alerts. | [PUT ​/alerts​/{alert\_type}​/mute](https://api.docs.weka.io/?urls.primaryName=4.3#/Alerts/muteAlertByType) | `weka alerts mute ` | | **Unmute alerts by type:** Reactivate specific types of alerts. | [PUT ​/alerts​/{alert\_type}​/unmute](https://api.docs.weka.io/?urls.primaryName=4.3#/Alerts/unmuteAlertByType) | `weka alerts unmute ` | ## WEKA Home Related information: [the-wekaio-support-cloud](https://docs.weka.io/4.3/monitor-the-weka-cluster/the-wekaio-support-cloud "mention") | Task | REST API | CLI | | -------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | | **View cloud WEKA Home configuration:** See the existing settings for the cloud WEKA Home service. | [GET ​/wekaHome](https://api.docs.weka.io/?urls.primaryName=4.3#/Weka%20home/getCloud) | `weka cloud status` | | **View cloud WEKA Home proxy URL:** Get the existing URL to access cloud services. | [GET ​/wekaHome​/proxy](https://api.docs.weka.io/?urls.primaryName=4.3#/Weka%20home/getCloudProxy) | `weka cloud proxy` | | **Set cloud WEKA Home proxy URL:** Change the URL used to access cloud services. | [POST ​/wekaHome​/proxy](https://api.docs.weka.io/?urls.primaryName=4.3#/Weka%20home/setCloudProxy) | `weka cloud proxy --set ` | | **View cloud WEKA Home upload rate:** See the existing data upload speed to the cloud service. | [GET ​/wekaHome​/uploadRate](https://api.docs.weka.io/?urls.primaryName=4.3#/Weka%20home/getCloudUploadRate) | `weka cloud upload-rate` | | **Set cloud WEKA Home upload rate:** Define the preferred data upload speed to the cloud service. | [PUT ​/wekaHome​/uploadRate](https://api.docs.weka.io/?urls.primaryName=4.3#/Weka%20home/updateCloudUploadRate) | `weka cloud upload-rate set --bytes-per-second ` | | **View cloud WEKA Home URL:** Get the URL for accessing the cloud WEKA Home service. | [GET ​/wekaHome​/url](https://api.docs.weka.io/?urls.primaryName=4.3#/Weka%20home/getCloudUrl) | `weka cloud status` | | **Enable cloud WEKA Home:** Start using the cloud WEKA Home service. | [POST ​/wekaHome​/enable](https://api.docs.weka.io/?urls.primaryName=4.3#/Weka%20home/enableCloud) | `weka cloud enable --cloud-url --cloud-stats ` | | **Disable cloud WEKA Home:** Stop using the cloud WEKA Home service. | [POST ​/wekaHome​/disable](https://api.docs.weka.io/?urls.primaryName=4.3#/Weka%20home/disableCloud) | `weka cloud disable` | ## Cluster Related information: [bare-metal](https://docs.weka.io/4.3/planning-and-installation/bare-metal "mention") | Task | REST API | CLI | | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -------------------------------------- | | **Create a cluster:** Start a new cluster with chosen configurations. | [POST ​/cluster](https://api.docs.weka.io/?urls.primaryName=4.3#/Cluster/createCluster) | `weka cluster create ` | | **Update cluster configuration:** Modify settings for an existing cluster. | [PUT ​/cluster](https://api.docs.weka.io/?urls.primaryName=4.3#/Cluster/updateCluster) | `weka cluster update` | | **View cluster status:** Check the overall health and performance of the cluster. | [GET ​/cluster](https://api.docs.weka.io/?urls.primaryName=4.3#/Cluster/getClusterStatus) | `weka status --json` | ## Containers Related information: [expanding-and-shrinking-cluster-resources](https://docs.weka.io/4.3/operation-guide/expanding-and-shrinking-cluster-resources "mention") | Task | REST API | CLI | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | | **List containers:** See all containers running in the cluster. | [GET ​/containers](https://api.docs.weka.io/?urls.primaryName=4.3#/Containers/getContainers) | `weka cluster container` | | **Add a container:** Introduce a new container to the cluster (apply afterward to activate). | [POST ​/containers](https://api.docs.weka.io/?urls.primaryName=4.3#/Containers/addContainer) | `weka cluster container add ` | | **View container details:** Get information about a specific container (resources, state). | [GET ​/containers​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Containers/getSingleContainer) | `weka cluster container ` | | **Update container configuration:** Change settings for a container (cores, memory). | [PUT ​/containers​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Containers/updateContainer) | `weka cluster container ` | | **Manage protocol containers:** Restart the containers. | [POST​/containers​/manageProtoContainers](https://api.docs.weka.io/?urls.primaryName=4.3#/Containers/manageProtoContainers)\*\* | `weka local restart ` | | **Remove a container:** Stop and delete a container from the cluster. | [DELETE ​/containers​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Containers/removeContainer) | `weka cluster container remove ` | | **Apply configuration updates:** Implement changes to all containers. | [POST ​/containers​/apply](https://api.docs.weka.io/?urls.primaryName=4.3#/Containers/applyContainers) | `weka cluster container apply` | | **Apply configuration updates:** Implement changes to specific containers. | [POST ​/containers​/{uid}​/apply](https://api.docs.weka.io/?urls.primaryName=4.3#/Containers/applyContainer) | `weka cluster container apply ` | | **Clear container failure:** Reset the error record for a container. | [DELETE ​/containers​/lastFailureReason​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Containers/clearContainerFailure) | `weka cluster container clear-failure` | | **Monitor container resources:** Track resource usage (CPU, memory) for containers. | [GET ​/containers​/{uid}​/resources](https://api.docs.weka.io/?urls.primaryName=4.3#/Containers/getContainersResources) | `weka cluster container resources ` | | **Start all containers:** Bring all inactive containers online and running. | [POST ​/containers​/activate](https://api.docs.weka.io/?urls.primaryName=4.3#/Containers/activateContainers) | `weka cluster container activate` | | **Start a specific container:** Activate an individual container by name or identifier. | [POST ​/containers​/{uid}​/activate](https://api.docs.weka.io/?urls.primaryName=4.3#/Containers/activateContainer) | `weka cluster container activate ` | | **Stop all containers:** Gracefully shut down all running containers. | [POST ​/containers​/deactivate](https://api.docs.weka.io/?urls.primaryName=4.3#/Containers/deactivateContainers) | `weka cluster container deactivate` | | **Stop a specific container:** Deactivate an individual container by name or identifier. | [POST ​/containers​/{uid}​/deactivate](https://api.docs.weka.io/?urls.primaryName=4.3#/Containers/deactivateContainer) | `weka cluster container deactivate ` | | **View network details for all containers:** See the network configuration and connectivity information for each container within the cluster. | [GET ​/containers​/netdevs](https://api.docs.weka.io/?urls.primaryName=4.3#/Containers/getAllContainersNetwork) | `weka cluster container net` | | **View network details for a specific container:** See the network configuration and connectivity information for a single container specified by its name or identifier. | [GET ​/containers​/{uid}​/netdevs](https://api.docs.weka.io/?urls.primaryName=4.3#/Containers/getContainerNetwork) | `weka cluster container net ` | | **Assign dedicated network:** Give a container its network device (apply afterward to activate). | [POST ​/containers​/{uid}​/netdevs](https://api.docs.weka.io/?urls.primaryName=4.3#/Containers/createContainerNetwork) | `weka cluster container net add ` | | **Remove dedicated network:** Take away a container's dedicated network device (apply afterward to activate). | [DELETE ​/containers​/{uid}​/netdevs​/{netdev\_uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Containers/removeContainerNetwork) | `weka cluster container net remove ` | | **View container hardware:** See hardware details (IP addresses) for containers. | [POST ​/containers​/infos](https://api.docs.weka.io/?urls.primaryName=4.3#/Containers/getContainersInfo) | `weka cluster container info-hw` | ## Default network Related information: [#id-6.-configure-default-data-networking-optional](https://docs.weka.io/4.3/planning-and-installation/bare-metal/perform-post-configuration-procedures#id-6.-configure-default-data-networking-optional "mention") | Task | REST API | CLI | | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | --------------------------------- | | **Check default network setup:** Review the predefined network properties for container deployments. | [GET ​/defaultNet](https://api.docs.weka.io/?urls.primaryName=4.3#/Default%20network/getDefaultNetwork) | `weka cluster default-net` | | **Define new network defaults:** Define the IP address range, gateway address, and subnet mask to be used for future container network assignments. | [POST ​/defaultNet](https://api.docs.weka.io/?urls.primaryName=4.3#/Default%20network/setDefaultNetwork) | `weka cluster default-net set` | | **Modify existing network defaults:** Change the parameters like IP range, gateway, or subnet mask used for future container network assignments. | [PUT ​/defaultNet](https://api.docs.weka.io/?urls.primaryName=4.3#/Default%20network/updateDefaultNetwork) | `weka cluster default-net update` | | **Clear custom network defaults:** Remove any modifications to the standard network settings and return to the initial baseline. | [DELETE ​/defaultNet](https://api.docs.weka.io/?urls.primaryName=4.3#/Default%20network/resetDefaultNetwork) | `weka cluster default-net reset` | ## Drive Related information: [expanding-and-shrinking-cluster-resources](https://docs.weka.io/4.3/operation-guide/expanding-and-shrinking-cluster-resources "mention") | Task | REST API | CLI | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | | **View a list of all SSD drives in the cluster:** Get information about all available SSD drives within the cluster, including size, UUID, status, and more. drive | [GET ​/drives](https://api.docs.weka.io/?urls.primaryName=4.3#/Drive/getDrives) | `weka cluster drive` | | **Add a new SSD drive to a container:** Attach an additional SSD drive to a specific container within the cluster to expand its available resources. | [POST ​/drives](https://api.docs.weka.io/?urls.primaryName=4.3#/Drive/provisionDrives) | `weka cluster drive add ` | | **View a specific SSD drive in the cluster:** Get detailed information about a particular SSD drive in the cluster. | [GET ​/drives​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Drive/getSingleDrive) | `weka cluster drive ` | | **Remove an SSD drive from the cluster:** Detach an SSD drive from the cluster, making it unavailable for further use. | [DELETE ​/drives​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Drive/deleteDrive) | `weka cluster drive remove ` | | **Activate SSD drives in the cluster:** Bring one or more SSD drives online and make them available for use in the cluster. | [POST ​/drives​/activate](https://api.docs.weka.io/?urls.primaryName=4.3#/Drive/activateDrives) | `weka cluster drive activate ` | | **Deactivate SSD drives in the cluster:** Temporarily take one or more SSD drives offline, preventing their use in the cluster while preserving the stored data. | [POST ​/drives​/deactivate](https://api.docs.weka.io/?urls.primaryName=4.3#/Drive/deactivatesDrives) | `weka cluster drive deactivate ` | ## Events Related information: [events](https://docs.weka.io/4.3/operation-guide/events "mention") | **Filter and explore events:** Find specific events in the cluster by applying filters based on criteria like severity, category, and time range. | [GET ​/events](https://api.docs.weka.io/?urls.primaryName=4.3#/Events/getEvents) | `weka events` | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | | **Get event details:** View a detailed description of a specific event type, including its meaning and potential causes. | [GET ​/events​/describe](https://api.docs.weka.io/?urls.primaryName=4.3#/Events/getEventsDescription) | `weka events list-types` | | **Analyze event trends:** See how events occur over time by aggregating them within a specific time interval. | [GET ​/events​/aggregate](https://api.docs.weka.io/?urls.primaryName=4.3#/Events/getAggregateEvents) | `weka events --start-time --end-time --show-internal` | | **Trace events by server:** Focus on events generated by a specific server in the cluster for deeper troubleshooting. | [GET ​/events​/local](https://api.docs.weka.io/?urls.primaryName=4.3#/Events/getLocalEvents) | `weka events list-local` | | **Create custom events:** Trigger and record your custom events with additional user-defined parameters for enhanced monitoring and logging. | [POST /events/custom](https://api.docs.weka.io/?urls.primaryName=4.3#/Events/triggerCustomEvent) | `weka events trigger-event` | ## Failure domains Related information: [ssd-capacity-management](https://docs.weka.io/4.3/weka-system-overview/ssd-capacity-management "mention") | Task | REST API | CLI | | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | | **View all failure domains:** Get a list of all available failure domains within the cluster. | [GET ​/failureDomains](https://api.docs.weka.io/?urls.primaryName=4.3#/Failure%20domains/getFailureDomains) | `weka cluster failure-domain` | | **View details of a specific failure domain:** See information about a single failure domain, including its resources and capacity. | [GET ​/failureDomains​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Failure%20domains/getSingleFailureDomain) | `weka cluster container ` | ## Filesystem Related information: * [filesystems](https://docs.weka.io/4.3/weka-system-overview/filesystems "mention") * [managing-filesystems](https://docs.weka.io/4.3/weka-filesystems-and-object-stores/managing-filesystems "mention") * [attaching-detaching-object-stores-to-from-filesystems](https://docs.weka.io/4.3/weka-filesystems-and-object-stores/attaching-detaching-object-stores-to-from-filesystems "mention") | Task | REST API | CLI | | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | | **List all filesystems:** Get a complete list of all defined filesystems in the cluster. | [GET ​/fileSystems](https://api.docs.weka.io/?urls.primaryName=4.3#/Filesystem/getFileSystems) | `weka fs` | | **Create a new filesystem:** Configure and establish a new filesystem within the cluster. | [POST ​/fileSystems](https://api.docs.weka.io/?urls.primaryName=4.3#/Filesystem/createFileSystem) | `weka fs create` | | **View details of a specific filesystem:** Obtain specific information about a specified filesystem, like its size, quota, and usage. | [GET ​/fileSystems​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Filesystem/getFileSystem) | `weka fs --name ` | | **Modify a filesystem:** Change the settings or properties of an existing filesystem. | [PUT ​/fileSystems​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Filesystem/updateFileSystem) | `weka fs update ` | | **Delete a filesystem:** Remove a chosen filesystem and its data from the cluster. | [DELETE ​/fileSystems​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Filesystem/deleteFileSystem) | `weka fs delete ` | | **Attach an object store bucket:** Link an object store bucket to a filesystem, allowing data access from both locations. | [POST ​/fileSystems​/{uid}​/objectStoreBuckets](https://api.docs.weka.io/?urls.primaryName=4.3#/Filesystem/attachObsBucketToFs) | `weka fs tier s3 attach ` | | **Detach an object store bucket:** Disconnect an object store bucket from a filesystem, separating their data access. | [DELETE ​/fileSystems​/{uid}​/objectStoreBuckets​/{obs\_uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Filesystem/detachObsBucketFromFS) | `weka fs tier s3 detach ` | | **Restore a filesystem from a snapshot:** Create a new filesystem based on a saved snapshot stored in an object store bucket. | [POST ​/fileSystems​/download](https://api.docs.weka.io/?urls.primaryName=4.3#/Filesystem/downloadFS) | `weka fs download` | | **View thin-provisioning status:** Check the existing allocated thin-provisioning space reserved for your organization within the cluster. | [GET ​/fileSystems​/thinProvisionReserve](https://api.docs.weka.io/?urls.primaryName=4.3#/Filesystem/getFileSystemsThinProvisionReserveStatus) | `weka fs reserve status` | | **Reserve guaranteed SSD for your organization:** Set the thin-provisioning space for your organization's filesystems. | [PUT ​/fileSystems​/thinProvisionReserve​/{org\_uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Filesystem/setFileSystemsThinProvisionReserve) | `weka fs reserve set ` | | **Release dedicated SSD space for your organization:** Remove the existing reserved thin-provisioning space allocated for your organization's filesystems. | [DELETE ​/fileSystems​/thinProvisionReserve​/{org\_uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Filesystem/deleteFileSystemsThinProvisionReserve) | `weka fs reserve unset --org ` | | **Get metadata for a specific file or directory:** See detailed information about a specific file or directory using its unique identifier "inode context". | [GET ​/fileSystems​/{inode\_context}​/resolve](https://api.docs.weka.io/?urls.primaryName=4.3#/File%20system/filesystemResolveInode) | `weka debug fs resolve-inode` | ## Quota Related information: [quota-management](https://docs.weka.io/4.3/weka-filesystems-and-object-stores/quota-management "mention") | Task | REST API | CLI | | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | **View quotas:** See a list of the existing quota settings for all directories within the filesystem. | [GET ​/fileSystems​/{uid}​/quota](https://api.docs.weka.io/?urls.primaryName=4.3#/Quota/listQuotas) | `weka fs quota list ` | | **View default quotas:** Check the default quota configuration applied to new directories. | [GET ​/fileSystems​/{uid}​/quota​/default](https://api.docs.weka.io/?urls.primaryName=4.3#/Quota/listDefaultQuotas) | `weka fs quota list-default` | | **View/list the parameters of a specific directory quota** | [GET ​/fileSystems​/{uid}​/quota​/{inode\_id}](https://api.docs.weka.io/?urls.primaryName=4.3#/Quota/getQuota) | `weka fs quota list --path ` | | **Set/update a directory quota:** Specify disk space limits for an individual directory. | [PUT ​/fileSystems​/{uid}​/quota​/{inode\_id}](https://api.docs.weka.io/?urls.primaryName=4.3#/Quota/putQuota) | `weka fs quota set ` | | **Update directory quota parameters:** Modify specific settings (like grace period) for an existing directory quota. | [PATCH ​/fileSystems​/{uid}​/quota​/{inode\_id}](https://api.docs.weka.io/?urls.primaryName=4.3#/Quota/patchQuota) | `weka fs quota set --soft --hard --grace --owner ` | | **Remove a directory quota:** Disable the quota restrictions for a directory. | [DELETE ​/fileSystems​/{uid}​/quota​/{inode\_id}](https://api.docs.weka.io/?urls.primaryName=4.3#/Quota/deleteQuota) | `weka fs quota unset ` | | **Set/update default quota:** Establish or change the default quota applied to all newly created directories. | [PUT ​/fileSystems​/quota​/{inode\_context}](https://api.docs.weka.io/?urls.primaryName=4.3#/Quota/putDefaultQuota) | `weka fs quota set-default ` | | **Unset a default directory quota:** Disable the pre-defined quota restrictions automatically applied to new directories within the filesystem. | [DELETE ​/fileSystems​/quota​/{inode\_id}​/default](https://api.docs.weka.io/?urls.primaryName=4.3#/Quota/deleteDefaultQuota) | `weka fs quota unset-default ` | ## Filesystem group Related information: [managing-filesystem-groups](https://docs.weka.io/4.3/weka-filesystems-and-object-stores/managing-filesystem-groups "mention") | Task | REST API | CLI | | -------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | | **View filesystem groups:** See a list of all existing filesystem groups. | [GET ​/fileSystemGroups](https://api.docs.weka.io/?urls.primaryName=4.3#/Filesystem%20group/getFileSystemGroups) | `weka fs group` | | **Create/add a filesystem group:** Establish a new group to share and manage access control for certain filesystems. | [POST ​/fileSystemGroups](https://api.docs.weka.io/?urls.primaryName=4.3#/Filesystem%20group/createFileSystemGroup) | `weka fs group create` | | **View filesystem group details:** Get specific information about a particular filesystem group. | [GET ​/fileSystemGroups​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Filesystem%20group/getFileSystemGroup) | N/A | | **Update a filesystem group:** Modify the properties of an existing filesystem group. | [PUT ​/fileSystemGroups​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Filesystem%20group/updateFileSystemGroup) | `weka fs group update ` | | **Delete a filesystem group:** Remove a filesystem group and its associated permissions. | [DELETE ​/fileSystemGroups​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Filesystem%20group/deleteFileSystemGroup) | `weka fs group delete ` | ## Health Related information: [#cluster-protection-and-availability-widget](https://docs.weka.io/4.3/manage-the-system-using-weka-gui#cluster-protection-and-availability-widget "mention") | Task | REST API | CLI | | ---------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | --- | | **Check REST API status:** Verify the existing functionality and availability of the REST API used for programmatic system access. | [GET ​/healthcheck](https://api.docs.weka.io/?urls.primaryName=4.3#/Health/getApiHealth) | N/A | | **Check GUI status:** Confirm the proper operation and responsiveness of the graphical user interface. | [GET ​/ui​/healthcheck](https://api.docs.weka.io/?urls.primaryName=4.3#/Health/getUIHealth) | N/A | ## Interface Group Related information: [nfs-support](https://docs.weka.io/4.3/additional-protocols/nfs-support "mention") | Task | REST API | CLI | | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------- | | **View interface groups:** See a list of all interface groups configured in the system. | [GET ​/interfaceGroups](https://api.docs.weka.io/?urls.primaryName=4.3#/Interface%20group/getInterfaceGroups) | `weka nfs interface-group` | | **Create/add an interface group:** Set up a new interface group to manage network configuration for specific P addresses and ports. | [POST ​/interfaceGroups](https://api.docs.weka.io/?urls.primaryName=4.3#/Interface%20group/createInterfaceGroup) | `weka nfs interface-group add` | | **View interface group details:** See specific information about a particular interface group. | [GET ​/interfaceGroups​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Interface%20group/getInterfaceGroup) | `weka nfs interface-group --name ` | | **Delete an interface group:** Remove an interface group and its associated network definitions. | [DELETE ​/interfaceGroups​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Interface%20group/deleteInterfaceGroup) | `weka nfs interface-group delete ` | | **Update an interface group:** Modify the settings of an existing interface group. | [PUT ​/interfaceGroups​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Interface%20group/updateInterfaceGroup) | `weka nfs interface-group update ` | | **Add an IP range to an interface group:** Define a specific range of IP addresses within the existing interface group for network access. | [POST ​/interfaceGroups​/{uid}​/ips](https://api.docs.weka.io/?urls.primaryName=4.3#/Interface%20group/crateInterfaceGroupIp) | `weka nfs interface-group ip-range add ` | | **Add a port to an interface group:** Assign a specific port number to the interface group, making it accessible through that port. | [POST ​/interfaceGroups​/{uid}​/ports​/{container\_uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Interface%20group/addPortToInterfaceGroup) | `weka nfs interface-group port add ` | | **Remove an IP range from an interface group:** Delete a previously defined IP range from the interface group, disabling its access. | [DELETE ​/interfaceGroups​/{uid}​/ports​/{container\_uid}​/{port}](https://api.docs.weka.io/?urls.primaryName=4.3#/Interface%20group/deletePortFromInterfaceGroup) | `weka nfs interface-group port delete ` | | **Remove a port from an interface group:** Unassign a specific port from the interface group, making it no longer accessible through that port. | [DELETE ​/interfaceGroups​/{uid}​/ips​/{ips}](https://api.docs.weka.io/?urls.primaryName=4.3#/Interface%20group/deleteIpRangeFromInterfaceGroup) | `weka nfs interface-group ip-range delete ` | | **View floating IPs:** See a list of all allocated floating IPs and their existing assignments. | [GET ​/interfaceGroups​/listAssignment](https://api.docs.weka.io/?urls.primaryName=4.3#/Interface%20group/getInterfaceGroupsListAssignment) | `weka nfs interface-group assignment` | | **Add port for all interface groups:** Assign a port to be accessible by the specified interface group. | [POST ​/interfaceGroups​/port](https://api.docs.weka.io/?urls.primaryName=4.3#/Interface%20group/interfaceGroupAddPort) |

weka nfs interface-group port add \
\ \

| ## KMS Related information: [security](https://docs.weka.io/4.3/operation-guide/security "mention") | Task | REST API | CLI | | ----------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | --------------------------------------------------------- | | **View KMS configuration:** See the existing Key Management Service (KMS) settings for encrypting filesystems. | [GET ​/kms](https://api.docs.weka.io/?urls.primaryName=4.3#/KMS/getKms) | `weka security kms` | | **Set configuration (new KMS):** Establish a new KMS configuration with details like type, address, and key identifier. | [POST ​/kms](https://api.docs.weka.io/?urls.primaryName=4.3#/KMS/setKms) | `weka security kms set
` | | **Delete configuration (unused only):** Remove the KMS configuration if no encrypted filesystems rely on it. | [DELETE ​/kms](https://api.docs.weka.io/?urls.primaryName=4.3#/KMS/deleteKms) | `weka security kms unset` | | **View existing KMS type:** Find out whether HashiCorp Vault or KMIP is used for KMS. | [GET ​/kms​/type](https://api.docs.weka.io/?urls.primaryName=4.3#/KMS/getKmsType) | `weka security kms` | | **Re-encrypt filesystems:** Update the encryption keys for existing filesystems using the new KMS master key. | [POST ​/kms​/rewrap](https://api.docs.weka.io/?urls.primaryName=4.3#/KMS/rewrapKmsKey) | `weka security kms rewrap` | ## LDAP Related information: [user-management](https://docs.weka.io/4.3/operation-guide/user-management "mention") | Task | REST API | CLI | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ------------------------ | | **View LDAP configuration:** Get detailed information about the configured settings for connecting to your LDAP server. This includes information like the server address, port, base DN, and authentication method. | [GET ​/ldap](https://api.docs.weka.io/?urls.primaryName=4.3#/LDAP/getLdap) | `weka user ldap` | | **Update LDAP configuration:** Modify the existing settings used for connecting to your LDAP server. This may involve changing the server details, authentication credentials, or other relevant parameters. | [PUT ​/ldap](https://api.docs.weka.io/?urls.primaryName=4.3#/LDAP/updateLdap) | `weka user ldap setup` | | **Disable LDAP:** Deactivate the integration with your LDAP server for user authentication. | [DELETE ​/ldap](https://api.docs.weka.io/?urls.primaryName=4.3#/LDAP/deleteLdap) | `weka user ldap disable` | ## License Related information: [overview](https://docs.weka.io/4.3/licensing/overview "mention") | Task | REST API | CLI | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ------------------------------------ | | **View license details:** Get information about the configured cluster license, including resource usage and validity. | [GET ​/license](https://api.docs.weka.io/?urls.primaryName=4.3#/License/getLicense) | `weka cluster license` | | **Set license:** Install a new cluster license for continued operation. | [POST ​/license](https://api.docs.weka.io/?urls.primaryName=4.3#/License/setLicense) | `weka cluster license set ` | | **Remove license:** Deactivate the existing license and return the cluster to unlicensed mode. | [DELETE ​/license](https://api.docs.weka.io/?urls.primaryName=4.3#/License/resetLicense) | `weka cluster license reset` | ## Lockout policy Related information: [account-lockout-threshold-policy-management](https://docs.weka.io/4.3/operation-guide/security/account-lockout-threshold-policy-management "mention") | Task | REST API | CLI | | ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------ | | **View policy:** See the configured settings for the lockout policy, including attempt limits and duration. | [GET ​/lockoutPolicy](https://api.docs.weka.io/?urls.primaryName=4.3#/Lockout%20policy/getLockoutPolicy) | `weka security lockout-config show` | | **Update policy:** Modify the parameters of the lockout policy to adjust login security. | [PUT ​/lockoutPolicy](https://api.docs.weka.io/?urls.primaryName=4.3#/Lockout%20policy/setLockoutPolicy) | `weka security lockout-config set` | | **Reset lockout:** Clear the failed login attempts counter and unlock any currently locked accounts. | [DELETE ​/lockoutPolicy](https://api.docs.weka.io/?urls.primaryName=4.3#/Lockout%20policy/resetLockoutPolicy) | `weka security lockout-config reset` | ## Login Related information: [obtain-authentication-tokens](https://docs.weka.io/4.3/operation-guide/security/obtain-authentication-tokens "mention") | Task | REST API | CLI | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ----------------- | | **Log in to the cluster:** Authenticate and grant access to the cluster using valid credentials. Securely save user credentials in the user's home directory upon successful login. | [POST ​/login](https://api.docs.weka.io/?urls.primaryName=4.3#/Login/login) | `weka user login` | | **Retrieve access token:** Obtain a new access token using an existing refresh token. The system creates an authentication token file and saves it in `~/.weka/auth-token.json`. The token file contains both the access token and the refresh token. | [POST ​/login​/refresh](https://api.docs.weka.io/?urls.primaryName=4.3#/Login/refreshToken) | `weka user login` | ## Mounts Defaults Related information: * [mounting-filesystems](https://docs.weka.io/4.3/weka-filesystems-and-object-stores/mounting-filesystems "mention") * [#set-mount-option-default-values](https://docs.weka.io/4.3/weka-filesystems-and-object-stores/mounting-filesystems#set-mount-option-default-values "mention") | Task | REST API | CLI | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | ----------------------------------- | | **View cluster-wide mount options:** See the configured mount options applied to all filesystems across the cluster. | [GET ​/mountDefaults](https://api.docs.weka.io/?urls.primaryName=4.3#/Mounts%20Defaults/getMountDefaults) | `weka cluster mount-defaults show` | | **Set cluster-wide mount options:** Configure default options for mounting filesystems across the cluster. | [PUT ​/mountDefaults](https://api.docs.weka.io/?urls.primaryName=4.3#/Mounts%20Defaults/setMountDefaults) | `weka cluster mount-defaults set` | | **Reset cluster-wide mount options:** Revert default mount options to initial settings for all filesystems in the cluster. | [DELETE ​/mountDefaults](https://api.docs.weka.io/?urls.primaryName=4.3#/Mounts%20Defaults/resetMountDefaults) | `weka cluster mount-defaults reset` | ## NFS Related information: [nfs-support](https://docs.weka.io/4.3/additional-protocols/nfs-support "mention")
TaskREST APICLI
View NFS permissions: See a list of the existing access controls for client groups accessing filesystems through NFS.GET ​/nfs​/permissionsweka nfs permission
Grant NFS permissions: Assign permissions for a specific client group to access a designated NFS-mounted filesystem.POST ​/nfs​/permissionsweka nfs permission add <fs_name> <client-group-name>
View NFS permissions of a specific filesystem: See existing access controls for client groups accessing a specific filesystem through NFS.GET ​/nfs​/permissions​/{uid}weka nfs permission --filesystem <fs_name>
Modify NFS permissions: Update existing access controls for client groups using an NFS-mounted filesystem.PUT ​/nfs​/permissions​/{uid}weka nfs permission update <fs_name> <client-group-name>
Revoke access: Remove permissions for client groups to access a designated NFS-mounted filesystem.DELETE ​/nfs​/permissions​/{uid}weka nfs permission delete <fs_name> <client-group-name>
View NFS client groups: See a list of all defined client groups for managing NFS access control.GET ​/nfs​/clientGroupsweka nfs client-group
Create/add NFS client group: Establish a new group to manage access controls for NFS mounts.POST ​/nfs​/clientGroupsweka nfs client-group add <group-name>
View a specific NFS client group: See a specific NFS client group for managing NFS access control.GET ​/nfs​/clientGroups​/{uid}weka nfs client-group --name <client-group-name>
Delete an NFS client group: Remove an existing NFS client group.DELETE ​/nfs​/clientGroups​/{uid}weka nfs client-group delete <client-group-name>
Add a DNS rule: Assign a DNS rule to an NFS client group for access control.POST ​/nfs​/clientGroups​/{uid}​/rulesweka nfs rules add dns <client-group-name> <dns-rule>
Remove a DNS rule: Delete a DNS rule associated with an NFS client group.DELETE ​/nfs​/clientGroups​/{uid}​/rules​/{rule_uid}weka nfs rules delete dns <client-group-name> <dns-rule>
Configure cluster-wide NFS settings: Manage global parameters for NFS operations, including the mountd service port, configuration filesystem for NFSv4, and supported NFS versions.PUT ​/nfs​/globalConfigweka nfs global-config set
View cluster-wide NFS configuration: Get the global parameters for NFS operations, including the mountd service port, configuration filesystem for NFSv4, and supported NFS versions.GET ​/nfs​/globalConfigweka nfs global-config show
View logging verbosity: Check the existing logging level for container processes involved in the NFS cluster.GET ​/nfs​/debugweka nfs debug-level show
Set logging verbosity: Adjust the logging level for container processes involved in the NFS cluster.POST ​/nfs​/debugweka nfs debug-level set <debug-level>
Integrate NFS and Kerberos service: This involves setting up secure network communication by defining KDC details, admin credentials, and other parameters for robust authentication.PUT​/nfs​/kerberosService**weka nfs kerberos service setup
View NFS-Kerberos service configurationGET​/nfs​/kerberosService**weka nfs kerberos service show
Register NFS with MIT KerberosPUT​/nfs​/kerberosMitRegistration**weka nfs kerberos registration setup-mit
Register NFS with AD KerberosPUT​/nfs​/kerberosActiveDirectoryRegistration**weka nfs kerberos registration setup-ad
Get NFS Kerberos registration configurationGET​/nfs​/kerberosRegistration**weka nfs kerberos registration show
Reset Kerberos configuration for NFSPUT​/nfs​/kerberosReset**weka nfs kerberos reset
Set OpenLDAP configuration for NFS:PUT​/nfs​/openLdapService**weka nfs ldap setup-openldap
Set AD configuration for NFS:PUT​/nfs​/activeDirectoryLdapService**weka nfs ldap setup-ad
Get LDAP configuration for NFS:GET​/nfs​/ldapService**weka nfs ldap show
Reset LDAP configuration for NFS:PUT​/nfs​/ldapReset**weka nfs ldap reset
## Object store Related information: [managing-object-stores](https://docs.weka.io/4.3/weka-filesystems-and-object-stores/managing-object-stores "mention") | Task | REST API | CLI | | ------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------ | | **Update object store connection:** Update details for an existing object store connection. | [PUT ​/objectStores​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Object%20store/updateObs) | `weka fs tier obs update ` | ## Object store bucket Related information: [managing-object-stores](https://docs.weka.io/4.3/weka-filesystems-and-object-stores/managing-object-stores "mention") | Task | REST API | CLI | | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | | **View S3 configurations:** See a list of connection and status details for all S3 object store buckets. | [GET ​/objectStoreBuckets](https://api.docs.weka.io/?urls.primaryName=4.3#/Object%20store%20bucket/getAllObsBuckets) | `weka fs tier s3` | | **Create an S3 connection:** Establish a new S3 object store bucket connection. | [POST ​/objectStoreBuckets](https://api.docs.weka.io/?urls.primaryName=4.3#/Object%20store%20bucket/createObsBucket) | `weka fs tier s3 add ` | | **View an S3 connection:** See a list of connection and status details for a specific S3 object store bucket. | [GET ​/objectStoreBuckets​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Object%20store%20bucket/getObsBuckets) | `weka fs tier s3 --obs-name --name ` | | **Delete an S3 connection:** Remove an existing S3 object store connection. | [DELETE ​/objectStoreBuckets​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Object%20store%20bucket/deleteObsBucket) | `weka fs tier s3 delete ` | | **Update an S3 connection:** Modify an existing S3 object store bucket connection. | [PUT ​/objectStoreBuckets​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Object%20store%20bucket/updateObsBucket) | `weka fs tier s3 update ` | | **View snapshots:** List and view details about uploaded snapshots within an object store. | [GET ​/objectStoreBuckets​/{uid}​/operations](https://api.docs.weka.io/?urls.primaryName=4.3#/Object%20store%20bucket/getObsOperations) | `weka fs tier s3 snapshot list ` | ## Organization Related information: [organizations](https://docs.weka.io/4.3/operation-guide/organizations "mention") | Task | REST API | CLI | | ------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | | **Check for multiple organizations:** Verify if multiple organizations exist within the cluster. | [GET ​/organizations​/multipleOrgsExist](https://api.docs.weka.io/?urls.primaryName=4.3#/Organization/getMultipleOrgExist) | `weka org` | | **View organizations:** See a list of all organizations defined in the cluster. | [GET ​/organizations](https://api.docs.weka.io/?urls.primaryName=4.3#/Organization/getOrganizations) | `weka org` | | **Add organization:** Create a new organization within the cluster. | [POST ​/organizations](https://api.docs.weka.io/?urls.primaryName=4.3#/Organization/createOrganization) | `weka org create` | | **View organization details:** See information about an existing organization. | [GET ​/organizations​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Organization/getOrganization) | `weka org ` | | **Delete organization:** Remove an organization from the cluster. | [DELETE ​/organizations​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Organization/deleteOrganization) | `weka org delete ` | | **Update organization name:** Change the name of an existing organization. | [PUT ​/organizations​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Organization/updateOrganization) | `weka org rename ` | | **Set organization quotas:** Define SSD and total storage quotas for an organization. | [PUT ​/organizations​/{uid}​/limits](https://api.docs.weka.io/?urls.primaryName=4.3#/Organization/setOrganizationLimit) | `weka org set-quota ` | ## Processes Related information: [weka-containers-architecture-overview](https://docs.weka.io/4.3/weka-system-overview/weka-containers-architecture-overview "mention") | Task | REST API | CLI | | ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------- | -------------------------------------- | | **View all processes' details:** See information about all running processes within the cluster. | [GET ​/processes](https://api.docs.weka.io/?urls.primaryName=4.3#/Processes/getProcesses) | `weka cluster processes` | | **View process details:** See information about a specific process based on its ID. | [GET ​/processes​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Processes/getProcess) | `weka cluster processes ` | ## S3 Related information: [s3](https://docs.weka.io/4.3/additional-protocols/s3 "mention") | Task | REST API | CLI | | -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------- | | **View S3 cluster information:** See details about the S3 cluster managed by WEKA. | [GET ​/s3](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/getS3Cluster) | `weka s3 cluster` | | **Create an S3 cluster:** Establish a new S3 cluster. | [POST ​/s3](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/createS3Cluster) | `weka s3 cluster create` | | **Update an S3 cluster:** Modify the configuration of an existing S3 cluster. | [PUT ​/s3](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/updateS3Cluster) | `weka s3 cluster update` | | **Delete an S3 cluster:** Remove an S3 cluster. | [DELETE ​/s3](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/deleteS3Cluster) | `weka s3 cluster destroy` | | **View buckets:** See a list of all buckets within an S3 cluster. | [GET ​/s3​/buckets](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/getS3Buckets) | `weka s3 bucket list` | | **Create an S3 bucke**t: Establish a new bucket within an S3 cluster. | [POST ​/s3​/buckets](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/createS3Bucket) | `weka s3 bucket create` | | **View S3 user policies:** See a list of S3 user policies. | [GET ​/s3​/userPolicies](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/getuserPolicies) | `weka s3 bucket policy` | | **Delete an S3 bucket:** Delete a specified S3 bucket. | [DELETE ​/s3​/buckets​/{bucket}](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/destroyS3Bucket) | `weka s3 bucket delete ` | | **View S3 IAM policies:** See a list of S3 IAM policies. | [GET ​/s3​/policies](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/getS3Policies) | `weka s3 policy list` | | **Add an S3 IAM policy:** Create a new S3 IAM policy. | [POST ​/s3​/policies](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/createS3Policy) | `weka s3 policy add` | | **View S3 IAM policy details:** See details about a specific S3 IAM policy. | [GET ​/s3​/policies​/{policy}](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/getS3Policy) | `weka s3 policy show ` | | **Remove an S3 IAM policy:** Delete an S3 IAM policy. | [DELETE ​/s3​/policies​/{policy}](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/deleteS3Policy) | `weka s3 policy remove ` | | **Attach an S3 IAM policy to a user:** Assign an S3 IAM policy to a user. | [POST ​/s3​/policies​/attach](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/attachS3Policy) | `weka s3 policy attach ‌` | | **Detach an S3 IAM policy from a user:** Remove an S3 IAM policy from a user. | [POST ​/s3​/policies​/detach](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/detachS3Policy) | `weka s3 policy detach ‌‌` | | **View service accounts:** See a list of S3 service accounts. | [GET ​/s3​/serviceAccounts](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/getS3ServiceAccounts) | `weka s3 service-account list` | | **Create an S3 service account:** Establish a new S3 service account. | [POST ​/s3​/serviceAccounts](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/createS3ServiceAccount) | `weka s3 service-account add ` | | **View service account details:** See details about a specific S3 service account. | [GET ​/s3​/serviceAccounts​/{access\_key}](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/getServiceAccount) | `weka s3 service-account show ` | | **Delete an S3 service account:** Remove an S3 service account. | [DELETE ​/s3​/serviceAccounts​/{access\_key}](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/deleteS3ServiceAccount) | `weka s3 service-account remove ` | | **Create an S3 STS token:** Create an S3 STS token with an assumed role. | [POST ​/s3​/sts](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/s3StsCreate) | `weka s3 sts assume-role` | | **Add lifecycle rule:** Create a new lifecycle rule for an S3 bucket. | [POST ​/s3​/buckets​/{bucket}​/lifecycle​/rules](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/s3CreateLifecycleRule) | `weka s3 bucket lifecycle-rule add ` | | **Reset lifecycle rules:** Reset all lifecycle rules for an S3 bucket to their default settings. | [DELETE ​/s3​/buckets​/{bucket}​/lifecycle​/rules](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/s3DeleteAllLifecycleRules) | `weka s3 bucket lifecycle-rule reset ` | | **View lifecycle rules:** See a list of all lifecycle rules for an S3 bucket. | [GET ​/s3​/buckets​/{bucket}​/lifecycle​/rules](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/s3ListAllLifecycleRules) | `weka s3 bucket lifecycle-rule list ` | | **Delete lifecycle rule:** Remove a lifecycle rule from an S3 bucket. | [DELETE ​/s3​/buckets​/{bucket}​/lifecycle​/rules​/{rule}](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/s3DeleteLifecycleRule) | `weka s3 bucket lifecycle-rule remove ` | | **View S3 bucket policy:** See the policy attached to an S3 bucket. | [GET ​/s3​/buckets​/{bucket}​/policy](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/getS3BucketPolicy) | `weka s3 bucket policy get ` | | **Set S3 bucket policy:** Assign a policy to an S3 bucket. | [PUT ​/s3​/buckets​/{bucket}​/policy](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/setS3BucketPolicy) | `weka s3 bucket policy set ` | | **View S3 bucket policy (JSON):** See the bucket policy in JSON format. | [GET ​/s3​/buckets​/{bucket}​/policyJson](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/getS3BucketPolicyJson) | `weka s3 bucket policy get-json ` | | **Set S3 bucket policy (JSON):** Set the bucket policy using a JSON file. | [PUT ​/s3​/buckets​/{bucket}​/policyJson](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/setS3BucketPolicyJson) | `weka s3 bucket policy set-custom ` | | **Set S3 bucket quota:** Define a storage quota for an S3 bucket. | [PUT ​/s3​/buckets​/{bucket}​/quota](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/setS3BucketQuota) | `weka s3 bucket quota set ` | | **Unset S3 bucket quota:** Remove a storage quota from an S3 bucket. | [DELETE ​/s3​/buckets​/{bucket}​/quota](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/unsetS3BucketQuota) | `weka s3 bucket quota unset ` | | **View container readiness:** Check the readiness status of containers within the S3 cluster. | [GET ​/s3​/containersAreReady](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/gets3ContainersAreReady) | `weka s3 cluster status` | | **Add container to S3 cluster:** Add a container to the S3 cluster. | [POST ​/s3​/containers](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/addS3Containers) | `weka s3 cluster containers add ` | | **Remove containers:** Remove containers from the S3 cluster. | [DELETE ​/s3​/containers](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/deleteS3Containers) | `weka s3 cluster containers remove ` | | **View logging verbosity:** See the logging level for container processes within the S3 cluster. | [GET ​/s3​/debug](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/gets3DebugLevel) | `weka s3 log-level get` | | **Set logging verbosity:** Adjust the logging level for container processes within the S3 cluster. | [POST ​/s3​/debug](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/sets3DebugLevel) | `weka s3 log-level set ` | | **Enable S3 audit webhook:** Activate the S3 audit webhook. | [POST ​/s3​/auditWebhook​/enable](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/enableS3AuditWebhook) | `weka s3 cluster audit-webhook enable` | | **Disable S3 audit webhook:** Deactivate the S3 audit webhook. | [POST ​/s3​/auditWebhook​/disable](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/disableS3AuditWebhook) | `weka s3 cluster audit-webhook disable` | | **View S3 audit webhook configuration:** See details about the S3 audit webhook configuration. | [GET ​/s3​/auditWebhook](https://api.docs.weka.io/?urls.primaryName=4.3#/S3/getS3AuditWebhook) | `weka s3 cluster audit-webhook show` | ## SMB Related information: [smb-support](https://docs.weka.io/4.3/additional-protocols/smb-support "mention") | Task | REST API | CLI | | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | | **View SMB cluster configuration:** See details about the existing SMB cluster configuration. | [GET ​/smb](https://api.docs.weka.io/?urls.primaryName=4.3#/SMB/getSamba) | `weka smb cluster` | | **Create SMB cluster:** Establish a new SMB cluster managed by WEKA. | [POST ​/smb](https://api.docs.weka.io/?urls.primaryName=4.3#/SMB/setSamba) | `weka smb cluster create ` | | **Update SMB cluster configuration:** Modify the existing configuration of an SMB cluster. | [PUT ​/smb](https://api.docs.weka.io/?urls.primaryName=4.3#/SMB/updateSamba) | `weka smb cluster update` | | **Remove SMB cluster configuration:** Disable SMB access to data without affecting the data itself. | [DELETE ​/smb](https://api.docs.weka.io/?urls.primaryName=4.3#/SMB/clearSamba) | `weka smb cluster destroy` | | **View trusted domains (SMB):** See a list of trusted domains recognized by the SMB cluster (not yet supported on SMB-W). | [GET ​/smb​/domains](https://api.docs.weka.io/?urls.primaryName=4.3#/SMB/setSambaDomains) | `weka smb cluster trusted-domains` | | **Add trusted domain (SMB):** Add a new trusted domain to the SMB cluster (not yet supported on SMB-W). | [POST ​/smb​/domains](https://api.docs.weka.io/?urls.primaryName=4.3#/SMB/addSambaDomain) | `weka smb cluster trusted-domains add` | | **View SMB mount options:** See a list of mount options used by the existing SMB cluster. | [GET ​/smb​/mount](https://api.docs.weka.io/?urls.primaryName=4.3#/SMB/setSambaMountOptions) | N/A | | **View SMB shares:** See a list of all shares available within the SMB cluster. | [GET ​/smb​/shares](https://api.docs.weka.io/?urls.primaryName=4.3#/SMB/setSambaShares) | `weka smb share` | | **Add SMB share:** Create a new share within the SMB cluster. | [POST ​/smb​/shares](https://api.docs.weka.io/?urls.primaryName=4.3#/SMB/addShareToSamba) | `weka smb share add ` | | **Join Active Directory:** Integrate the SMB cluster with an Active Directory domain. | [POST ​/smb​/activeDirectory](https://api.docs.weka.io/?urls.primaryName=4.3#/SMB/setSambaActiveDirectory) | `weka smb domain join ` | | **Leave Active Directory:** Disconnect the SMB cluster from the Active Directory domain. | [PUT ​/smb​/activeDirectory](https://api.docs.weka.io/?urls.primaryName=4.3#/SMB/deleteSambaActiveDirectory) | `weka smb domain leave ` | | **Set SMB container logging verbosity:** Adjust the logging level for container processes in the SMB cluster. | [POST ​/smb​/debug](https://api.docs.weka.io/?urls.primaryName=4.3#/SMB/setSambaDebug) | `weka smb cluster debug ` | | **Update SMB share:** Modify the configuration of an existing SMB share. | [PUT ​/smb​/shares​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/SMB/updateSambaShare) | `weka smb share update ` | | **Delete SMB share:** Remove an SMB share from the cluster. | [DELETE ​/smb​/shares​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/SMB/deleteSambaShare) | `weka smb share remove ` | | **Remove trusted domain (SMB):** Remove a trusted domain from the SMB cluster. | [DELETE ​/smb​/domains​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/SMB/deleteSambaDomain) | `weka smb cluster trusted-domains remove` | | **Add SMB share users:** Add users associated with a specific SMB share. | [POST ​/smb​/users​/{share\_uid}​/{user\_type}](https://api.docs.weka.io/?urls.primaryName=4.3#/SMB/addUserToSamba) | `weka smb share lists add --users ` | | **Remove SMB share users:** Remove users associated with a specific SMB share. | [DELETE ​/smb​/users​/reset​/{share\_uid}​/{user\_type}](https://api.docs.weka.io/?urls.primaryName=4.3#/SMB/resetSambaUsers) | `weka smb share lists reset ` | | **Remove specific SMB share users:** Remove specific users associated with a specific SMB share. | [DELETE ​/smb​/users​/{share\_uid}​/{user\_type}​/{user}](https://api.docs.weka.io/?urls.primaryName=4.3#/SMB/deleteSambaUser) | `weka smb share lists remove --users ` | | **View SMB container status:** Check the status of containers participating in the SMB cluster. | [GET ​/smb​/containersAreReady](https://api.docs.weka.io/?urls.primaryName=4.3#/SMB/getSambaContainersAreReady) | `weka smb cluster status` | | **Add SMB cluster containers:** Add containers to the SMB cluster. | [PUT ​/smb​/servers](https://api.docs.weka.io/?urls.primaryName=4.3#/SMB/addSambaServers) | `weka smb cluster containers add --containers-id ` | | **Remove SMB cluster containers:** Remove containers from the SMB cluster. | [DELETE ​/smb​/servers](https://api.docs.weka.io/?urls.primaryName=4.3#/SMB/deleteSambaServers) | `weka smb cluster containers remove --containers-id ` | ## Security Related information: [security](https://docs.weka.io/4.3/operation-guide/security "mention") | Task | REST API | CLI | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | | **View token expiry:** See the default expiry time for tokens. | [GET ​/security​/defaultTokensExpiry](https://api.docs.weka.io/?urls.primaryName=4.3#/Security/getTokensExpiry) | N/A | | **View login banner:** See the existing login banner displayed on the sign-in page. | [GET ​/security​/banner](https://api.docs.weka.io/?urls.primaryName=4.3#/Security/getLoginBanner) | `weka security login-banner show` | | **Set login banner:** Create or modify the login banner containing a security statement or legal message. | [PUT ​/security​/banner](https://api.docs.weka.io/?urls.primaryName=4.3#/Security/setLoginBanner) | `weka security login-banner set ` | | **Show login banner:** Show the login banner on the sign-in page. | [POST ​/security​/banner​/enable](https://api.docs.weka.io/?urls.primaryName=4.3#/Security/enableLoginBanner) | `weka security login-banner enable` | | **Hide login banner:** Hide the login banner from the sign-in page. | [POST ​/security​/banner​/disable](https://api.docs.weka.io/?urls.primaryName=4.3#/Security/disableLoginBanner) | `weka security login-banner disable` | | **Add or update custom CA certificate:** Upload a custom CA certificate to be used for authentication. If a certificate is already present, this command replaces it. | [PUT ​/security​/caCert](https://api.docs.weka.io/?urls.primaryName=4.3#/Security/setCaCert) | `weka security ca-cert set` | | **Delete custom CA certificate:** Remove the currently configured custom CA certificate from the cluster. | [DELETE ​/security​/caCert](https://api.docs.weka.io/?urls.primaryName=4.3#/Security/unsetCaCert) | `weka security ca-cert unset` | | **View cluster CA certificate:** See the status and details of the cluster's CA certificate. | [GET ​/security​/caCert](https://api.docs.weka.io/?urls.primaryName=4.3#/Security/showCaCert) | `weka security ca-cert status` | ## Servers Related information: [expanding-and-shrinking-cluster-resources](https://docs.weka.io/4.3/operation-guide/expanding-and-shrinking-cluster-resources "mention") | Task | REST API | CLI | | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | --------------------------- | | **View cluster servers:** See a list of all servers within the cluster. | [GET ​/servers](https://api.docs.weka.io/?urls.primaryName=4.3#/Servers/getServers) | `weka cluster servers list` | | **View server details:** See specific information about an individual server based on its UID. | [GET ​/servers​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Servers/getSingleServer) | `weka cluster servers show` | ## Snapshots Related information: * [snapshots](https://docs.weka.io/4.3/weka-filesystems-and-object-stores/snapshots "mention") * [snap-to-obj](https://docs.weka.io/4.3/weka-filesystems-and-object-stores/snap-to-obj "mention") | Task | REST API | CLI | | ----------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | | **View snapshots:** See a list of all snapshots currently available. | [GET ​/snapshots](https://api.docs.weka.io/?urls.primaryName=4.3#/Snapshots/getSnapshots) | `weka fs snapshot` | | **Create snapshot:** Establish a new snapshot of a filesystem. | [POST ​/snapshots](https://api.docs.weka.io/?urls.primaryName=4.3#/Snapshots/createSnapshot) | `weka fs snapshot create ` | | **View snapshot details:** See specific information about an existing snapshot. | [GET ​/snapshots​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Snapshots/getSnapshot) | `weka fs snapshot --name ` | | **Update snapshot:** Modify the configuration of an existing snapshot. | [PUT ​/snapshots​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Snapshots/updateSnapshot) | `weka fs snapshot update ` | | **Delete snapshot:** Remove a snapshot from the system. | [DELETE ​/snapshots​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/Snapshots/deleteSnapshot) | `weka fs snapshot delete ` | | **Copy snapshot:** Copy a snapshot from the same filesystem to a different location. | [POST ​/snapshots​/{uid}​/copy](https://api.docs.weka.io/?urls.primaryName=4.3#/Snapshots/copySnapshot) | `weka fs snapshot copy ` | | **Upload snapshot to object store:** Transfer a snapshot to an object storage. | [POST ​/snapshots​/{uid}​/upload](https://api.docs.weka.io/?urls.primaryName=4.3#/Snapshots/uploadSnapshot) | `weka fs snapshot upload ` | | **Download snapshot:** Download a snapshot from an object storage system. | [POST ​/snapshots​/download](https://api.docs.weka.io/?urls.primaryName=4.3#/Snapshots/downloadSnapshot) | `weka fs snapshot download` | | **Restore filesystem from snapshot**: Restore a filesystem using a previously created snapshot. | [POST ​/snapshots​/{fs\_uid}​/{uid}​/restore](https://api.docs.weka.io/?urls.primaryName=4.3#/Snapshots/restoreFileSystemFromSnapshot) | `weka fs snapshot download ` | ## Stats Related information: [statistics](https://docs.weka.io/4.3/operation-guide/statistics "mention") | Task | REST API | CLI | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------- | | **View stats:** See a list of various statistics related to the cluster's performance and resource usage. | [GET ​/stats](https://api.docs.weka.io/?urls.primaryName=4.3#/Stats/getStats) | `weka stats` | | **View stats description:** Get detailed explanations of the available statistics. | [GET ​/stats​/description](https://api.docs.weka.io/?urls.primaryName=4.3#/Stats/getStatsDescription) | `weka stats list-types` | | **View real-time stats:** Monitor live statistics for the cluster. | [GET ​/stats​/realtime](https://api.docs.weka.io/?urls.primaryName=4.3#/Stats/getRealTimeStats) | `weka stats realtime` | | **View stats retention and disk usage:** See how long statistics are retained and estimate disk space used for storage. | [GET ​/stats​/retention](https://api.docs.weka.io/?urls.primaryName=4.3#/Stats/getStatsDiskUsage) | `weka stats retention status` | | **Set stats retention:** Define the duration for which statistics are stored. | [POST ​/stats​/retention](https://api.docs.weka.io/?urls.primaryName=4.3#/Stats/getStatsRetention) | `weka stats retention set --days ` | ## System IO Related information: [perform-post-configuration-procedures](https://docs.weka.io/4.3/planning-and-installation/bare-metal/perform-post-configuration-procedures "mention") | Task | REST API | CLI | | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | ----------------------- | | **Start cluster IO services:** Enable the cluster-wide IO services. | [POST ​/io​/start](https://api.docs.weka.io/?urls.primaryName=4.3#/System%20IO/startIO) | `weka cluster start-io` | | **Stop cluster IO services:** Disable the cluster-wide IO services. | [POST ​/io​/stop](https://api.docs.weka.io/?urls.primaryName=4.3#/System%20IO/stopIO) | `weka cluster stop-io` | ## Tasks Related information: [background-tasks](https://docs.weka.io/4.3/operation-guide/background-tasks "mention") | Task | REST API | CLI | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------ | | **View background tasks:** See a list of all currently running background tasks within the cluster. | [GET ​/tasks](https://api.docs.weka.io/?urls.primaryName=4.3#/Tasks/getTasks) | `weka cluster task‌` | | **Resume a background task:** Re-initiate a paused background task, allowing execution to continue. | [POST ​/tasks​/{uid}​/resume](https://api.docs.weka.io/?urls.primaryName=4.3#/Tasks/resumeTask) | `weka cluster task resume ` | | **Pause a background task:** Temporarily halt the execution of a running background task. The task can be resumed later. | [POST ​/tasks​/{uid}​/pause](https://api.docs.weka.io/?urls.primaryName=4.3#/Tasks/pauseTasks) | `weka cluster task pause ` | | **Abort a background task:** Terminate a running background task, permanently stopping its execution. Any unfinished work associated with the task will be discarded. | [POST ​/tasks​/{uid}​/abort](https://api.docs.weka.io/?urls.primaryName=4.3#/Tasks/abortTasks) | `weka cluster task abort ` | | **View background task limits:** See the existing limitations on the number of background tasks running concurrently within the system. This information helps you understand the capacity for handling background processes. | [GET ​/tasks​/limits](https://api.docs.weka.io/?urls.primaryName=4.3#/Tasks/getTasksLimit) | `weka cluster task limits` | | **Set background task limits:** Adjust the maximum number of background tasks allowed to run simultaneously. This allows you to control the system's resource allocation and potential performance impact from concurrent tasks. | [PUT ​/tasks​/limits](https://api.docs.weka.io/?urls.primaryName=4.3#/Tasks/setTasksLimit) | `weka cluster task limits set` | ## TLS Related information: [tls-certificate-management](https://docs.weka.io/4.3/operation-guide/security/tls-certificate-management "mention") | Task | REST API | CLI | | ------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------- | ---------------------------- | | **View cluster TLS status:** Check the status and details of the cluster's TLS certificate. | [GET ​/tls](https://api.docs.weka.io/?urls.primaryName=4.3#/TLS/getTls) | `weka security tls status` | | **Configure Nginx with TLS:** Enable TLS for the UI and set or update the private key and certificate. | [POST ​/tls](https://api.docs.weka.io/?urls.primaryName=4.3#/TLS/enableTls) | `weka security tls set` | | **Configure Nginx without TLS:** Disable TLS for the UI. | [DELETE ​/tls](https://api.docs.weka.io/?urls.primaryName=4.3#/TLS/disableTls) | `weka security tls unset` | | **Download TLS certificate:** Download the cluster's TLS certificate. | [GET ​/tls​/certificate](https://api.docs.weka.io/?urls.primaryName=4.3#/TLS/getTlsCertificate) | `weka security tls download` | ## Traces Related information: [traces-management](https://docs.weka.io/4.3/support/diagnostics-management/traces-management "mention") | Task | REST API | CLI | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------- | -------------------------------- | | **View traces configuration:** See the current configuration settings for trace collection. | [GET ​/traces](https://api.docs.weka.io/?urls.primaryName=4.3#/Traces/getTracesStatus) | `weka debug traces status` | | **Start trace collection:** Initiate the collection of trace data. | [PUT ​/traces](https://api.docs.weka.io/?urls.primaryName=4.3#/Traces/updateTracesConfigure) | `weka debug traces start` | | **Stop trace collection**: Stop the collection of trace data. | [DELETE ​/traces](https://api.docs.weka.io/?urls.primaryName=4.3#/Traces/restoreTracesDefaults) | `weka debug traces stop` | | **View trace freeze period:** See the duration for which trace data is preserved for investigation. | [GET ​/traces​/freeze](https://api.docs.weka.io/?urls.primaryName=4.3#/Traces/getTracesFreeze) | `weka debug traces freeze show` | | **Set trace freeze period:** Set the duration for which trace data is preserved for investigation. | [PUT ​/traces​/freeze](https://api.docs.weka.io/?urls.primaryName=4.3#/Traces/updateTracesFreeze) | `weka debug traces freeze set` | | **Clear frozen traces:** Remove all existing frozen traces and reset the freeze period to zero. | [DELETE ​/traces​/freeze](https://api.docs.weka.io/?urls.primaryName=4.3#/Traces/resetTracesFreeze) | `weka debug traces freeze reset` | | **Set trace verbosity level:** Modify the level of detail captured in trace logs. Low captures essential information for basic troubleshooting. High captures extensive details for in-depth analysis. | [PUT ​/traces​/level](https://api.docs.weka.io/?urls.primaryName=4.3#/Traces/updateTracesLevel) | `weka debug traces level set` | ## User Related information: [user-management](https://docs.weka.io/4.3/operation-guide/user-management "mention") | Task | REST API | CLI | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -------------------------------------------- | | **View local users:** See a list of all local users on the system. | [GET ​/users](https://api.docs.weka.io/?urls.primaryName=4.3#/User/getUsers) | `weka user` | | **Create a local user:** Add a new local user account. | [POST ​/users](https://api.docs.weka.io/?urls.primaryName=4.3#/User/createUser) | `weka user add ` | | **Update a local user:** Modify the details of an existing local user. | [PUT ​/users​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/User/updateUser) | `weka user update ` | | **Delete a local user:** Remove a local user account from the system. | [DELETE ​/users​/{uid}](https://api.docs.weka.io/?urls.primaryName=4.3#/User/deleteUser) | `weka user delete ` | | **Set a local user password:** Assign a password to a local user. | [PUT ​/users​/password](https://api.docs.weka.io/?urls.primaryName=4.3#/User/updateUserPassword) | `weka user passwd` | | **Update a local user password:** For any user, change your own password or the password of another user if you have the necessary permissions. For admins, change the password of any user within the organization. | [PUT ​/users​/{uid}​/password](https://api.docs.weka.io/?urls.primaryName=4.3#/User/setUserPassword) | `weka user passwd ` | | **View the logged-in user:** Get information about the currently logged-in user. | [GET ​/users​/whoami](https://api.docs.weka.io/?urls.primaryName=4.3#/User/whoAmI) | `weka user whoami` | | **Invalidate user sessions:** Immediately terminate all active login sessions (GUI, CLI, API) associated with a specific internal user. This action prevents further access to the system using those tokens. | [DELETE ​/users​/{uid}​/revoke](https://api.docs.weka.io/?urls.primaryName=4.3#/User/revokeUser) | `weka user revoke-tokens` | **Related information** [REST API Reference Guide](https://api.docs.weka.io/)