-
Notifications
You must be signed in to change notification settings - Fork 2
/
index.html
399 lines (303 loc) · 11.2 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="img/favicon.ico">
<title>Home - Rubrik API</title>
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.12.0/css/all.css">
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.12.0/css/v4-shims.css">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/[email protected]/build/web/hack.min.css">
<link href='//rsms.me/inter/inter.css' rel='stylesheet' type='text/css'>
<link href='//fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,700italic,400,300,600,700&subset=latin-ext,latin' rel='stylesheet' type='text/css'>
<link href="css/bootstrap-custom.min.css" rel="stylesheet">
<link href="css/base.min.css" rel="stylesheet">
<link href="css/cinder.min.css" rel="stylesheet">
<link rel="stylesheet" href="//cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/styles/github.min.css">
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/html5shiv.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dest/respond.min.js"></script>
<![endif]-->
</head>
<body class="homepage" >
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
<button
type="button"
class="navbar-toggle"
data-toggle="collapse"
data-target=".navbar-collapse"
>
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<!-- Main title -->
<a class="navbar-brand" href="."
>Rubrik API</a
>
</div>
<!-- Expanded navigation -->
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li class="active" >
<a href=".">Home</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"
>Usage <b class="caret"></b
></a>
<ul class="dropdown-menu">
<li >
<a href="api/auth/">Authentication</a>
</li>
<li >
<a href="api/errors/">Errors</a>
</li>
<li >
<a href="api/rate_limiting/">Rate-limiting</a>
</li>
<li >
<a href="api/playground/">Playground</a>
</li>
<li >
<a href="rest-apis/">REST APIs</a>
</li>
</ul>
</li>
<li >
<a href="reference/">Reference</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"
>Changelog <b class="caret"></b
></a>
<ul class="dropdown-menu">
<li >
<a href="changelog/overview/">Overview</a>
</li>
<li >
<a href="changelog/breaking/">Breaking changes</a>
</li>
<li >
<a href="changelog/deprecations/">Deprecations</a>
</li>
<li >
<a href="changelog/changes/">Full Changelog</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"
>Use cases <b class="caret"></b
></a>
<ul class="dropdown-menu">
<li >
<a href="use-cases/watchers/">Events and Reporting APIs</a>
</li>
<li >
<a href="use-cases/azure-native-protection-cloud-account/">Cloud Account APIs for Azure Cloud Native Protection</a>
</li>
<li >
<a href="use-cases/aws-native-protection-cloud-account/">Cloud Account APIs for AWS Cloud Native Protection</a>
</li>
<li >
<a href="use-cases/cloud-native-private-container-registry/">Cloud Native Private Container Registry</a>
</li>
<li >
<a href="use-cases/slas/">SLA APIs</a>
</li>
<li >
<a href="use-cases/quarantine/">Quarantine APIs</a>
</li>
</ul>
</li>
<li >
<a href="rosettastone/">API Rosetta Stone</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
</ul>
</div>
</div>
</div>
<div class="container">
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
<ul class="nav bs-sidenav">
<li class="first-level active">
<a href="#rubrik-security-cloud-api">Rubrik Security Cloud API</a>
</li>
<li class="second-level">
<a href="#graphql-overview">GraphQL overview</a>
</li>
<li class="second-level">
<a href="#graphql-query-type">GraphQL query type</a>
</li>
<li class="third-level">
<a href="#sample-graphql-query">Sample GraphQL query</a>
</li>
<li class="third-level">
<a href="#sample-response">Sample response</a>
</li>
<li class="second-level">
<a href="#resources">Resources</a>
</li>
</ul>
</div></div>
<div class="col-md-9" role="main"> <h1 id="rubrik-security-cloud-api">Rubrik Security Cloud API</h1>
<p>Rubrik Security Cloud API allows you to integrate the Rubrik platform
across a number of existing enterprise tools and workflows.</p>
<p>We utilize <a href="https://graphql.org">GraphQL</a> as the API query language.
GraphQL allows you to retrieve just the data you need, eliminating
the common scenario of an API call returning either too much
or not enough data.</p>
<h2 id="graphql-overview">GraphQL overview</h2>
<p>GraphQL queries are defined in terms of types and fields. Rather than using
various endpoints identified by path-based URIs and HTTP verbs, GraphQL uses a
single endpoint backed by a schema that specifies how to retrieve and modify
application data based on the relationship between the types and fields.</p>
<p>You can use GraphQL queries to retrieve data, and mutations to modify data.
A GraphQL query is a request to retrieve specific fields of an object type,
and a GraphQL mutation is a request to modify specific fields of an object
type. The GraphQL runtime engine validates the incoming queries and mutations
against the schema and fulfils the valid requests.</p>
<p>Every GraphQL service has a <code>Query</code> type, and may also have a <code>Mutation</code> type.
The <code>Query</code> and <code>Mutation</code> types are special object types in the schema,
as they serve as entry points to the API.</p>
<h2 id="graphql-query-type">GraphQL query type</h2>
<pre><code class="language-yaml">type Query {
# Retrieves the user that is currently logged-in
currentUser: User!
# Retrieves the user with the specified user ID
user(userId: UUID!): User!
}
</code></pre>
<p>In the above example, the <code>Query</code> object type has two fields: <code>currentUser</code> and
<code>user</code>. This implies that the above schema supports the following types of
requests:</p>
<ul>
<li>Request for the details of the currently logged-in user.</li>
<li>Request for the details of any other user identified by the <code>userId</code>
argument.</li>
</ul>
<p>A GraphQL query with either of these fields returns an object of type <code>User</code>:</p>
<pre><code class="language-yaml">type User {
# User ID
userID: UUID!
# User name
email: String!
# Roles that the user has
roles: [String!]!
}
</code></pre>
<p>Based on the definition of the <code>User</code> object type, you can define the fields to
be selected from the <code>User</code> object that is returned by the query.</p>
<p>The following example provides a sample query and response based on the above
schema definition.</p>
<h3 id="sample-graphql-query">Sample GraphQL query</h3>
<pre><code class="language-yaml">query {
currentUser {
email
roles {
name
}
}
}
</code></pre>
<h3 id="sample-response">Sample response</h3>
<pre><code class="language-json">{
"data": {
"currentUser": {
"email": "[email protected]",
"roles": [
{
"name": "Administrator",
}
],
}
},
}
</code></pre>
<h2 id="resources">Resources</h2>
<ul>
<li><a href="https://www.rubrik.com/products">Rubrik Security Cloud overview</a></li>
<li><a href="https://github.com/rubrikinc/api-documentation">Rubrik CDM REST API</a></li>
<li><a href="https://graphql.org">General information about GraphQL queries and mutations</a></li>
<li><a href="https://www.rubrik.com/content/dam/rubrik/en/resources/white-paper/an-introduction-to-graphql-and-rubrik.pdf">GraphQL usage in Rubrik CDM and Rubrik Security Cloud</a></li>
</ul></div>
</div>
<footer class="col-md-12 text-center">
<hr>
<p>
<small>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</small><br>
<small>Revised on: 2024-12-04</small>
</p>
</footer>
<script src="//ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
<script src="js/bootstrap-3.0.3.min.js"></script>
<script src="//cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script>var base_url = "."</script>
<script src="js/base.js"></script>
<div
class="modal"
id="mkdocs_keyboard_modal"
tabindex="-1"
role="dialog"
aria-labelledby="keyboardModalLabel"
aria-hidden="true"
>
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
<button type="button" class="close" data-dismiss="modal">
<span aria-hidden="true">×</span
><span class="sr-only">Close</span>
</button>
</div>
<div class="modal-body">
<table class="table">
<thead>
<tr>
<th style="width: 20%">Keys</th>
<th>Action</th>
</tr>
</thead>
<tbody>
<tr>
<td class="help shortcut"><kbd>?</kbd></td>
<td>Open this help</td>
</tr>
<tr>
<td class="next shortcut"><kbd>n</kbd></td>
<td>Next page</td>
</tr>
<tr>
<td class="prev shortcut"><kbd>p</kbd></td>
<td>Previous page</td>
</tr>
<tr>
<td class="search shortcut"><kbd>s</kbd></td>
<td>Search</td>
</tr>
</tbody>
</table>
</div>
<div class="modal-footer"></div>
</div>
</div>
</div>
</body>
</html>
<!--
MkDocs version : 1.6.1
Build Date UTC : 2024-12-04 22:28:11.354634+00:00
-->