-
Notifications
You must be signed in to change notification settings - Fork 332
/
Copy pathrest-endpoints-all.dita
632 lines (615 loc) · 24.1 KB
/
rest-endpoints-all.dita
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
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="rest-endpoints-all">
<title>REST API endpoint list</title>
<shortdesc>This section lists all of the Couchbase Server REST API endpoints.</shortdesc>
<refbody>
<section><title>HTTP method and URI list</title>
<table>
<title>Cluster endpoints</title>
<tgroup cols="3">
<colspec colname="col1" colwidth="1.5*"/>
<colspec colname="col2" colwidth="3*"/>
<colspec colname="col3" colwidth="3.5*"/>
<thead>
<row>
<entry>HTTP method</entry>
<entry>URI path</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>GET</entry>
<entry><filepath>/pools</filepath></entry>
<entry>Retrieves cluster information.</entry>
</row>
<row>
<entry>GET</entry>
<entry><filepath>/pools/default</filepath></entry>
<entry>Retrieves cluster details.</entry>
</row>
<row>
<entry>POST</entry>
<entry><filepath>/controller/addNode</filepath></entry>
<entry>Adds nodes to clusters.</entry>
</row>
<row>
<entry>POST</entry>
<entry><filepath>/node/controller/doJoinCluster</filepath></entry>
<entry>Joins nodes into clusters</entry>
</row>
<row>
<entry>POST</entry>
<entry><filepath>/controller/ejectNodeentry</filepath></entry>
<entry>Removes nodes from clusters.</entry>
</row>
<row>
<entry>GET, POST, PUT, DELETE</entry>
<entry><filepath>/pools/default/serverGroups</filepath></entry>
<entry>Manages rack zone awareness (server groups).</entry>
</row>
<row>
<entry>POST</entry>
<entry><filepath>/controller/rebalance</filepath></entry>
<entry>Rebalances nodes in a cluster.</entry>
</row>
<row>
<entry>GET, POST</entry>
<entry><filepath>/internalSettings</filepath></entry>
<entry>Manages internal settings. Couchbase Server use only.</entry>
</row>
<row>
<entry>GET, POST</entry>
<entry><filepath>/settings/maxParallelIndexers</filepath></entry>
<entry>Manages parallel indexer configuration. Couchbase Server use only.</entry>
</row>
<row>
<entry>GET, POST</entry>
<entry><filepath>/settings/autoFailover</filepath></entry>
<entry>Manages automatic failover for clusters.</entry>
</row>
<row>
<entry>GET, POST</entry>
<entry><filepath>/settings/autoFailover/resetCount</filepath></entry>
<entry>Resets automatic failover for clusters.</entry>
</row>
<row>
<entry>GET, POST</entry>
<entry><filepath>/settings/alerts</filepath></entry>
<entry>Manages alerts for email notifications.</entry>
</row>
<row>
<entry>POST</entry>
<entry><filepath>/settings/alerts/testEmail</filepath></entry>
<entry>Creates test email for email notifications.</entry>
</row>
<row>
<entry>POST</entry>
<entry><filepath>/settings/alerts/sendTestEmail</filepath></entry>
<entry>Sends test email for email notifications.</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>Server node endpoints</title>
<tgroup cols="3">
<colspec colname="col1" colwidth="1*"/>
<colspec colname="col2" colwidth="3*"/>
<colspec colname="col3" colwidth="3*"/>
<thead>
<row>
<entry>HTTP method</entry>
<entry>URI path</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>GET</entry>
<entry><filepath>/pools/nodes</filepath></entry>
<entry>Retrieves information about nodes in a cluster.</entry>
</row>
<row>
<entry>POST</entry>
<entry><filepath>/controller/setRecoveryType</filepath></entry>
<entry>Sets the recovery type to be performed for a node. Options are delta or
full.</entry>
</row>
<row>
<entry>POST</entry>
<entry><filepath>/controller/failOver</filepath></entry>
<entry>Fails over nodes.</entry>
</row>
<row>
<entry>POST</entry>
<entry><filepath>/controller/startGracefulFailover</filepath></entry>
<entry>Sets graceful failover for a specific server node. The server node is specified
with the <codeph>otpNode=[node_name]</codeph> parameter.</entry>
</row>
<row>
<entry>POST</entry>
<entry><filepath>/node/controller/setupServices</filepath></entry>
<entry>Sets the services (data, query, index, fts). Used also by the provisioning
wizard.</entry>
</row>
<row>
<entry>POST</entry>
<entry><filepath>/settings/web</filepath></entry>
<entry>Sets user names and passwords.</entry>
</row>
<row>
<entry>POST</entry>
<entry><filepath>/pools/default/memoryQuota</filepath></entry>
<entry>The <codeph>memoryQuota</codeph> parameter sets the memory quota.</entry>
</row>
<row>
<entry>POST</entry>
<entry><filepath>/nodes/self/controller/settings</filepath></entry>
<entry>Sets the path for index files.</entry>
</row>
<row>
<entry>GET</entry>
<entry><filepath>/pools/default/buckets/default/nodes/[host]:[port]/stats</filepath></entry>
<entry>Retrieves statistics for a node.</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>Server group endpoints</title>
<tgroup cols="3">
<colspec colname="col1" colwidth="1*"/>
<colspec colname="col2" colwidth="3*"/>
<colspec colname="col3" colwidth="3*"/>
<thead>
<row>
<entry>HTTP method</entry>
<entry>URI path</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>GET</entry>
<entry><filepath>/pools/default/serverGroups</filepath></entry>
<entry>Retrieves information about a server group.</entry>
</row>
<row>
<entry>POST</entry>
<entry><filepath>/pools/default/serverGroups</filepath></entry>
<entry>Creates a server group with a specific name.</entry>
</row>
<row>
<entry>PUT</entry>
<entry><filepath>/pools/default/serverGroups/<:uuid></filepath></entry>
<entry>Updates the server group information.</entry>
</row>
<row>
<entry>PUT</entry>
<entry><filepath>/pools/default/serverGroups?rev=<:number></filepath></entry>
<entry>Updates a server’s group memberships.</entry>
</row>
<row>
<entry>DELETE</entry>
<entry><filepath>/pools/default/serverGroups/<:uuid></filepath></entry>
<entry>Deletes a specific server group.</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>Bucket endpoints</title>
<tgroup cols="3">
<colspec colname="col1" colwidth="1*"/>
<colspec colname="col2" colwidth="3*"/>
<colspec colname="col3" colwidth="3*"/>
<thead>
<row>
<entry>HTTP method</entry>
<entry>URI path</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>GET</entry>
<entry><filepath>/pools/default/buckets</filepath></entry>
<entry>Retrieves all bucket and bucket operations information from a cluster.</entry>
</row>
<row>
<entry>GET</entry>
<entry><filepath>/pools/default/buckets/default</filepath></entry>
<entry>Retrieves information for a single bucket associated with a cluster.</entry>
</row>
<row>
<entry>GET</entry>
<entry><filepath>/pools/default/buckets/[bucket_name]/stats</filepath></entry>
<entry>Retrieves bucket statistics for a specific bucket.</entry>
</row>
<row>
<entry>POST</entry>
<entry><filepath>/pools/default/buckets</filepath></entry>
<entry>Creates a new Couchbase bucket.</entry>
</row>
<row>
<entry>DELETE</entry>
<entry><filepath>/pools/default/buckets/[bucket_name]</filepath></entry>
<entry>Deletes a specific bucket.</entry>
</row>
<row>
<entry>POST</entry>
<entry><filepath>/pools/default/buckets/default/controller/doFlush</filepath></entry>
<entry>Flushes a specific bucket.</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>Index service endpoints</title>
<tgroup cols="3">
<colspec colname="col1" colwidth="1*"/>
<colspec colname="col2" colwidth="2.25*"/>
<colspec colname="col3" colwidth="3.76*"/>
<thead>
<row>
<entry>HTTP method</entry>
<entry>URI path</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>GET</entry>
<entry><filepath>/pools/nodes</filepath></entry>
<entry>Retrieves information about nodes in a cluster.</entry>
</row>
<row>
<entry>POST</entry>
<entry><filepath>/pools/nodes/indexMemoryQuota</filepath></entry>
<entry>The <codeph>indexMemoryQuota</codeph> parameter sets the memory quota for the
Index service.</entry>
</row>
<row>
<entry>GET</entry>
<entry><filepath>/settings/indexes</filepath></entry>
<entry>Retrieves parameter settings for the Index service. Available options are
<codeph>indexerThreads</codeph>, <codeph>maxRollbackPoints</codeph>,
<codeph>memorySnapshotInterval</codeph>, and
<codeph>stableSnapshotInterval</codeph>.</entry>
</row>
<row>
<entry>POST</entry>
<entry><filepath>/settings/indexes</filepath></entry>
<entry>Sets the parameter settings for the Index service.</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>Views endpoints</title>
<tgroup cols="3">
<colspec colname="col1" colwidth="1*"/>
<colspec colname="col2" colwidth="2.69*"/>
<colspec colname="col3" colwidth="3.32*"/>
<thead>
<row>
<entry>HTTP method</entry>
<entry>URI path</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>GET</entry>
<entry><filepath>/[bucket_name]/_design/[ddoc-name]</filepath></entry>
<entry>Retrieves design documents.</entry>
</row>
<row>
<entry>GET</entry>
<entry><filepath>/[bucket_name]/_design/[ddoc-name]/_view/[view-name]</filepath></entry>
<entry>Retrieves views.</entry>
</row>
<row>
<entry>GET</entry>
<entry><filepath>/[bucket-name]/_design/[ddoc-name]/_spatial/[spatial-name]</filepath></entry>
<entry>Retrieves spatial views.</entry>
</row>
<row>
<entry>PUT</entry>
<entry><filepath>/[bucket_name]/_design/[ddoc-name]</filepath></entry>
<entry>Creates a news design document with one or more views.</entry>
</row>
<row>
<entry>DELETE</entry>
<entry><filepath>/[bucket_name]/_design/[ddoc-name]</filepath></entry>
<entry>Deletes design documents.</entry>
</row>
<row>
<entry>POST</entry>
<entry><filepath>/internalSettings</filepath></entry>
<entry>Changes the number of simultaneous requests each node can accept.</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>XDCR endpoints</title>
<tgroup cols="3">
<colspec colname="col1" colwidth="1*"/>
<colspec colname="col2" colwidth="2*"/>
<colspec colname="col3" colwidth="3*"/>
<thead>
<row>
<entry>HTTP method</entry>
<entry>URI path</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>GET</entry>
<entry><filepath>/pools/default/remoteClusters</filepath></entry>
<entry>Retrieves the destination cluster reference</entry>
</row>
<row>
<entry>POST</entry>
<entry><filepath>/pools/default/remoteClusters</filepath></entry>
<entry>Creates a reference to the destination cluster</entry>
</row>
<row>
<entry>PUT</entry>
<entry><filepath>/pools/default/remoteClusters/[UUID]</filepath></entry>
<entry>Modifies the destination cluster reference</entry>
</row>
<row>
<entry>DELETE</entry>
<entry><filepath>/pools/default/remoteClusters/[UUID]</filepath></entry>
<entry>Deletes the reference to the destination cluster.</entry>
</row>
<row>
<entry>GET</entry>
<entry><filepath>/pools/default/certificate</filepath></entry>
<entry>Retrieves the certificate from the cluster.</entry>
</row>
<row>
<entry>POST</entry>
<entry><filepath>/controller/regenerateCertificate</filepath></entry>
<entry>Regenerates a certificate on a destination cluster.</entry>
</row>
<row>
<entry>DELETE</entry>
<entry><filepath>/controller/cancelXDCR/[replication_id]</filepath></entry>
<entry>Deletes the replication.</entry>
</row>
<row>
<entry>GET, POST</entry>
<entry><filepath>/settings/replications/</filepath></entry>
<entry>Global setting supplied to all replications for a cluster.</entry>
</row>
<row>
<entry>GET, POST</entry>
<entry><filepath>/settings/replications/[replication_id]</filepath></entry>
<entry>Settings for a specific replication for a bucket.</entry>
</row>
<row>
<entry>GET</entry>
<entry><filepath>/pools/default/buckets/@xdcr_[bucket_name]/stats/[destination_endpoint]</filepath></entry>
<entry>Retrieves bucket statistics.</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>Compaction endpoints</title>
<tgroup cols="3">
<colspec colname="col1" colwidth="1*"/>
<colspec colname="col2" colwidth="3*"/>
<colspec colname="col3" colwidth="3*"/>
<thead>
<row>
<entry>HTTP method</entry>
<entry>URI path</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>POST </entry>
<entry><filepath>/pools/default/buckets/[bucket_name]/controller/compactBucket</filepath></entry>
<entry>Compacts bucket data and indexes.</entry>
</row>
<row>
<entry>POST</entry>
<entry><filepath>/pools/default/buckets/[bucket_name]/controller/cancelBucketCompaction</filepath></entry>
<entry>Cancels compaction for the specified bucket.</entry>
</row>
<row>
<entry>POST</entry>
<entry><filepath>/[bucket_name]/_design/[ddoc_name]/_spatial/_compact</filepath></entry>
<entry>Compacts a spatial view.</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>Auto-compaction endpoints</title>
<tgroup cols="3">
<colspec colname="col1" colwidth="1*"/>
<colspec colname="col2" colwidth="3*"/>
<colspec colname="col3" colwidth="3*"/>
<thead>
<row>
<entry>HTTP method</entry>
<entry>URI path</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>POST </entry>
<entry><filepath>/controller/setAutoCompaction</filepath></entry>
<entry>Sets cluster-wide auto-compaction intervals and thresholds</entry>
</row>
<row>
<entry>GET </entry>
<entry><filepath>/settings/autoCompaction</filepath></entry>
<entry>Retrieves cluster-wide settings for auto-compaction</entry>
</row>
<row>
<entry>GET </entry>
<entry><filepath>/pools/default/buckets/[bucket_name]</filepath></entry>
<entry>Retrieves auto-compaction settings for named bucket</entry>
</row>
<row>
<entry>POST</entry>
<entry><filepath>/pools/default/buckets/[bucket_name]</filepath></entry>
<entry>Sets auto-compaction interval or thresholds for named bucket</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>Log endpoints</title>
<tgroup cols="3">
<colspec colname="col1" colwidth="1*"/>
<colspec colname="col2" colwidth="2*"/>
<colspec colname="col3" colwidth="4*"/>
<thead>
<row>
<entry>HTTP method</entry>
<entry>URI path</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>GET</entry>
<entry><filepath>/diag</filepath></entry>
<entry>Retrieves log and additional server diagnostic information.</entry>
</row>
<row>
<entry>GET</entry>
<entry><filepath>/sasl_logs</filepath></entry>
<entry>Retrieves a generic list of log information.</entry>
</row>
<row>
<entry>GET</entry>
<entry><filepath>/sasl_logs/[log_name]</filepath></entry>
<entry>Retrieves information from the specified log category. Where the
<i>log_name</i> is one of the following log types:<ul>
<li><codeph>babysitter</codeph></li>
<li><codeph>couchdb</codeph></li>
<li><codeph>debug</codeph></li>
<li><codeph>error</codeph></li>
<li><codeph>info</codeph></li>
<li><codeph>mapreduce_errors</codeph></li>
<li><codeph>ssl_proxy</codeph></li>
<li><codeph>stats</codeph></li>
<li><codeph>view</codeph></li>
<li><codeph>xdcr</codeph></li>
<li><codeph>xdcr_errors</codeph></li>
</ul></entry>
</row>
<row>
<entry>POST</entry>
<entry><filepath>/logClientError</filepath></entry>
<entry>Adds entries to the central log from a custom Couchbase Server SDK.</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>User endpoints</title>
<tgroup cols="4">
<colspec colname="col1" colwidth="1*"/>
<colspec colname="col2" colwidth="3*"/>
<colspec colname="col3" colwidth="3*"/>
<colspec colname="col4" colwidth="3*"/>
<thead>
<row>
<entry>HTTP method</entry>
<entry>URI path</entry>
<entry>Description</entry>
<entry>Parameters</entry>
</row>
</thead>
<tbody>
<row>
<entry>POST </entry>
<entry><filepath>/settings/readOnlyUser</filepath></entry>
<entry>Creates the read-only user</entry>
<entry><varname>username</varname>, <varname>password</varname>,
<codeph>just_validate</codeph></entry>
</row>
<row>
<entry>PUT </entry>
<entry><filepath>/settings/readOnlyUser</filepath></entry>
<entry>Changes the read-only user password</entry>
<entry><varname>password</varname></entry>
</row>
<row>
<entry>DELETE </entry>
<entry><filepath>/settings/readOnlyUser</filepath></entry>
<entry>Deletes the user</entry>
<entry>none</entry>
</row>
<row>
<entry>GET </entry>
<entry><filepath>/settings/readOnlyAdminName</filepath></entry>
<entry>Retrieves the read-only username</entry>
<entry>none</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>Security endpoints</title>
<tgroup cols="4">
<colspec colname="col1" colwidth="1*"/>
<colspec colname="col2" colwidth="3*"/>
<colspec colname="col3" colwidth="3*"/>
<colspec colname="col4" colwidth="3*"/>
<thead>
<row>
<entry>HTTP method</entry>
<entry>URI path</entry>
<entry>Description</entry>
<entry>Parameters</entry>
</row>
</thead>
<tbody>
<row>
<entry>GET </entry>
<entry><filepath>/pools/default/certificate</filepath></entry>
<entry>Returns the current cluster certificate.</entry>
<entry><codeph>type</codeph>, <codeph>pem</codeph>, <codeph>subject</codeph>,
<codeph>expires</codeph>, <codeph>warnings</codeph></entry>
</row>
<row>
<entry>POST </entry>
<entry><filepath>/controller/uploadClusterCA</filepath></entry>
<entry>Uploads a pem-encoded root certificate (cluster CA) to the cluster.</entry>
<entry>none</entry>
</row>
<row>
<entry>POST </entry>
<entry><filepath>/node/controller/reloadCertificate</filepath></entry>
<entry>Takes a certificate/key from the specified directory and applies them to the
node.</entry>
<entry><varname>password</varname>, <codeph>chain.pem</codeph>,
<codeph>pkey.pem</codeph></entry>
</row>
<row>
<entry>GET </entry>
<entry><filepath>/pools/default/certificate/node/<host:port></filepath></entry>
<entry>Retrieves the read-only username</entry>
<entry><varname>password</varname></entry>
</row>
</tbody>
</tgroup>
</table>
</section>
</refbody>
</reference>