Rubrik
App · 22 actions
Watch and act on Rubrik Security Cloud backups from workflows: find protected objects and their SLA compliance, list and take snapshots, assign SLA Domains, read events, investigate and resolve ransomware anomalies, and run threat hunts for file hashes. Start a workflow when a backup fails, an anomaly is detected, a threat hunt finishes, a snapshot is taken, an object falls out of compliance or a cluster disconnects.
Actions
| Action | What it does |
|---|---|
| Assign SLA Domain | Protect objects with an SLA Domain, stop protecting them, or have them inherit their parent's SLA Domain again. |
| Get anomaly | Read what Anomaly Detection found in a snapshot: how likely an attack is, suspicious, encrypted and deleted files, and ransomware strains. |
| Get cluster | Read a Rubrik cluster: its status, health, version, storage and when it last connected. |
| Get event | Read an event with each of its messages, as RSC's Events page shows them, such as to post why a backup failed. |
| Get object | Read a protected object: its kind, where it is, its SLA Domain and how many snapshots it has. |
| Get snapshot | Read a snapshot: when it was taken and expires, its SLA Domain and whether it is flagged as an anomaly or quarantined. |
| Get task status | Read how a task such as an on-demand snapshot is going: running, succeeded or failed, and how far along. |
| Get threat hunt | Read a threat hunt: its status, how many objects and snapshots it scanned and how many had matches. |
| Get version | Read Rubrik Security Cloud's version, which also checks the connection works. |
| Get vSphere VM | Read a vSphere virtual machine: its SLA Domain, guest OS, snapshot count and its newest and oldest snapshot. |
| List clusters | List the Rubrik clusters in the account with their status, version, free space and how long it will last. |
| List events | List events (backups, recoveries, anomalies, threat hunts and more), most recently changed first, by kind, status, severity, object and date. |
| List objects | List the objects of one or more kinds, such as every SQL Server database or Linux fileset, with their SLA Domain and cluster. |
| List objects by compliance | List objects with their SLA compliance, protection, last snapshot and missed snapshots, such as to report every object out of compliance. |
| List SLA Domains | List SLA Domains, the backup policies, with how often they take snapshots, how long they keep them and how many objects they protect. |
| List snapshots | List an object's snapshots, newest first, by kind and date, such as to check a server was backed up last night. |
| List threat hunts | List threat hunts with their status and what they found, by status, whether they found matches, cluster and when they started. |
| List vSphere VMs | List VMware vSphere virtual machines with their SLA Domain, snapshot count and cluster. |
| Resolve anomaly | Mark an anomaly resolved after investigating it, or report it as a false positive with the reason. |
| Search objects | Find protected objects of any kind (VMs, databases, filesets, cloud resources, mailboxes) by name, with their SLA Domain and cluster. |
| Start threat hunt | Start a Turbo Threat Hunt that looks through backups for files with the given hashes, such as indicators from a security alert. |
| Take on-demand snapshot | Back up one or more objects now, outside their schedule. |
Assign SLA Domain
Protect objects with an SLA Domain, stop protecting them, or have them inherit their parent's SLA Domain again.
Inputs
- Object IDs
object_idslistRequired - The IDs of the objects, from 'Search objects' or 'List objects'.
- Assignment
assignmenttext - What to do with the objects.One of:
protectWithSlaId(Protect with an SLA Domain),doNotProtect(Do not protect),noAssignment(Inherit from its parent). Default:protectWithSlaId. - SLA Domain
sla_domaintext - The SLA Domain to protect them with.
- Apply to existing snapshots
apply_to_existing_snapshotstrue/false - Also keep the objects' existing snapshots for as long as the new SLA Domain says. Off applies it to new snapshots only.Default:
false.
Outputs
assignmenttext- protectWithSlaId, doNotProtect or noAssignment
object_idslist- The objects it was applied to
sla_domain_idtext- The SLA Domain, when protecting with one
successtrue/false- True if RSC applied it
Example output
{
"assignment": "protectWithSlaId",
"object_ids": [
"3c5c7a7e-6d3c-5b9a-9f1e-0e2d6c1b7a40"
],
"sla_domain_id": "00000000-0000-0000-0000-000000000002",
"success": true
}Get anomaly
Read what Anomaly Detection found in a snapshot: how likely an attack is, suspicious, encrypted and deleted files, and ransomware strains.
Inputs
- Object ID
object_idtextRequired - The ID of the object the anomaly is on (the event's fid).
- Anomaly event ID
anomaly_idtextRequired - The anomaly event's ID (activitySeriesId), from 'Anomaly detected' or 'List events'.
Outputs
anomalyobject- The anomaly
Example output
{
"anomaly": {
"activitySeriesId": "7d4e2f1a-3b5c-4d6e-8f9a-0b1c2d3e4f5a",
"anomalyInfo": {
"strainAnalysisInfo": [
{
"strainId": "LockBit",
"totalAffectedFiles": 1802,
"totalRansomwareNotes": 12
}
]
},
"anomalyProbability": 0.97,
"anomalyType": "FILESYSTEM",
"cluster": {
"id": "5f8c4e2a-1b3d-4c6e-8f0a-2b4d6f8a0c1e",
"name": "rubrik-dc1"
},
"detectionTime": "2026-11-13T04:30:00.000Z",
"encryption": "HIGH",
"filesCreatedCount": 1830,
"filesDeletedCount": 1802,
"filesModifiedCount": 44,
"id": "a7b8c9d0-e1f2-4a3b-8c4d-5e6f7a8b9c0d",
"isAnomaly": true,
"location": "vcenter01/DC1/Cluster-A",
"objectType": "VmwareVm",
"resolutionStatus": "UNRESOLVED",
"severity": "Critical",
"snapshotDate": "2026-11-13T04:00:12.000Z",
"snapshotFid": "9b2f7c1d-4e5a-5b6c-8d9e-0f1a2b3c4d5e",
"suspiciousFilesCount": 1824,
"workloadFid": "3c5c7a7e-6d3c-5b9a-9f1e-0e2d6c1b7a40",
"workloadId": "VirtualMachine:::vm-1043",
"workloadName": "web-prod-01"
}
}Get cluster
Read a Rubrik cluster: its status, health, version, storage and when it last connected.
Inputs
- Rubrik cluster
clustertextRequired - The Rubrik cluster, chosen from the list or its ID.
Outputs
clusterobject- The Rubrik cluster
Example output
{
"cluster": {
"defaultAddress": "10.0.10.21",
"estimatedRunway": 412,
"id": "5f8c4e2a-1b3d-4c6e-8f0a-2b4d6f8a0c1e",
"isHealthy": true,
"lastConnectionTime": "2026-11-13T08:55:12.000Z",
"metric": {
"availableCapacity": 56000000000000,
"totalCapacity": 120000000000000,
"usedCapacity": 64000000000000
},
"name": "rubrik-dc1",
"productType": "CDM",
"registrationTime": "2024-03-02T15:20:00.000Z",
"snapshotCount": 18250,
"status": "Connected",
"systemStatus": "OK",
"systemStatusMessage": "",
"type": "OnPrem",
"version": "9.2.1-p3-28974"
}
}Get event
Read an event with each of its messages, as RSC's Events page shows them, such as to post why a backup failed.
Inputs
- Event ID
event_idtextRequired - The event's ID (activitySeriesId), from a trigger or 'List events'.
- Rubrik cluster
clustertext - The Rubrik cluster it happened on, if RSC needs it to find it.
Outputs
activitieslist- Its messages, as RSC's Events page shows them
countnumber- How many messages
eventobject- The event
Example output
{
"activities": [
{
"id": "1",
"message": "Started backup of vSphere VM 'web-prod-01'.",
"severity": "Info",
"status": "Running",
"time": "2026-11-13T04:00:02.000Z"
},
{
"id": "2",
"message": "Failed backup of vSphere VM 'web-prod-01'.",
"severity": "Critical",
"status": "Failure",
"time": "2026-11-13T04:12:40.000Z"
}
],
"count": 2,
"event": {
"activitySeriesId": "7d4e2f1a-3b5c-4d6e-8f9a-0b1c2d3e4f5a",
"clusterName": "rubrik-dc1",
"clusterUuid": "5f8c4e2a-1b3d-4c6e-8f0a-2b4d6f8a0c1e",
"failureReason": "Datastore is out of space",
"fid": "3c5c7a7e-6d3c-5b9a-9f1e-0e2d6c1b7a40",
"id": 845123,
"lastActivityMessage": "Failed backup of vSphere VM 'web-prod-01'.",
"lastActivityStatus": "Failure",
"lastActivityType": "Backup",
"lastUpdated": "2026-11-13T04:12:40.000Z",
"location": "vcenter01/DC1/Cluster-A",
"objectId": "VirtualMachine:::vm-1043",
"objectName": "web-prod-01",
"objectType": "VmwareVm",
"progress": "100%",
"severity": "Critical",
"slaDomainName": "Gold",
"startTime": "2026-11-13T04:00:02.000Z",
"username": ""
}
}Get object
Read a protected object: its kind, where it is, its SLA Domain and how many snapshots it has.
Inputs
- Object ID
object_idtextRequired - The object's ID, from 'Search objects', 'List objects' or an event.
Outputs
objectobject- The object
Example output
{
"object": {
"cluster": {
"id": "5f8c4e2a-1b3d-4c6e-8f0a-2b4d6f8a0c1e",
"name": "rubrik-dc1"
},
"effectiveSlaDomain": {
"id": "00000000-0000-0000-0000-000000000002",
"name": "Gold"
},
"id": "3c5c7a7e-6d3c-5b9a-9f1e-0e2d6c1b7a40",
"logicalPath": [
{
"fid": "8e1d1c2a-0b4f-5c3d-a6e7-1f2a3b4c5d6e",
"name": "vcenter01",
"objectType": "VSphereVCenter"
}
],
"name": "web-prod-01",
"objectType": "VmwareVirtualMachine",
"pendingSla": {
"id": "",
"name": ""
},
"physicalPath": [
{
"fid": "8e1d1c2a-0b4f-5c3d-a6e7-1f2a3b4c5d6e",
"name": "vcenter01",
"objectType": "VSphereVCenter"
}
],
"slaAssignment": "Direct",
"snapshotDistribution": {
"onDemandCount": 2,
"scheduledCount": 94,
"totalCount": 96
}
}
}Get snapshot
Read a snapshot: when it was taken and expires, its SLA Domain and whether it is flagged as an anomaly or quarantined.
Inputs
- Snapshot ID
snapshottextRequired - The snapshot's ID, from 'List snapshots' or 'New snapshot'.
Outputs
snapshotobject- The snapshot
Example output
{
"snapshot": {
"cdmId": "VirtualMachine:::vm-1043-snapshot-7781",
"cluster": {
"id": "5f8c4e2a-1b3d-4c6e-8f0a-2b4d6f8a0c1e",
"name": "rubrik-dc1"
},
"date": "2026-11-13T04:00:12.000Z",
"expirationDate": "2027-11-13T04:00:12.000Z",
"id": "9b2f7c1d-4e5a-5b6c-8d9e-0f1a2b3c4d5e",
"isAnomaly": false,
"isCorrupted": false,
"isExpired": false,
"isOnDemandSnapshot": false,
"isQuarantined": false,
"slaDomain": {
"id": "00000000-0000-0000-0000-000000000002",
"name": "Gold"
},
"snappableId": "3c5c7a7e-6d3c-5b9a-9f1e-0e2d6c1b7a40",
"snappableNew": {
"id": "3c5c7a7e-6d3c-5b9a-9f1e-0e2d6c1b7a40",
"name": "web-prod-01",
"objectType": "VmwareVirtualMachine"
}
}
}Get task status
Read how a task such as an on-demand snapshot is going: running, succeeded or failed, and how far along.
Inputs
- Task ID
taskchain_idtextRequired - The task's ID, from 'Take on-demand snapshot'.
Outputs
finishedtrue/false- True once it has succeeded, failed or been canceled
statetext- READY, RUNNING, SUCCEEDED, FAILED, CANCELING or CANCELED
taskchainobject- The task
Example output
{
"finished": true,
"state": "SUCCEEDED",
"taskchain": {
"endTime": "2026-11-13T09:06:51.000Z",
"error": "",
"id": 99812,
"jobType": "OnDemandSnapshot",
"progress": 100,
"progressedAt": "2026-11-13T09:06:51.000Z",
"startTime": "2026-11-13T09:00:04.000Z",
"state": "SUCCEEDED",
"taskchainUuid": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f"
}
}Get threat hunt
Read a threat hunt: its status, how many objects and snapshots it scanned and how many had matches.
Inputs
- Threat hunt ID
hunt_idtextRequired - The hunt's ID, from 'Start threat hunt', 'List threat hunts' or 'Threat hunt finished'.
Outputs
huntobject- The threat hunt
hunt_idtext- The threat hunt's ID
objectsobject- What it found, by object
Example output
{
"hunt": {
"baseConfig": {
"name": "LockBit hashes",
"notes": "",
"threatHuntType": "TURBO_THREAT_HUNT"
},
"clusters": [
{
"id": "5f8c4e2a-1b3d-4c6e-8f0a-2b4d6f8a0c1e",
"name": "rubrik-dc1"
}
],
"endTime": "2026-11-13T09:31:47.000Z",
"startTime": "2026-11-13T09:10:00.000Z",
"status": "SUCCEEDED",
"totalMatchedSnapshots": 0,
"totalObjectFids": 214,
"totalScannedSnapshots": 1284,
"totalUniqueFileMatches": 0
},
"hunt_id": "TH-2f6a9c1e",
"objects": {
"totalAffectedObjects": 0,
"totalObjectsScanned": 214,
"totalObjectsUnscannable": 0,
"totalUnaffectedObjects": 214
}
}Get version
Read Rubrik Security Cloud's version, which also checks the connection works.
Inputs
None.
Outputs
account_urltext- The RSC address the connection uses
versiontext- Rubrik Security Cloud's version
Example output
{
"account_url": "https://example.my.rubrik.com",
"version": "v20261103-12"
}Get vSphere VM
Read a vSphere virtual machine: its SLA Domain, guest OS, snapshot count and its newest and oldest snapshot.
Inputs
- VM ID
vmtextRequired - The virtual machine's ID, from 'List vSphere VMs' or 'Search objects'.
Outputs
vmobject- The virtual machine
Example output
{
"vm": {
"cluster": {
"id": "5f8c4e2a-1b3d-4c6e-8f0a-2b4d6f8a0c1e",
"name": "rubrik-dc1"
},
"effectiveSlaDomain": {
"id": "00000000-0000-0000-0000-000000000002",
"name": "Gold"
},
"guestOsName": "Ubuntu Linux (64-bit)",
"id": "3c5c7a7e-6d3c-5b9a-9f1e-0e2d6c1b7a40",
"isRelic": false,
"logicalPath": [
{
"fid": "8e1d1c2a-0b4f-5c3d-a6e7-1f2a3b4c5d6e",
"name": "vcenter01",
"objectType": "VSphereVCenter"
}
],
"name": "web-prod-01",
"newestSnapshot": {
"date": "2026-11-13T04:00:12.000Z",
"id": "9b2f7c1d-4e5a-5b6c-8d9e-0f1a2b3c4d5e"
},
"objectType": "VmwareVirtualMachine",
"oldestSnapshot": {
"date": "2025-11-13T04:00:09.000Z",
"id": "1a2b3c4d-5e6f-5a7b-8c9d-0e1f2a3b4c5d"
},
"onDemandSnapshotCount": 2,
"protectionDate": "2024-03-05T02:00:00.000Z",
"slaAssignment": "Direct",
"snapshotDistribution": {
"onDemandCount": 2,
"scheduledCount": 94,
"totalCount": 96
},
"vmwareToolsInstalled": true
}
}List clusters
List the Rubrik clusters in the account with their status, version, free space and how long it will last.
Inputs
- Name contains
nametext - Only those whose name contains these words.
- Kind
cluster_typelist - Only clusters of these kinds.One or more of:
OnPrem(On-premises),Cloud,Robo(Remote office (Robo)),ExoCompute,Polaris(Rubrik Security Cloud). - Status
statuslist - Only clusters in these states.One or more of:
Connected,Disconnected,Initializing. - How many
limitnumber - The most to list. Defaults to 50.From 1 to 200.
- Page cursor
cursortext - To read the next page, the next_cursor an earlier run of this step gave. Leave empty for the first page.
Outputs
clusterslist- The Rubrik clusters
countnumber- How many are on this page
has_moretrue/false- True if there are more after this page
next_cursortext- Give this to the step's Page cursor to read the next page; empty on the last page
totalnumber- How many match in all
Example output
{
"clusters": [
{
"defaultAddress": "10.0.10.21",
"estimatedRunway": 412,
"id": "5f8c4e2a-1b3d-4c6e-8f0a-2b4d6f8a0c1e",
"isHealthy": true,
"lastConnectionTime": "2026-11-13T08:55:12.000Z",
"metric": {
"availableCapacity": 56000000000000,
"totalCapacity": 120000000000000,
"usedCapacity": 64000000000000
},
"name": "rubrik-dc1",
"productType": "CDM",
"registrationTime": "2024-03-02T15:20:00.000Z",
"snapshotCount": 18250,
"status": "Connected",
"systemStatus": "OK",
"systemStatusMessage": "",
"type": "OnPrem",
"version": "9.2.1-p3-28974"
}
],
"count": 1,
"has_more": false,
"next_cursor": "",
"total": 1
}List events
List events (backups, recoveries, anomalies, threat hunts and more), most recently changed first, by kind, status, severity, object and date.
Inputs
- Kind
event_typelist - Only events of these kinds.One or more of:
BACKUP,RECOVERY,ARCHIVE,REPLICATION,ANOMALY(Anomaly (ransomware)),THREAT_HUNT(Threat hunt),THREAT_MONITORING(Threat monitoring),CLASSIFICATION(Sensitive data discovery),LOCK_SNAPSHOT(Snapshot lock),LEGAL_HOLD(Legal hold), and 8 more. - Status
statuslist - Only events with these statuses.One or more of:
SUCCESS(Succeeded),PARTIAL_SUCCESS(Succeeded with warnings),FAILURE(Failed),TASK_FAILURE(Task failed),TASK_SUCCESS(Task succeeded),WARNING,RUNNING,QUEUED,CANCELING,CANCELED,INFO(Information). - Severity
severitylist - Only events this severe.One or more of:
SEVERITY_CRITICAL(Critical),SEVERITY_WARNING(Warning),SEVERITY_INFO(Information). - Object kind
object_typelist - Only events about these kinds of object.One or more of:
VMWARE_VM(VMware virtual machine),HYPERV_VM(Hyper-V virtual machine),NUTANIX_VM(Nutanix virtual machine),LINUX_FILESET(Linux fileset),WINDOWS_FILESET(Windows fileset),SHARE_FILESET(NAS share fileset),MSSQL(SQL Server database),ORACLE_DB(Oracle database),MANAGED_VOLUME(Managed volume),STORAGE_ARRAY_VOLUME_GROUP(Storage array volume group), and 6 more. - Object name
object_nametext - Only events about the object with this name.
- Rubrik cluster
clustertext - Only events on this Rubrik cluster.
- Changed after
updated_afterdate and time - Only events that changed after this.
- Changed before
updated_beforedate and time - Only events that changed before this.
- How many
limitnumber - The most to list. Defaults to 50.From 1 to 200.
- Page cursor
cursortext - To read the next page, the next_cursor an earlier run of this step gave. Leave empty for the first page.
Outputs
countnumber- How many are on this page
eventslist- The events, most recently changed first
has_moretrue/false- True if there are more after this page
next_cursortext- Give this to the step's Page cursor to read the next page; empty on the last page
totalnumber- How many match in all
Example output
{
"count": 1,
"events": [
{
"activitySeriesId": "7d4e2f1a-3b5c-4d6e-8f9a-0b1c2d3e4f5a",
"clusterName": "rubrik-dc1",
"clusterUuid": "5f8c4e2a-1b3d-4c6e-8f0a-2b4d6f8a0c1e",
"failureReason": "Datastore is out of space",
"fid": "3c5c7a7e-6d3c-5b9a-9f1e-0e2d6c1b7a40",
"id": 845123,
"lastActivityMessage": "Failed backup of vSphere VM 'web-prod-01'.",
"lastActivityStatus": "Failure",
"lastActivityType": "Backup",
"lastUpdated": "2026-11-13T04:12:40.000Z",
"location": "vcenter01/DC1/Cluster-A",
"objectId": "VirtualMachine:::vm-1043",
"objectName": "web-prod-01",
"objectType": "VmwareVm",
"progress": "100%",
"severity": "Critical",
"slaDomainName": "Gold",
"startTime": "2026-11-13T04:00:02.000Z",
"username": ""
}
],
"has_more": false,
"next_cursor": "",
"total": 1
}List objects
List the objects of one or more kinds, such as every SQL Server database or Linux fileset, with their SLA Domain and cluster.
Inputs
- Kind
object_typelistRequired - The kinds of object to list.One or more of:
VmwareVirtualMachine(VMware virtual machines),HypervVirtualMachine(Hyper-V virtual machines),NutanixVirtualMachine(Nutanix virtual machines),LinuxFileset(Linux filesets),WindowsFileset(Windows filesets),ShareFileset(NAS share filesets),PhysicalHost(Physical hosts),VolumeGroup(Volume groups),WindowsVolumeGroup(Windows volume groups),Mssql(SQL Server databases), and 10 more. - Name contains
nametext - Only those whose name contains these words.
- Rubrik cluster
clustertext - Only objects on this Rubrik cluster.
- How many
limitnumber - The most to list. Defaults to 50.From 1 to 200.
- Page cursor
cursortext - To read the next page, the next_cursor an earlier run of this step gave. Leave empty for the first page.
Outputs
countnumber- How many are on this page
has_moretrue/false- True if there are more after this page
next_cursortext- Give this to the step's Page cursor to read the next page; empty on the last page
objectslist- The objects
totalnumber- How many match in all
Example output
{
"count": 1,
"has_more": false,
"next_cursor": "",
"objects": [
{
"cluster": {
"id": "5f8c4e2a-1b3d-4c6e-8f0a-2b4d6f8a0c1e",
"name": "rubrik-dc1"
},
"effectiveSlaDomain": {
"id": "00000000-0000-0000-0000-000000000002",
"name": "Gold"
},
"id": "3c5c7a7e-6d3c-5b9a-9f1e-0e2d6c1b7a40",
"name": "web-prod-01",
"objectType": "VmwareVirtualMachine",
"pendingSla": {
"id": "",
"name": ""
},
"physicalPath": [
{
"fid": "8e1d1c2a-0b4f-5c3d-a6e7-1f2a3b4c5d6e",
"name": "vcenter01",
"objectType": "VSphereVCenter"
}
],
"slaAssignment": "Direct"
}
],
"total": 1
}List objects by compliance
List objects with their SLA compliance, protection, last snapshot and missed snapshots, such as to report every object out of compliance.
Inputs
- Compliance
compliance_statuslist - Only objects with these compliance statuses.One or more of:
OUT_OF_COMPLIANCE(Out of compliance),IN_COMPLIANCE(In compliance),UNPROTECTED,NOT_AVAILABLE(Not available). - Protection
protection_statuslist - Only objects protected this way.One or more of:
Protected,NoSla(No SLA Domain),DoNotProtect(Do not protect). - Name contains
searchtext - Only objects whose name contains these words.
- Rubrik cluster
clustertext - Only objects on this Rubrik cluster.
- How many
limitnumber - The most to list. Defaults to 50.From 1 to 200.
- Page cursor
cursortext - To read the next page, the next_cursor an earlier run of this step gave. Leave empty for the first page.
Outputs
countnumber- How many are on this page
has_moretrue/false- True if there are more after this page
next_cursortext- Give this to the step's Page cursor to read the next page; empty on the last page
objectslist- The objects and their compliance
totalnumber- How many match in all
Example output
{
"count": 1,
"has_more": false,
"next_cursor": "",
"objects": [
{
"cluster": {
"id": "5f8c4e2a-1b3d-4c6e-8f0a-2b4d6f8a0c1e",
"name": "rubrik-dc1"
},
"complianceStatus": "OUT_OF_COMPLIANCE",
"fid": "3c5c7a7e-6d3c-5b9a-9f1e-0e2d6c1b7a40",
"id": "VirtualMachine:::4a6f-1c2d-vm-1043",
"lastSnapshot": "2026-11-11T04:00:12.000Z",
"location": "vcenter01/DC1/Cluster-A",
"missedSnapshots": 3,
"name": "web-prod-01",
"objectType": "VmwareVm",
"protectionStatus": "Protected",
"slaDomain": {
"id": "00000000-0000-0000-0000-000000000002",
"name": "Gold"
},
"totalSnapshots": 93
}
],
"total": 1
}List SLA Domains
List SLA Domains, the backup policies, with how often they take snapshots, how long they keep them and how many objects they protect.
Inputs
- Name contains
nametext - Only those whose name contains these words.
- Rubrik cluster
clustertext - Only SLA Domains on this Rubrik cluster.
- How many
limitnumber - The most to list. Defaults to 50.From 1 to 200.
- Page cursor
cursortext - To read the next page, the next_cursor an earlier run of this step gave. Leave empty for the first page.
Outputs
countnumber- How many are on this page
has_moretrue/false- True if there are more after this page
next_cursortext- Give this to the step's Page cursor to read the next page; empty on the last page
sla_domainslist- The SLA Domains
totalnumber- How many match in all
Example output
{
"count": 1,
"has_more": false,
"next_cursor": "",
"sla_domains": [
{
"baseFrequency": {
"duration": 4,
"unit": "HOURS"
},
"description": "Snapshots every 4 hours, kept for a year",
"id": "00000000-0000-0000-0000-000000000002",
"isDefault": true,
"localRetentionLimit": {
"duration": 1,
"unit": "YEARS"
},
"name": "Gold",
"objectTypes": [
"VSPHERE_OBJECT_TYPE",
"FILESET_OBJECT_TYPE"
],
"protectedObjectCount": 214
}
],
"total": 1
}List snapshots
List an object's snapshots, newest first, by kind and date, such as to check a server was backed up last night.
Inputs
- Object ID
object_idtextRequired - The object's ID, from 'Search objects', 'List objects' or an event.
- Kind
snapshot_typelist - Only snapshots of these kinds.One or more of:
SCHEDULED,ON_DEMAND(On demand),DOWNLOADED. - Taken after
taken_afterdate and time - Only snapshots taken after this.
- Taken before
taken_beforedate and time - Only snapshots taken before this.
- How many
limitnumber - The most to list. Defaults to 50.From 1 to 200.
- Page cursor
cursortext - To read the next page, the next_cursor an earlier run of this step gave. Leave empty for the first page.
Outputs
countnumber- How many are on this page
has_moretrue/false- True if there are more after this page
next_cursortext- Give this to the step's Page cursor to read the next page; empty on the last page
object_idtext- The object whose snapshots these are
snapshotslist- The snapshots, newest first
totalnumber- How many match in all
Example output
{
"count": 1,
"has_more": false,
"next_cursor": "",
"object_id": "3c5c7a7e-6d3c-5b9a-9f1e-0e2d6c1b7a40",
"snapshots": [
{
"cluster": {
"id": "5f8c4e2a-1b3d-4c6e-8f0a-2b4d6f8a0c1e",
"name": "rubrik-dc1"
},
"date": "2026-11-13T04:00:12.000Z",
"expirationDate": "2027-11-13T04:00:12.000Z",
"id": "9b2f7c1d-4e5a-5b6c-8d9e-0f1a2b3c4d5e",
"isAnomaly": false,
"isExpired": false,
"isOnDemandSnapshot": false,
"isQuarantined": false,
"slaDomain": {
"id": "00000000-0000-0000-0000-000000000002",
"name": "Gold"
},
"snappableId": "3c5c7a7e-6d3c-5b9a-9f1e-0e2d6c1b7a40"
}
],
"total": 1
}List threat hunts
List threat hunts with their status and what they found, by status, whether they found matches, cluster and when they started.
Inputs
- Status
statuslist - Only hunts with these statuses.One or more of:
SUCCEEDED,PARTIALLY_SUCCEEDED(Partly succeeded),FAILED,ABORTED(Stopped (too many matches)),CANCELED,IN_PROGRESS(In progress),PENDING. - Matches
matcheslist - Only hunts with these results.One or more of:
MATCHES_FOUND(Found matches),NO_MATCHES(Found no matches),UNSCANNED(Couldn't scan). - Rubrik cluster
clustertext - Only hunts on this Rubrik cluster.
- Started after
started_afterdate and time - Only hunts started after this.
- Started before
started_beforedate and time - Only hunts started before this.
- How many
limitnumber - The most to list. Defaults to 50.From 1 to 200.
- Page cursor
cursortext - To read the next page, the next_cursor an earlier run of this step gave. Leave empty for the first page.
Outputs
countnumber- How many are on this page
has_moretrue/false- True if there are more after this page
huntslist- The threat hunts
next_cursortext- Give this to the step's Page cursor to read the next page; empty on the last page
totalnumber- How many match in all
Example output
{
"count": 1,
"has_more": false,
"hunts": [
{
"createdBy": {
"email": "",
"username": "client|c9bba9a9-1234-1234-b7c6-123440b4cf64"
},
"huntDetails": {
"cluster": {
"id": "5f8c4e2a-1b3d-4c6e-8f0a-2b4d6f8a0c1e",
"name": "rubrik-dc1"
},
"endTime": "2026-11-13T09:31:47.000Z",
"startTime": "2026-11-13T09:10:00.000Z"
},
"huntId": "TH-2f6a9c1e",
"huntType": "TURBO_THREAT_HUNT",
"name": "LockBit hashes",
"startTime": "2026-11-13T09:10:00.000Z",
"stats": {
"totalAffectedObjects": 0,
"totalAffectedSnapshots": 0,
"totalIocs": 2,
"totalObjectsScanned": 214,
"totalSnapshotsScanned": 1284,
"totalUniqueMatchedPaths": 0
},
"status": "SUCCEEDED"
}
],
"next_cursor": "",
"total": 1
}List vSphere VMs
List VMware vSphere virtual machines with their SLA Domain, snapshot count and cluster.
Inputs
- Name contains
nametext - Only those whose name contains these words.
- Rubrik cluster
clustertext - Only virtual machines on this Rubrik cluster.
- Include relics
include_relicstrue/false - Also list machines gone from vCenter whose snapshots Rubrik still keeps.Default:
false. - How many
limitnumber - The most to list. Defaults to 50.From 1 to 200.
- Page cursor
cursortext - To read the next page, the next_cursor an earlier run of this step gave. Leave empty for the first page.
Outputs
countnumber- How many are on this page
has_moretrue/false- True if there are more after this page
next_cursortext- Give this to the step's Page cursor to read the next page; empty on the last page
totalnumber- How many match in all
vmslist- The virtual machines
Example output
{
"count": 1,
"has_more": false,
"next_cursor": "",
"total": 1,
"vms": [
{
"cluster": {
"id": "5f8c4e2a-1b3d-4c6e-8f0a-2b4d6f8a0c1e",
"name": "rubrik-dc1"
},
"effectiveSlaDomain": {
"id": "00000000-0000-0000-0000-000000000002",
"name": "Gold"
},
"guestOsName": "Ubuntu Linux (64-bit)",
"id": "3c5c7a7e-6d3c-5b9a-9f1e-0e2d6c1b7a40",
"isRelic": false,
"logicalPath": [
{
"fid": "8e1d1c2a-0b4f-5c3d-a6e7-1f2a3b4c5d6e",
"name": "vcenter01",
"objectType": "VSphereVCenter"
}
],
"name": "web-prod-01",
"objectType": "VmwareVirtualMachine",
"protectionDate": "2024-03-05T02:00:00.000Z",
"slaAssignment": "Direct",
"snapshotDistribution": {
"onDemandCount": 2,
"scheduledCount": 94,
"totalCount": 96
},
"vmwareToolsInstalled": true
}
]
}Resolve anomaly
Mark an anomaly resolved after investigating it, or report it as a false positive with the reason.
Inputs
- Object ID
object_idtextRequired - The ID of the object the anomaly is on (the event's fid).
- Anomaly event ID
anomaly_idtextRequired - The anomaly event's ID (activitySeriesId), from 'Anomaly detected' or 'List events'.
- Anomaly kind
anomaly_typetext - Where it was found, as 'Get anomaly' says.One of:
FILESYSTEM(File system),HYPERVISOR. Default:FILESYSTEM. - False positive reason
false_positivetext - To report it as a false positive, why. Leave empty to only mark it resolved.One of:
OS_UPDATE(Operating system update),APPLICATION_UPDATE(Application update),LOG_ROTATION(Log deletion or rotation),NFA_SCHEDULED_MAINTENANCE(Scheduled maintenance),NFA_UNSCHEDULED_MAINTENANCE(Unscheduled maintenance),OTHER(Another reason). - Other reason
other_reasontext - The reason in words, when the reason is Another reason.Only when False positive reason is Another reason.
Outputs
anomaly_idtext- The anomaly
false_positivetext- The false positive reason given, if any
object_idtext- The object it was on
resolvedtrue/false- True once RSC took it
Example output
{
"anomaly_id": "7d4e2f1a-3b5c-4d6e-8f9a-0b1c2d3e4f5a",
"false_positive": "OS_UPDATE",
"object_id": "3c5c7a7e-6d3c-5b9a-9f1e-0e2d6c1b7a40",
"resolved": true
}Search objects
Find protected objects of any kind (VMs, databases, filesets, cloud resources, mailboxes) by name, with their SLA Domain and cluster.
Inputs
- Name contains
nametextRequired - Words in the object's name.
- Rubrik cluster
clustertext - Only objects on this Rubrik cluster.
- How many
limitnumber - The most to list. Defaults to 50.From 1 to 200.
- Page cursor
cursortext - To read the next page, the next_cursor an earlier run of this step gave. Leave empty for the first page.
Outputs
countnumber- How many are on this page
has_moretrue/false- True if there are more after this page
next_cursortext- Give this to the step's Page cursor to read the next page; empty on the last page
objectslist- The objects
totalnumber- How many match in all
Example output
{
"count": 1,
"has_more": false,
"next_cursor": "",
"objects": [
{
"cluster": {
"id": "5f8c4e2a-1b3d-4c6e-8f0a-2b4d6f8a0c1e",
"name": "rubrik-dc1"
},
"effectiveSlaDomain": {
"id": "00000000-0000-0000-0000-000000000002",
"name": "Gold"
},
"id": "3c5c7a7e-6d3c-5b9a-9f1e-0e2d6c1b7a40",
"name": "web-prod-01",
"objectType": "VmwareVirtualMachine",
"pendingSla": {
"id": "",
"name": ""
},
"physicalPath": [
{
"fid": "8e1d1c2a-0b4f-5c3d-a6e7-1f2a3b4c5d6e",
"name": "vcenter01",
"objectType": "VSphereVCenter"
}
],
"slaAssignment": "Direct"
}
],
"total": 1
}Start threat hunt
Start a Turbo Threat Hunt that looks through backups for files with the given hashes, such as indicators from a security alert.
Inputs
- Name
nametextRequired - A name for the hunt, to find it by in RSC.
- File hashes
hasheslistRequired - The MD5, SHA-1 or SHA-256 hashes of the files to look for.
- Rubrik clusters
clusterslist - Only search these clusters. Leave empty for every cluster.
- Snapshots after
snapshots_afterdate and time - Only look in snapshots taken after this.
- Snapshots before
snapshots_beforedate and time - Only look in snapshots taken before this.
- Snapshots per object
max_snapshots_per_objectnumber - The most snapshots of each object to look in.From 1 to 1000.
Outputs
hash_countnumber- How many hashes it looks for
hunt_idtext- The new threat hunt's ID, for 'Get threat hunt'
nametext- Its name
Example output
{
"hash_count": 2,
"hunt_id": "TH-2f6a9c1e",
"name": "LockBit hashes"
}Take on-demand snapshot
Back up one or more objects now, outside their schedule. Gives a task for each, to follow with 'Get task status'.
Inputs
- Object IDs
object_idslistRequired - The IDs of the objects, from 'Search objects' or 'List objects'.
- SLA Domain
sla_domaintext - The SLA Domain whose retention the snapshot follows. Leave empty to keep it under each object's own SLA Domain.
Outputs
error_countnumber- How many couldn't start
errorslist- The objects RSC couldn't start one for
startedlist- The objects a snapshot started for
started_countnumber- How many started
taskchain_idtext- The first task's ID, for 'Get task status'
Example output
{
"error_count": 0,
"errors": [],
"started": [
{
"taskchainUuid": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f",
"workloadId": "3c5c7a7e-6d3c-5b9a-9f1e-0e2d6c1b7a40"
}
],
"started_count": 1,
"taskchain_id": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f"
}