/host
Internal Endpoints
REST Endpoint |
Description |
GraphQL Query | CDM Availability |
|---|---|---|---|
| POST /host/bulk | Register hosts with Rubrik clusters. | Available, but deprecated for NAS. For NAS, use POST /nas/system instead. |
|
| PATCH /host/bulk | Change the FQDN and IPv4 address assigned to a host object. Enable or disable pre-transfer data compression. Enable or disable change block tracking (CBT) for backups of SQL Server databases on Windows hosts. Enable or disable volume filter driver (VFD) for volume backups on Windows hosts. | Available, but deprecated for NAS. For NAS, use PATCH /nas/system/{id} instead. |
|
| POST /host/bulk-delete | Deregister specified network hosts from Rubrik clusters. | Restricted | |
| POST /host/bulk/volume_filter_driver | Install or uninstall volume filter driver on given hosts. Upgrades volume filter driver if a older version is present on the host. | Restricted | |
| GET /host/count | Retrieve the total number of hosts, and the total number of protected hosts. A protected host has at least one protected fileset. | Available, but deprecated for NAS | |
| GET /host/envoy | Retrieve summary information for all hosts that are registered with a Rubrik cluster. Also returns organization information for each host. This information is available if Envoy is enabled on those hosts. | Available | |
| POST /host/org_network_migration | Migrates multiple hosts to a specific organization network. | Available | |
| GET /host/request/{id} | Get details about a host related async request. | Available | |
| DELETE /host/{id}/async | Delete host asynchronously by specifying the host ID. | Restricted | |
| GET /host/{id}/diagnose | Retrieve the availability status for each host registered with a specified Rubrik CDM instance. | Available | |
| GET /host/{id}/flag | REQUIRES SUPPORT TOKEN - Retrieve physical host agent flag value. Physical host agent flags are defined during compile-time. A support token is required for this operation. | Available | |
| PATCH /host/{id}/flag | REQUIRES SUPPORT TOKEN - Modify physical host agent flags to new values. Physical host agent flags are defined during compile-time. They can be passed in during agent startup or can be modified dynamically using this endpoint. A support token is required for this operation. | Available | |
| POST /host/{id}/log | REQUIRES SUPPORT TOKEN - Fetch host logs from agent into cluster /sd/scratch directory. A support token is required for this operation. | Available |
v1 Endpoints
REST Endpoint |
Description |
GraphQL Query | CDM Availability |
|---|---|---|---|
| GET /host | Retrieve summary information for all hosts that are registered with a Rubrik cluster. | query physicalHosts | Available, but deprecated for NAS. For NAS, use GET /nas/system instead. |
| POST /host | Register a host. | mutation bulkRegisterHost | Available, but deprecated for NAS. For NAS, use POST /nas/system instead. |
| POST /host/background | Register a host and perform discovery for databases and Microsoft SQL Server instances. When called, this API returns a success message, but completes the host registration in the background. Monitor the status of the background host discovery with the status field in GET API on /hosts. The POST API on /hosts can take longer for discovery, depending on the number of hosts on the system. POST on this API can be used instead to perform the discovery in the background and quickly register the host. To do this you must first install RBS on your Linux and Windows hosts. This requirement is the same as is required for the regular method of registering using POST on /host. |
mutation bulkRegisterHost | Available |
| POST /host/bulk_background | Register multiple hosts and perform discovery for databases and Microsoft SQL Server instances. When called, this API returns a success message, but completes the host registration in the background. Monitor the status of the background host discovery with the status field in GET API on /hosts. The POST API on /hosts can take longer for discovery, depending on the number of hosts on the system. POST on this API can be used instead to perform the discovery in the background and quickly register the host. To do this you must first install RBS on your Linux and Windows hosts. This requirement is the same as is required for the regular method of registering using POST on /host. |
Available, but deprecated for NAS. For NAS, use POST /nas/system instead. |
|
| PUT /host/certificate/{id} | Provide an updated certificate for a specified host. | mutation updateCertificateHost | Available |
| GET /host/hierarchy/{id} | Retrieve details for the specified object in the host/share hierarchy. | Available | |
| GET /host/hierarchy/{id}/children | Retrieve the list of immediate descendant objects for the specified parent. | Available | |
| POST /host/make_primary | Migrate the primary cluster with which the agent is able to perform regular operations (backup, restore etc). This can be done on a specified set of hosts or for all hosts that currently have a specified primary cluster for disaster recovery. Specify exactly one of ids or oldPrimaryClusterUuid. |
Available | |
| GET /host/rbs | Get the details of the Rubrik Backup Service (RBS) installed on a specific host. Specify the details of the host to check whether RBS is installed on the host or not. If RBS is installed, the response will include the RBS details. | Available | |
| POST /host/rbs/install | Install Rubrik Backup Service on a host. | Available | |
| POST /host/rbs/uninstall | Uninstall Rubrik Backup Service from a host. | Available | |
| POST /host/rbs/upgrade | Upgrade Rubrik Backup Service on a host. | Available | |
| GET /host/rpm_signing_key | Retrieve the key used to validate the RPM signature. | Available | |
| GET /host/{id} | Retrieve summary information for a registered host. | query physicalHost | Available, but deprecated for NAS. For NAS, use GET /nas/system instead. |
| PATCH /host/{id} | Change the FQDN and IPv4 address assigned to a host object. Enable or disable pre-transfer data compression. Enable or disable change block tracking (CBT) for backups of SQL Server databases on Windows hosts. Enable or disable volume filter driver (VFD) for volume backups on Windows hosts. Set an Oracle user with sysdba privileges to permit Oracle discovery queries. | mutation updateHost | Available, but deprecated for NAS. For NAS, use PATCH /nas/system/{id} instead. |
| DELETE /host/{id} | Delete host by specifying the host ID. | mutation deleteHost | Available, but deprecated for NAS. For NAS, use DELETE /nas/system/{id} instead. |
| POST /host/{id}/refresh | Refresh the properties of a host object when changes on the host are not seen in the Rubrik web UI. | mutation refreshHost | Available, but deprecated for NAS. For NAS, use POST /nas/system/discover instead. |
| GET /host/{id}/search | Search for a file within the host. Search via full path prefix or filename prefix. | query searchHost | Available |
| GET /host/{id}/volume | Retrieve summary information for each volume on a specified Volume Group host. | query physicalHosts | Available |
| GET /host/hierarchy/{id} | GET summary of a host/share hierarchy object | query physicalHost | Available |
| GET /host/hierarchy/{id}/children | GET immediate descendant objects | query physicalHost | Available |