/cluster
Internal Endpoints
REST Endpoint |
Description |
GraphQL Query | CDM Availability |
|---|---|---|---|
| GET /cluster/{id}/auto_removed_node | Retrieve the list of nodes that were automatically removed from the Rubrik cluster for which the node removal has not been acknowledged. | Available | |
| DELETE /cluster/{id}/auto_removed_node/{node_id}/acknowledge | Acknowledge automatic removal of a node from the Rubrik cluster. | Restricted | |
| POST /cluster/{id}/bad_disk | Runs find_bad_disk script and indicates whether there is a bad or missing disk. Can also be used to turn off the LEDs that are turned on as a part of this script. | Available | |
| GET /cluster/{id}/bootstrap | Retrieves status of in progress bootstrap requests. | Available | |
| POST /cluster/{id}/bootstrap | Issues a bootstrap request to a specified Rubrik cluster. | Available | |
| GET /cluster/{id}/bootstrap_config | Retrieves configuration information for the nodes of the Rubrik cluster. | Available | |
| GET /cluster/{id}/brik_count | Retrieve the number of briks in this Rubrik cluster. | Available | |
| POST /cluster/{id}/brik_id | Assigns a Brik ID to a collection of Rubrik cluster nodes, grouping the nodes into a virtual chassis. | Available | |
| POST /cluster/{id}/decommission_nodes | Start an asynchronous task to decommission the specified node or nodes. | Restricted | |
| GET /cluster/{id}/discover | Searches for nodes that can bootstrap into the specified Rubrik cluster. This endpoint will be moved to v1 in the next major version. | Available | |
| GET /cluster/{id}/disk | Retrieves information about the disks in the Rubrik cluster. | Available | |
| PATCH /cluster/{id}/disk/{disk_id} | Formats, initializes and mounts an unformatted disk. | Restricted | |
| DELETE /cluster/{id}/disk/{disk_id} | Marks the disk removed and updates cluster metadata. | Restricted | |
| GET /cluster/{id}/disk_capacity | Retrieves total installed disk space on the Rubrik cluster. | Available | |
| PATCH /cluster/{id}/disk_resize/{disk_id} | Resize an existing data disk. | Available | |
| GET /cluster/{id}/dns_nameserver | Retrieve a list the DNS servers assigned to the Rubrik cluster. | Available | |
| POST /cluster/{id}/dns_nameserver | Assign DNS servers to the Rubrik cluster. | Available | |
| GET /cluster/{id}/dns_search_domain | Retrieve a list the DNS search domains assigned to the Rubrik cluster. | Available | |
| POST /cluster/{id}/dns_search_domain | Assign DNS search domains to the Rubrik cluster. | Available | |
| GET /cluster/{id}/flash_capacity | Retrieves total installed flash on the Rubrik cluster. | Available | |
| GET /cluster/{id}/floating_ip | Get a list of a cluster's floating IP to node mapping. | Available | |
| GET /cluster/{id}/global_manager | global. | Available | |
| GET /cluster/{id}/hardware_health | Runs the hw_health command on all nodes in the Rubrik cluster and returns its output. | Available | |
| GET /cluster/{id}/has_tpm | Check whether this Rubrik cluster has TPM. | Available | |
| GET /cluster/{id}/install | Retrieves the status of a Rubrik CDM install request for a cluster. | Available | |
| POST /cluster/{id}/install | Issues an install request to a specified Rubrik cluster. | Available | |
| GET /cluster/{id}/io_stats | Retrieves IO statistics of the Rubrik cluster. | Available | |
| GET /cluster/{id}/ipmi | get IPMI details of availability and enabled access in the cluster. | Available | |
| PATCH /cluster/{id}/ipmi | modify IPMI settings. | Available | |
| GET /cluster/{id}/ipv6 | Returns the IPv6 of all nodes on one or all interfaces. | Available | |
| PATCH /cluster/{id}/ipv6 | Update IPv6 configuration on an interface. | Available | |
| GET /cluster/{id}/is_azure_cloud_only | Checks if the Rubrik cluster has Restricted cloud functionality to Azure cloud only. | Available | |
| GET /cluster/{id}/is_encrypted | Check whether this Rubrik cluster is encrypted (the encryption could be either be software-based encryption or hardware-based encryption). | Available | |
| GET /cluster/{id}/is_hardware_encrypted | Check whether this Rubrik cluster is hardware encrypted. | Available | |
| GET /cluster/{id}/is_host_reachable | Checks if a host, identified by its FQDN or IP address, is reachable from the Rubrik cluster. | Available | |
| GET /cluster/{id}/is_on_cloud | Check whether this Rubrik cluster is running on cloud. | Available | |
| GET /cluster/{id}/is_rsc_enabled | True when Rubrik Security Cloud is enabled on the given CDM cluster. | Available | |
| GET /cluster/{id}/is_single_node | Check whether this Rubrik cluster is configured to be single node. | Available | |
| GET /cluster/{id}/k8s_cluster/bootstrap | Retrieves status of in progress kubernetes cluster bootstrap request. | Available | |
| POST /cluster/{id}/k8s_cluster/bootstrap | Create kubernetes cluster. | Restricted | |
| PUT /cluster/{id}/k8s_cluster/config | Save the kubernetes application config on Rubrik Cluster. | Restricted | |
| GET /cluster/{id}/login_banner | Returns the banner that displays after a successful login. | Available | |
| PUT /cluster/{id}/login_banner | Sets the banner that displays after a successful login. | Available | |
| GET /cluster/{id}/memory_capacity | Retrieve total installed memory on the Rubrik cluster. | Available | |
| GET /cluster/{id}/name | Retrieves the name of the Rubrik cluster identified by the id. | Available | |
| GET /cluster/{id}/network_interface | Retrieves network interfaces(including VLANs) on bond0/bond1. | Available | |
| GET /cluster/{id}/node | Retrieve the list of nodes in this Rubrik cluster. | Available | |
| POST /cluster/{id}/node | Add nodes to the specified Rubrik cluster. | Available | |
| GET /cluster/{id}/ntp_server | Retrieve a list of the NTP servers assigned to the Rubrik cluster. Encryption keys are not reported. | Available | |
| POST /cluster/{id}/ntp_server | Assign NTP servers to Rubrik cluster. | Available | |
| POST /cluster/{id}/online_registration | Validates a user's one time passcode for the Rubrik cluster. | Restricted | |
| POST /cluster/{id}/online_registration_request | Generate a one-time passcode for cluster registration. | Restricted | |
| GET /cluster/{id}/packages | List of Rubrik CDM packages Available for installation. | Available | |
| PUT /cluster/{id}/parse_registration_token | Parse the global manager token for mode of registration. | Restricted | |
| GET /cluster/{id}/pending_node | Retrieves status of a pending add node request on the specified cluster. | Available | |
| GET /cluster/{id}/platforminfo | Retrieve information about the computing platform that is running Rubrik CDM software. | Available | |
| GET /cluster/{id}/prompt_rsc_migration_ui | https:// |
Available | |
| GET /cluster/{id}/recommission_node | Retrieve the status of a specified asynchronous node recommission request. | Available | |
| POST /cluster/{id}/recommission_node | Schedule a node for recommission. | Restricted | |
| GET /cluster/{id}/registered_mode | Mode of registration for the Rubrik cluster. | Restricted | |
| PUT /cluster/{id}/registered_mode | Register the Rubrik cluster. | Restricted | |
| GET /cluster/{id}/remove_node | Retrieves the status of the remove node request. | Available | |
| POST /cluster/{id}/remove_node | Schedules a node for removal. | Restricted | |
| POST /cluster/{id}/remove_nodes | Schedules nodes for removal. | Restricted | |
| GET /cluster/{id}/rubrik_url | Global manager (Polaris / Trident) URL used in hybrid clusters for redirection at login. | Available | |
| GET /cluster/{id}/security/key_rotation | Return detailed information for a key rotation identified by rotation_id, or for all key rotations if rotation_id is not specified. | Available | |
| POST /cluster/{id}/security/key_rotation | Trigger a key rotation for all nodes in the cluster. A reboot may be required depending on the rotation specification. | Available | |
| GET /cluster/{id}/security/password/zxcvbn | Determine whether the ZXCVBN password check is currently in use on the specified Rubrik cluster. | Available | |
| POST /cluster/{id}/security/password/zxcvbn | Toggle usage of ZXCVBN for local users. | Available | |
| GET /cluster/{id}/security/request/{request_id} | Get details about a security-related async request. | Available | |
| GET /cluster/{id}/security/ssh | Returns whether SSH is enabled on TCP port 22 for all nodes in the cluster. | Available | |
| PUT /cluster/{id}/security/ssh | Disables or enables SSH on TCP port 22 for all nodes in the cluster. | Available | |
| GET /cluster/{id}/security_classification | Returns the cluster security classification parameters. | Available | |
| PUT /cluster/{id}/security_classification | Sets the cluster security classification parameters. | Restricted | |
| GET /cluster/{id}/setupnetwork | Retrieves the status of a network setup request for a cluster or node. | Available | |
| POST /cluster/{id}/setupnetwork | Issues a network setup request to a specified Rubrik cluster or node. | Available | |
| GET /cluster/{id}/should_show_rsc_banner | True when CDM UI should show the RSC banner. | Available | |
| POST /cluster/{id}/skip_registration | Set cluster's registeredMode to LifeOfDevice. | Restricted | |
| GET /cluster/{id}/snmp_configuration | Get SNMP configuration of the queried cluster. | Available | |
| PATCH /cluster/{id}/snmp_configuration | Update the SNMP configuration for a specified Rubrik cluster. | Restricted | |
| GET /cluster/{id}/system_status | Retrieves information about the status of the Rubrik cluster. | Available | |
| GET /cluster/{id}/trial_edge | Query Rubrik Edge to confirm whether it is the Trial version and to obtain Trial-related information. | Restricted | |
| PATCH /cluster/{id}/trial_edge | Extend the trial period. | Restricted | |
| PATCH /cluster/{id}/upgrade/schedule | A call to this endpoint schedules an upgrade of the specified Rubrik cluster. | Restricted | |
| DELETE /cluster/{id}/upgrade/schedule | Cancels if there is a scheduled upgrade of the specified Rubrik cluster. | Restricted | |
| GET /cluster/{id}/upgrade/schedule_status | For a scheduled upgrade, a call to this endpoint returns if the upgrade is in progress or not. If not in progress, it returns the summary of the scheduled upgrade for the specified Rubrik cluster. | Available | |
| GET /cluster/{id}/upgrade/status | Retrieves upgrade status message. | Available | |
| GET /cluster/{id}/vlan | Retrieves the VLANs configured on a Rubrik Cluster and their ip configurations. | Available | |
| POST /cluster/{id}/vlan | Edits tagged interfaces on the cluster by VLAN. | Available | |
| PATCH /cluster/{id}/vlan | Update the configuration of an existing VLAN on the Rubrik cluster. VLAN netmask and IP addresses can be changed. | Available | |
| DELETE /cluster/{id}/vlan | Drops interfaces assigend to the specified VLAN on the cluster. | Available | |
| GET /cluster/{id}/vlan_gateway | Retrieves the VLAN gateway information configured on a Rubrik Cluster. | Available | |
| POST /cluster/{id}/vlan_gateway | Set a gateway for a VLAN, store it in metadata. | Available | |
| DELETE /cluster/{id}/vlan_gateway | Delete gateway from a specified VLAN. | Available |
v1 Endpoints
REST Endpoint |
Description |
GraphQL Query | CDM Availability |
|---|---|---|---|
| GET /cluster/me/upgrade/monitor_events | Gets notifications about events from a specified set of possible events. | Available | |
| GET /cluster/{id} | Retrieve public information about the Rubrik cluster. | query allClusterConnection | Available |
| PATCH /cluster/{id} | Change the properties of a specified Rubrik cluster. Changes to cluster name could take upto 10 minutes to be propagated to all nodes. | Available | |
| GET /cluster/{id}/api_version | Retrieves software version of the Rubrik cluster. | query clusterConnection | Available |
| POST /cluster/{id}/azure/managed_identities | Migrates an Azure Cloud Cluster Elastic Storage to use managed identities. | Available | |
| GET /cluster/{id}/cert_update_status | Retrieve the status of the certificate update operation for the Rubrik cluster. | Available | |
| GET /cluster/{id}/certificate | Returns the cluster certificate. | Available | |
| POST /cluster/{id}/certificate | Update the cluster certificate on all nodes. | Available | |
| GET /cluster/{id}/csr | Returns the certificate signing request generated from the private key of the Rubrik cluster. | Available | |
| GET /cluster/{id}/is_entitled | Retrieves entitlement status of the nodes. | Available | |
| POST /cluster/{id}/manual_discover | Manually specifies mDNS discovery data. Output for this endpoint is identical to the output of the 'discover' endpoint. | Available | |
| POST /cluster/{id}/manual_discover_ipv4 | Manually specifies discovery data. This endpoint output is identical to the output of the 'discover' endpoint. | Available | |
| GET /cluster/{id}/node_hostname | Retrieve the ID to hostname mapping for all the nodes that belong to a specified Rubrik cluster. | Available | |
| POST /cluster/{id}/node_hostname | Change hostnames for multiple nodes at a time, for a specified Rubrik cluster. | Available | |
| GET /cluster/{id}/node_id | Retrieve the list of node IDs for the nodes in this Rubrik CDM cluster. | Available | |
| GET /cluster/{id}/offline_entitle | Retrieves node detials required for offline entitlement. | Available | |
| POST /cluster/{id}/offline_entitle | Verifies the token generated by Support portal and entitles the specified nodes. | Available | |
| GET /cluster/{id}/online_entitle | Retrieves the status of an online entitlement request. | Available | |
| POST /cluster/{id}/online_entitle | Sends an online entitlement request to the specified nodes. | Available | |
| GET /cluster/{id}/re_ip | Returns the status of a Re-IP operation. This API must be called on the driving node of the Re-IP. | Available | |
| POST /cluster/{id}/re_ip | Change the node IP addresses in a Rubrik cluster. | Available | |
| GET /cluster/{id}/rubrik_support_portal_credentials | Check whether the specified Rubrik cluster has an existing set of credentials for the Rubrik Support portal. | Available | |
| POST /cluster/{id}/rubrik_support_portal_credentials | Update credentials for the specified Rubrik cluster to connect to the Rubrik Support portal. | Available | |
| GET /cluster/{id}/security/admin_ssh_auth/setting | Retrieves the SSH authentication setting that indicates whether SSH password authentication is enabled for the system admin user. | Available | |
| PATCH /cluster/{id}/security/admin_ssh_auth/setting | Updates the SSH authentication setting for the system admin user. | Available | |
| GET /cluster/{id}/security/api_token_whitelist | If the API Token includes a whitelist, fetch it. | Available | |
| PUT /cluster/{id}/security/api_token_whitelist | Set the API Token whitelist for cluster. | Available | |
| GET /cluster/{id}/security/cors | Get the current CORS support configuration for a web server. | Available | |
| PATCH /cluster/{id}/security/cors | Update the CORS support configuration for a web server. | Available | |
| GET /cluster/{id}/security/encryption | Get the current encryption at rest status of the cluster. | query clusterEncryptionInfo | Available |
| GET /cluster/{id}/security/fips | Returns the current status of FIPS on the specified cluster. When the status is true, FIPS is enabled. | Available | |
| PATCH /cluster/{id}/security/fips | Update the current FIPS enablement status for a cluster. | Available | |
| GET /cluster/{id}/security/kmip/client | Return the currently configured KMIP client information. The response object contains empty fields when KMIP is not configured. | query clusterEncryptionInfo | Available |
| PUT /cluster/{id}/security/kmip/client | Specify KMIP client credentials for each of the Rubrik cluster nodes. | mutation setKmipClient) | Available |
| GET /cluster/{id}/security/kmip/server | Returns the KMIP server information for the specified server address. When no server address is specified, this call returns information on all active KMIP servers. The response array is empty when KMIP is not configured or when the server address cannot be found. | query kmipServerConnection | Available |
| PUT /cluster/{id}/security/kmip/server | Add the specified KMIP server to the set of active KMIP servers. | mutation bulkAddKmipServer | Available |
| DELETE /cluster/{id}/security/kmip/server | Remove the server with the specified server address from the set of active KMIP servers. | mutation deleteKmipServer | Available |
| GET /cluster/{id}/security/mfa/setting | Retrieves the global MFA setting that indicates the number of days after which the Rubrik cluster will enforce multi-factor authentication. | Available | |
| PUT /cluster/{id}/security/mfa/setting | Update the global MFA setting. | Available | |
| GET /cluster/{id}/security/password_requirements | Query user password requirements for a cluster. | Available | |
| PATCH /cluster/{id}/security/password_requirements | Update user password requirements for a cluster. | Available | |
| GET /cluster/{id}/security/totp/setting | Returns TOTP global setting, including whether TOTP is enforced or not. | Available | |
| PUT /cluster/{id}/security/totp/setting | Update TOTP global setting, including whether TOTP is enforced or not. | Available | |
| GET /cluster/{id}/security/truststore | Get summary of all truststores. | query globalCertificateConnection | Available |
| PATCH /cluster/{id}/security/truststore | Setting the given certificate for each node's truststores. | mutation addGlobalCertificate / updateGlobalCertificate | Available |
| DELETE /cluster/{id}/security/truststore | Remove certificate associated with specified truststore. | mutation updateGlobalCertificate | Available |
| GET /cluster/{id}/security/web_signed_cert | If the web server uses a signed certificate, fetch it. | query clusterWebSignedCertificate | Available |
| PUT /cluster/{id}/security/web_signed_cert | Setting the given certificate for each node's web server to use. | mutation setWebSignedCertificate | Available |
| DELETE /cluster/{id}/security/web_signed_cert | Resetting the customer-given certificate for each node's web server. | Available | |
| GET /cluster/{id}/snmp_mib_link | Retrieve the download link for the Rubrik SNMP MIB file. The retrieval is a synchronous operation. | Available | |
| GET /cluster/{id}/support_data | Determines the status of the data the Rubrik cluster uploads to Rubrik Support. | Available | |
| PATCH /cluster/{id}/support_data | Enable or disable the data that will be uploaded from the Rubrik cluster to Rubrik Support. | Restricted | |
| GET /cluster/{id}/syslog_msg_mib_link | Retrieve the download link for the SYSLOG-MSG-MIB file. The retrieval is a synchronous operation. | Available | |
| GET /cluster/{id}/syslog_tc_mib_link | Retrieve the download link for the SYSLOG-TC-MIB file. The retrieval is a synchronous operation. | Available | |
| POST /cluster/{id}/test_snmp_trap_receivers | Send test SNMP traps to all configured receivers. | Restricted | |
| GET /cluster/{id}/upgrade/available_version | Retrieve a list of Rubrik CDM versions Available to upgrade the Rubrik cluster. | Available | |
| GET /cluster/{id}/upgrade/precheck_status | Get the result of the latest run of the upgrade prechecks. | Available | |
| POST /cluster/{id}/upgrade/precheck_status | Start an on demand run of the prechecks. | Available | |
| GET /cluster/{id}/upgrade/request/{request_id} | Get asynchronous request details for an upgrade request. | Available | |
| POST /cluster/{id}/upgrade/stage_cdm_software | Stage software corresponding to a given CDM version on the cluster, in preparation for an upgrade. | Available | |
| GET /cluster/{id}/version | Retrieves software version of the Rubrik cluster. | query activitySeriesConnection | Available |