API Reference
Every query, mutation, and type in the Rubrik Security Cloud schema, generated directly from it. One endpoint serves all of it:
-
Queries
Read operations. Inventory a workload, list snapshots, check compliance, poll a job.
-
Mutations
Write operations. Take a snapshot, assign an SLA, start a recovery, register a host.
-
Types
Objects, inputs, enums, interfaces, unions, and scalars. What a field returns and what an input accepts.
Guess the URL
Pages are named after the thing they document, so you can skip the indexes when you already know the name:
| Looking for | Goes to |
|---|---|
the takeOnDemandSnapshot mutation |
mutations/takeOnDemandSnapshot/ |
the AwsNativeS3Bucket object |
types/objects/AwsNativeS3Bucket/ |
the SlaAssignTypeEnum enum |
types/enums/SlaAssignTypeEnum/ |
Reference pages are not in site search
There are over ten thousand of them, so they are excluded from the search index to keep search useful for the guides. Use the alphabetical indexes above, or guess the URL.
Tracking changes
The schema ships roughly weekly, and these pages are regenerated with it.
- Changelog — what was added, changed, and removed, by version
- Deprecations — fields and types deprecated in the current schema
Optional does not always mean optional
A field the schema declares optional can still be required in practice, and a required input whose own fields are all optional will accept an empty object and then fail. The workload guides call out the cases where this bites. If a call type-checks and fails at run time, check the guide for that workload before assuming the reference is wrong.
Where to start instead
If you are not looking up something specific, the guides are a better entry point. They show working requests for real tasks, in GraphQL, PowerShell, and shell.
Data Protection guides · Authentication · Pagination · Troubleshooting