forked from CUBRID/cubrid-webmanager
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathWebCA Server API.postman_collection.json
More file actions
1869 lines (1869 loc) · 108 KB
/
WebCA Server API.postman_collection.json
File metadata and controls
1869 lines (1869 loc) · 108 KB
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
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"info": {
"_postman_id": "4f9325eb-3c68-46d9-b32c-cf569513ff6d",
"name": "WebCA Server API",
"description": "Complete API collection for WebCA Server - Database and Broker management system",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "24029234",
"_collection_link": "https://www.postman.com/cms000-3299/cms-project/collection/24029234-4f9325eb-3c68-46d9-b32c-cf569513ff6d?action=share&source=collection_link&creator=24029234"
},
"item": [
{
"name": "Authentication",
"item": [
{
"name": "Login",
"event": [
{
"listen": "test",
"script": {
"exec": [
"if (pm.response.code === 200) {",
" var jsonData = pm.response.json();",
" pm.collectionVariables.set('jwt_token', jsonData.token);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"id\": \"user123\",\n \"password\": \"password123\"\n}"
},
"url": {
"raw": "{{base_url}}/auth/login",
"host": [
"{{base_url}}"
],
"path": [
"auth",
"login"
]
},
"description": "Authenticate user and get JWT token.\n\n**URI:**\n```\nPOST /auth/login\n```\n\n**Authentication:** Not required (Public endpoint)\n\n**Request Body:**\n```json\n{\n \"id\": \"user123\",\n \"password\": \"password123\"\n}\n```\n\n**Success Response (200 OK):**\n```json\n{\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\"\n}\n```\n\n**Error Response (401 Unauthorized):**\n```json\n{\n \"statusCode\": 401,\n \"message\": \"Invalid credentials\",\n \"error\": \"Unauthorized\"\n}\n```\n\n**Note:** This endpoint automatically saves the token to the collection variable `jwt_token` for use in other requests."
},
"response": []
},
{
"name": "Register",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"id\": \"newuser\",\n \"password\": \"newpassword123\"\n}"
},
"url": {
"raw": "{{base_url}}/auth/register",
"host": [
"{{base_url}}"
],
"path": [
"auth",
"register"
]
},
"description": "Register a new user account.\n\n**URI:**\n```\nPOST /auth/register\n```\n\n**Authentication:** Not required (Public endpoint)\n\n**Request Body:**\n```json\n{\n \"id\": \"newuser\",\n \"password\": \"newpassword123\"\n}\n```\n\n**Success Response (200 OK):**\n- Status: `200 OK`\n- Body: No content\n\n**Error Response (400 Bad Request):**\n```json\n{\n \"statusCode\": 400,\n \"message\": \"User already exists\",\n \"error\": \"Bad Request\"\n}\n```"
},
"response": []
}
],
"description": "Authentication endpoints. All endpoints are public and do not require JWT authentication."
},
{
"name": "User",
"item": [
{
"name": "Get User Data",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{base_url}}/user",
"host": [
"{{base_url}}"
],
"path": [
"user"
]
},
"description": "Get current user information.\n\n**URI:**\n```\nGET /user\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\n```\n\n**Success Response (200 OK):**\n```json\n{\n \"id\": \"user123\",\n \"department\": \"IT\",\n \"host_list\": {},\n \"ha_mon_list\": {},\n \"resource_mon_list\": {},\n \"user_preference\": {}\n}\n```\n\n**Error Response (401 Unauthorized):**\n```json\n{\n \"statusCode\": 401,\n \"message\": \"Unauthorized\",\n \"error\": \"Unauthorized\"\n}\n```"
},
"response": []
},
{
"name": "Get User Preferences",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{base_url}}/user/preferences",
"host": [
"{{base_url}}"
],
"path": [
"user",
"preferences"
]
},
"description": "Get current user preferences.\n\n**URI:**\n```\nGET /user/preferences\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\n```\n\n**Success Response (200 OK):**\n```json\n{\n \"dashboardInterval\": 10,\n \"brokerStatusInterval\": 20\n}\n```\n\n**Error Response (401 Unauthorized):**\n```json\n{\n \"statusCode\": 401,\n \"message\": \"Unauthorized\",\n \"error\": \"Unauthorized\"\n}\n```"
},
"response": []
},
{
"name": "Update User Preferences",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"dashboardInterval\": 20,\n \"brokerStatusInterval\": 30\n}"
},
"url": {
"raw": "{{base_url}}/user/preferences",
"host": [
"{{base_url}}"
],
"path": [
"user",
"preferences"
]
},
"description": "Update user preferences.\n\n**URI:**\n```\nPUT /user/preferences\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\nContent-Type: application/json\n```\n\n**Request Body:**\n```json\n{\n \"dashboardInterval\": 20,\n \"brokerStatusInterval\": 30\n}\n```\n\n**Success Response (200 OK):**\n- Status: `200 OK`\n- Body: No content\n\n**Error Response (400 Bad Request):**\n```json\n{\n \"statusCode\": 400,\n \"message\": \"Invalid preference value\",\n \"error\": \"Bad Request\"\n}\n```"
},
"response": []
},
{
"name": "Change Password",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"oldPassword\": \"old123\",\n \"newPassword\": \"new456\"\n}"
},
"url": {
"raw": "{{base_url}}/user/credential",
"host": [
"{{base_url}}"
],
"path": [
"user",
"credential"
]
},
"description": "Change user password.\n\n**URI:**\n```\nPOST /user/credential\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\n```\n\n**Request Body:**\n```json\n{\n \"oldPassword\": \"old123\",\n \"newPassword\": \"new456\"\n}\n```\n\n**Success Response (200 OK):**\n- Status: `200 OK`\n- Body: No content\n\n**Error Response (400 Bad Request):**\n```json\n{\n \"statusCode\": 400,\n \"message\": \"Old password is incorrect\",\n \"error\": \"Bad Request\"\n}\n```"
},
"response": []
},
{
"name": "Update User Account",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"department\": \"Engineering\"\n}"
},
"url": {
"raw": "{{base_url}}/user/account",
"host": [
"{{base_url}}"
],
"path": [
"user",
"account"
]
},
"description": "Update user information (department).\n\n**URI:**\n```\nPOST /user/account\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\nContent-Type: application/json\n```\n\n**Request Body:**\n```json\n{\n \"department\": \"Engineering\"\n}\n```\n\n**Success Response (200 OK):**\n- Status: `200 OK`\n- Body: No content\n\n**Error Response (400 Bad Request):**\n```json\n{\n \"statusCode\": 400,\n \"message\": \"Invalid field value\",\n \"error\": \"Bad Request\"\n}\n```"
},
"response": []
},
{
"name": "Delete User Account",
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "{{base_url}}/user/account",
"host": [
"{{base_url}}"
],
"path": [
"user",
"account"
]
},
"description": "Delete user account permanently.\n\n**URI:**\n```\nDELETE /user/account\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\n```\n\n**Success Response (200 OK):**\n```json\ntrue\n```\n\n**Error Response (401 Unauthorized):**\n```json\n{\n \"statusCode\": 401,\n \"message\": \"Unauthorized\",\n \"error\": \"Unauthorized\"\n}\n```"
},
"response": []
}
],
"description": "User management endpoints. All endpoints require JWT authentication."
},
{
"name": "Host",
"item": [
{
"name": "Get All Hosts",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{base_url}}/host",
"host": [
"{{base_url}}"
],
"path": [
"host"
]
},
"description": "Get all hosts for the authenticated user.\n\n**URI:**\n```\nGET /host\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\n```\n\n**Success Response (200 OK):**\n```json\n{\n \"host_list\": {\n \"host-uid-1\": {\n \"uid\": \"host-uid-1\",\n \"id\": \"host1\",\n \"address\": \"192.168.1.100\",\n \"port\": 8001,\n \"alias\": \"Production Server\"\n },\n \"host-uid-2\": {\n \"uid\": \"host-uid-2\",\n \"id\": \"host2\",\n \"address\": \"192.168.1.101\",\n \"port\": 8001,\n \"alias\": \"Development Server\"\n }\n }\n}\n```\n\n**Error Response (401 Unauthorized):**\n```json\n{\n \"statusCode\": 401,\n \"message\": \"Unauthorized\",\n \"error\": \"Unauthorized\"\n}\n```"
},
"response": []
},
{
"name": "Add Host",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"id\": \"newhost\",\n \"address\": \"192.168.1.102\",\n \"port\": 8001,\n \"password\": \"hostpassword\",\n \"alias\": \"Test Server\"\n}"
},
"url": {
"raw": "{{base_url}}/host",
"host": [
"{{base_url}}"
],
"path": [
"host"
]
},
"description": "Add a new host to user's host list.\n\n**URI:**\n```\nPOST /host\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\n```\n\n**Request Body:**\n```json\n{\n \"id\": \"newhost\",\n \"address\": \"192.168.1.102\",\n \"port\": 8001,\n \"password\": \"hostpassword\",\n \"alias\": \"Test Server\"\n}\n```\n\n**Success Response (200 OK):**\n```json\n{\n \"host_list\": {\n \"host-uid-1\": {\n \"uid\": \"host-uid-1\",\n \"id\": \"host1\",\n \"address\": \"192.168.1.100\",\n \"port\": 8001,\n \"alias\": \"Production Server\"\n },\n \"new-host-uid\": {\n \"uid\": \"new-host-uid\",\n \"id\": \"newhost\",\n \"address\": \"192.168.1.102\",\n \"port\": 8001,\n \"alias\": \"Test Server\"\n }\n }\n}\n```\n\n**Error Response (400 Bad Request):**\n```json\n{\n \"statusCode\": 400,\n \"message\": \"Invalid host information\",\n \"error\": \"Bad Request\"\n}\n```"
},
"response": []
},
{
"name": "Get Host by UID",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{base_url}}/host/{{hostUid}}",
"host": [
"{{base_url}}"
],
"path": [
"host",
"{{hostUid}}"
]
},
"description": "Get specific host information by hostUid.\n\n**URI:**\n```\nGET /host/:hostUid\n```\n**Example:**\n```\nGET /host/host-uid-1\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\n```\n\n**Path Parameters:**\n- `hostUid` - Host unique identifier\n\n**Success Response (200 OK):**\n```json\n{\n \"uid\": \"host-uid-1\",\n \"id\": \"host1\",\n \"address\": \"192.168.1.100\",\n \"port\": 8001,\n \"alias\": \"Production Server\"\n}\n```\n\n**Error Response (404 Not Found):**\n```json\n{\n \"statusCode\": 404,\n \"message\": \"Host not found\",\n \"error\": \"Not Found\"\n}\n```"
},
"response": []
},
{
"name": "Update Host",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Updated Host Name\",\n \"address\": \"192.168.1.200\",\n \"port\": 8002,\n \"alias\": \"Updated Alias\"\n}"
},
"url": {
"raw": "{{base_url}}/host/{{hostUid}}",
"host": [
"{{base_url}}"
],
"path": [
"host",
"{{hostUid}}"
]
},
"description": "Update host information.\n\n**URI:**\n```\nPUT /host/:hostUid\n```\n**Example:**\n```\nPUT /host/host-uid-1\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\n```\n\n**Path Parameters:**\n- `hostUid` - Host unique identifier\n\n**Request Body:**\n```json\n{\n \"name\": \"Updated Host Name\",\n \"address\": \"192.168.1.200\",\n \"port\": 8002,\n \"alias\": \"Updated Alias\"\n}\n```\n\n**Success Response (200 OK):**\n```json\n{\n \"host_list\": {\n \"host-uid-1\": {\n \"uid\": \"host-uid-1\",\n \"id\": \"host1\",\n \"address\": \"192.168.1.200\",\n \"port\": 8002,\n \"alias\": \"Updated Alias\"\n }\n }\n}\n```\n\n**Error Response (404 Not Found):**\n```json\n{\n \"statusCode\": 404,\n \"message\": \"Host not found\",\n \"error\": \"Not Found\"\n}\n```"
},
"response": []
},
{
"name": "Delete Host",
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "{{base_url}}/host/{{hostUid}}",
"host": [
"{{base_url}}"
],
"path": [
"host",
"{{hostUid}}"
]
},
"description": "Delete a host and return updated host list.\n\n**URI:**\n```\nDELETE /host/:hostUid\n```\n**Example:**\n```\nDELETE /host/host-uid-1\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\n```\n\n**Path Parameters:**\n- `hostUid` - Host unique identifier\n\n**Success Response (200 OK):**\n```json\n{\n \"host_list\": {\n \"host-uid-2\": {\n \"uid\": \"host-uid-2\",\n \"id\": \"host2\",\n \"address\": \"192.168.1.101\",\n \"port\": 8001,\n \"alias\": \"Development Server\"\n }\n }\n}\n```\n\n**Error Response (404 Not Found):**\n```json\n{\n \"statusCode\": 404,\n \"message\": \"Host not found\",\n \"error\": \"Not Found\"\n}\n```"
},
"response": []
}
],
"description": "Host management endpoints. All endpoints require JWT authentication."
},
{
"name": "Database",
"item": [
{
"name": "Get Database Start Info",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{base_url}}/{{hostUid}}/database/start-info",
"host": [
"{{base_url}}"
],
"path": [
"{{hostUid}}",
"database",
"start-info"
]
},
"description": "Get database start information for a host. Returns only domain data (BaseCmsResponse fields stripped out).\n\n**URI:**\n```\nGET /:hostUid/database/start-info\n```\n**Example:**\n```\nGET /host-uid-1/database/start-info\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\n```\n\n**Path Parameters:**\n- `hostUid` - Host unique identifier\n\n**Success Response (200 OK):**\n```json\n{\n \"activelist\": {\n \"active\": [\n {\n \"dbname\": \"demodb\"\n },\n {\n \"dbname\": \"testdb\"\n }\n ]\n },\n \"dblist\": {\n \"dbs\": [\n {\n \"dbdir\": \"/home/cubrid/databases/demodb\",\n \"dbname\": \"demodb\",\n \"isProfileExists\": true\n },\n {\n \"dbdir\": \"/home/cubrid/databases/testdb\",\n \"dbname\": \"testdb\",\n \"isProfileExists\": false\n }\n ]\n }\n}\n```\n\n**Error Response (404 Not Found):**\n```json\n{\n \"statusCode\": 404,\n \"message\": \"Host not found\",\n \"error\": \"Not Found\"\n}\n```"
},
"response": []
},
{
"name": "Start Database",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{base_url}}/{{hostUid}}/database/start/{{dbname}}",
"host": [
"{{base_url}}"
],
"path": [
"{{hostUid}}",
"database",
"start",
"{{dbname}}"
]
},
"description": "Start a database on a host. Returns latest start information on success.\n\n**URI:**\n```\nPOST /:hostUid/database/start/:dbname\n```\n**Example:**\n```\nPOST /host-uid-1/database/start/demodb\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\n```\n\n**Path Parameters:**\n- `hostUid` - Host unique identifier\n- `dbname` - Database name\n\n**Success Response (200 OK):**\n```json\n{\n \"activelist\": {\n \"active\": [\n {\n \"dbname\": \"demodb\"\n }\n ]\n },\n \"dblist\": {\n \"dbs\": [\n {\n \"dbdir\": \"/home/cubrid/databases/demodb\",\n \"dbname\": \"demodb\",\n \"isProfileExists\": true\n }\n ]\n }\n}\n```\n\n**Error Response (500 Internal Server Error):**\n```json\n{\n \"statusCode\": 500,\n \"message\": \"Failed to start database\",\n \"error\": \"Internal Server Error\"\n}\n```"
},
"response": []
},
{
"name": "Stop Database",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{base_url}}/{{hostUid}}/database/stop/{{dbname}}",
"host": [
"{{base_url}}"
],
"path": [
"{{hostUid}}",
"database",
"stop",
"{{dbname}}"
]
},
"description": "Stop a database on a host. Returns latest start information on success.\n\n**URI:**\n```\nPOST /:hostUid/database/stop/:dbname\n```\n**Example:**\n```\nPOST /host-uid-1/database/stop/demodb\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\n```\n\n**Path Parameters:**\n- `hostUid` - Host unique identifier\n- `dbname` - Database name\n\n**Success Response (200 OK):**\n```json\n{\n \"activelist\": {\n \"active\": []\n },\n \"dblist\": {\n \"dbs\": [\n {\n \"dbdir\": \"/home/cubrid/databases/demodb\",\n \"dbname\": \"demodb\",\n \"isProfileExists\": true\n }\n ]\n }\n}\n```\n\n**Error Response (500 Internal Server Error):**\n```json\n{\n \"statusCode\": 500,\n \"message\": \"Failed to stop database\",\n \"error\": \"Internal Server Error\"\n}\n```"
},
"response": []
},
{
"name": "Restart Database",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{base_url}}/{{hostUid}}/database/restart/{{dbname}}",
"host": [
"{{base_url}}"
],
"path": [
"{{hostUid}}",
"database",
"restart",
"{{dbname}}"
]
},
"description": "Restart a database on a host (stop → start sequence). Returns latest start information on success.\n\n**URI:**\n```\nPOST /:hostUid/database/restart/:dbname\n```\n**Example:**\n```\nPOST /host-uid-1/database/restart/demodb\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\n```\n\n**Path Parameters:**\n- `hostUid` - Host unique identifier\n- `dbname` - Database name\n\n**Success Response (200 OK):**\n```json\n{\n \"activelist\": {\n \"active\": [\n {\n \"dbname\": \"demodb\"\n }\n ]\n },\n \"dblist\": {\n \"dbs\": [\n {\n \"dbdir\": \"/home/cubrid/databases/demodb\",\n \"dbname\": \"demodb\",\n \"isProfileExists\": true\n }\n ]\n }\n}\n```\n\n**Error Response (500 Internal Server Error):**\n```json\n{\n \"statusCode\": 500,\n \"message\": \"Failed to restart database\",\n \"error\": \"Internal Server Error\"\n}\n```"
},
"response": []
},
{
"name": "Register Database Profile",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"id\": \"dba\",\n \"password\": \"dbapassword\"\n}"
},
"url": {
"raw": "{{base_url}}/{{hostUid}}/database/register/{{dbname}}",
"host": [
"{{base_url}}"
],
"path": [
"{{hostUid}}",
"database",
"register",
"{{dbname}}"
]
},
"description": "Save a database profile for a host. Returns latest start information with updated `isProfileExists` field.\n\n**URI:**\n```\nPOST /:hostUid/database/register/:dbname\n```\n**Example:**\n```\nPOST /host-uid-1/database/register/demodb\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\n```\n\n**Path Parameters:**\n- `hostUid` - Host unique identifier\n- `dbname` - Database name\n\n**Request Body:**\n```json\n{\n \"id\": \"dba\",\n \"password\": \"dbapassword\"\n}\n```\n\n**Success Response (200 OK):**\n```json\n{\n \"activelist\": {\n \"active\": []\n },\n \"dblist\": {\n \"dbs\": [\n {\n \"dbdir\": \"/home/cubrid/databases/demodb\",\n \"dbname\": \"demodb\",\n \"isProfileExists\": true\n }\n ]\n }\n}\n```\n\n**Error Response (400 Bad Request):**\n```json\n{\n \"statusCode\": 400,\n \"message\": \"Invalid credentials\",\n \"error\": \"Bad Request\"\n}\n```"
},
"response": []
},
{
"name": "Create Database",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"dbname\": \"testdb\",\n \"numpage\": \"1000\",\n \"pagesize\": \"16384\",\n \"logsize\": \"100\",\n \"logpagesize\": \"16384\",\n \"genvolpath\": \"/home/cubrid/databases/testdb\",\n \"logvolpath\": \"/home/cubrid/databases/testdb\",\n \"charset\": \"ko_KR.utf8\",\n \"overwrite_config_file\": \"YES\",\n \"username\": \"dba\",\n \"updateUser\": {\n \"userpass\": \"password123\"\n },\n \"setAutoAddVol\": {\n \"data\": \"ON\",\n \"data_warn_outofspace\": \"0.15\",\n \"data_ext_page\": \"32768\",\n \"index\": \"ON\",\n \"index_warn_outofspace\": \"0.15\",\n \"index_ext_page\": \"32768\"\n },\n \"setAutoStart\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{base_url}}/{{hostUid}}/database/create",
"host": [
"{{base_url}}"
],
"path": [
"{{hostUid}}",
"database",
"create"
]
},
"description": "Create a new database with optional configuration. Executes database creation, user update, auto-add volume, and auto-start in sequence. Returns results from all executed operations with success/error status.\n\n**URI:**\n```\nPOST /:hostUid/database/create\n```\n**Example:**\n```\nPOST /host-uid-1/database/create\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\nContent-Type: application/json\n```\n\n**Path Parameters:**\n- `hostUid` - Host unique identifier\n\n**Request Body (Required Fields):**\n```json\n{\n \"dbname\": \"testdb\",\n \"numpage\": \"1000\",\n \"pagesize\": \"16384\",\n \"logsize\": \"100\",\n \"logpagesize\": \"16384\",\n \"genvolpath\": \"/home/cubrid/databases/testdb\",\n \"logvolpath\": \"/home/cubrid/databases/testdb\",\n \"charset\": \"ko_KR.utf8\",\n \"overwrite_config_file\": \"YES\"\n}\n```\n\n**Request Body (With Optional Configuration - Simplified):**\n```json\n{\n \"dbname\": \"testdb\",\n \"numpage\": \"1000\",\n \"pagesize\": \"16384\",\n \"logsize\": \"100\",\n \"logpagesize\": \"16384\",\n \"genvolpath\": \"/home/cubrid/databases/testdb\",\n \"logvolpath\": \"/home/cubrid/databases/testdb\",\n \"charset\": \"ko_KR.utf8\",\n \"overwrite_config_file\": \"YES\",\n \"username\": \"dba\",\n \"updateUser\": {\n \"userpass\": \"password123\"\n },\n \"setAutoAddVol\": {\n \"data\": \"ON\",\n \"data_warn_outofspace\": \"0.15\",\n \"data_ext_page\": \"32768\",\n \"index\": \"ON\",\n \"index_warn_outofspace\": \"0.15\",\n \"index_ext_page\": \"32768\"\n },\n \"setAutoStart\": true\n}\n```\n\n**Simplified Configuration Notes:**\n- `dbname`: Automatically reused for all operations (updateUser, setAutoStart)\n- `username`: Optional, defaults to \"dba\" if not provided (used for updateUser)\n- `updateUser`: Only requires `userpass` - uses top-level `dbname` and `username`\n- `setAutoStart`: Boolean value - automatically uses top-level `dbname` and \"cubridconf\" as confname\n\n\n**Request Body (With Extended Volumes):**\n```json\n{\n \"dbname\": \"testdb\",\n \"numpage\": \"1000\",\n \"pagesize\": \"16384\",\n \"logsize\": \"100\",\n \"logpagesize\": \"16384\",\n \"genvolpath\": \"/home/cubrid/databases/testdb\",\n \"logvolpath\": \"/home/cubrid/databases/testdb\",\n \"charset\": \"ko_KR.utf8\",\n \"overwrite_config_file\": \"YES\",\n \"exvol\": [\n {\n \"testdb_data_x001\": {\n \"type\": \"data\",\n \"size\": 512,\n \"pagesize\": 16384,\n \"volpath\": \"/home/cubrid/databases/testdb\"\n },\n \"testdb_index_x001\": {\n \"type\": \"index\",\n \"size\": 256,\n \"pagesize\": 16384,\n \"volpath\": \"/home/cubrid/databases/testdb\"\n }\n }\n ]\n}\n```\n\n**Success Response (200 OK - All Operations Succeeded):**\n```json\n{\n \"createDatabase\": {\n \"success\": true,\n \"data\": {}\n },\n \"updateUser\": {\n \"success\": true,\n \"data\": {}\n },\n \"setAutoAddVol\": {\n \"success\": true,\n \"data\": {}\n },\n \"setAutoStart\": {\n \"success\": true,\n \"data\": {}\n }\n}\n```\n\n**Partial Success Response (200 OK - Some Operations Failed):**\n```json\n{\n \"createDatabase\": {\n \"success\": true,\n \"data\": {}\n },\n \"updateUser\": {\n \"success\": false,\n \"error\": {\n \"message\": \"User update failed\",\n \"code\": \"DATABASE_ERROR\",\n \"details\": {}\n }\n },\n \"setAutoAddVol\": {\n \"success\": true,\n \"data\": {}\n },\n \"setAutoStart\": {\n \"success\": false,\n \"error\": {\n \"message\": \"Database name already exists in server parameter\",\n \"code\": \"CONFIG_ERROR\",\n \"details\": {}\n }\n }\n}\n```\n\n**Error Response (400 Bad Request - Missing Fields):**\n```json\n{\n \"statusCode\": 400,\n \"message\": \"Missing required fields: dbname, numpage, pagesize, logsize, logpagesize, genvolpath, logvolpath, charset, overwrite_config_file\",\n \"error\": \"Bad Request\"\n}\n```\n\n**Error Response (400 Bad Request - Duplicated File):**\n```json\n{\n \"statusCode\": 400,\n \"message\": \"File already exists: /path/to/file\",\n \"error\": \"Bad Request\",\n \"existfile\": \"/path/to/file\"\n}\n```\n\n**Note:**\n- All optional configuration operations (`updateUser`, `setAutoAddVol`, `setAutoStart`) are executed sequentially after database creation.\n- Each operation is independent - if one fails, others will still be attempted.\n- The response contains success/error status for each operation, allowing partial success scenarios."
},
"response": []
},
{
"name": "Get Database Volume Info",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{base_url}}/{{hostUid}}/database/volume-info/{{dbname}}",
"host": [
"{{base_url}}"
],
"path": [
"{{hostUid}}",
"database",
"volume-info",
"{{dbname}}"
]
},
"description": "Get database volume/space information for a database on a host. Returns domain-only data (CMS envelope removed).\n\n**URI:**\n```\nGET /:hostUid/database/volume-info/:dbname\n```\n**Example:**\n```\nGET /host-uid-1/database/volume-info/demodb\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\n```\n\n**Path Parameters:**\n- `hostUid` - Host unique identifier\n- `dbname` - Database name\n\n**Success Response (200 OK):**\n```json\n{\n \"dbname\": \"demodb\",\n \"pagesize\": \"16384\",\n \"logpagesize\": \"16384\",\n \"freespace\": \"1048576\",\n \"dbinfo\": [\n {\n \"type\": \"data\",\n \"purpose\": \"data\",\n \"total_size\": \"1073741824\",\n \"used_size\": \"536870912\",\n \"free_size\": \"536870912\",\n \"volume_count\": \"1\"\n }\n ],\n \"fileinfo\": [\n {\n \"data_type\": \"data\",\n \"total_size\": \"1073741824\",\n \"used_size\": \"536870912\",\n \"reserved_size\": \"536870912\",\n \"file_count\": \"1\",\n \"file_table_size\": \"1048576\"\n }\n ],\n \"spaceinfo\": [\n {\n \"spacename\": \"demodb\",\n \"type\": \"data\",\n \"location\": \"/home/cubrid/databases/demodb\",\n \"purpose\": \"data\",\n \"totalpage\": \"65536\",\n \"usedpage\": \"32768\",\n \"freepage\": \"32768\",\n \"volid\": \"0\"\n }\n ]\n}\n```\n\n**Error Response (404 Not Found):**\n```json\n{\n \"statusCode\": 404,\n \"message\": \"Database not found\",\n \"error\": \"Not Found\"\n}\n```"
},
"response": []
},
{
"name": "Add Backup Schedule",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"backupid\": \"test_backup\",\n \"path\": \"/path/to/backup\",\n \"period_type\": \"daily\",\n \"period_date\": \"1\",\n \"time\": \"02:00\",\n \"level\": \"0\"\n}"
},
"url": {
"raw": "{{base_url}}/{{hostUid}}/database/backup-schedule/{{dbname}}",
"host": [
"{{base_url}}"
],
"path": [
"{{hostUid}}",
"database",
"backup-schedule",
"{{dbname}}"
]
},
"description": "Add automated backup schedule information for a database. Returns empty object on success.\n\n**URI:**\n```\nPOST /:hostUid/database/backup-schedule/:dbname\n```\n**Example:**\n```\nPOST /host-uid-1/database/backup-schedule/demodb\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\nContent-Type: application/json\n```\n\n**Path Parameters:**\n- `hostUid` - Host unique identifier\n- `dbname` - Database name\n\n**Request Body:**\n```json\n{\n \"backupid\": \"test_backup\",\n \"path\": \"/path/to/backup\",\n \"period_type\": \"daily\",\n \"period_date\": \"1\",\n \"time\": \"02:00\",\n \"level\": \"0\"\n}\n```\n\n**Success Response (200 OK):**\n```json\n{}\n```\n\n**Error Response (400 Bad Request):**\n```json\n{\n \"statusCode\": 400,\n \"message\": \"Missing required fields\",\n \"error\": \"Bad Request\"\n}\n```"
},
"response": []
},
{
"name": "Set Backup Schedule",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"backupid\": \"t2\",\n \"path\": \"/path/to/backup\",\n \"period_type\": \"Monthly\",\n \"period_date\": \"11,12\",\n \"time\": \"0930\",\n \"level\": \"0\",\n \"archivedel\": \"ON\",\n \"updatestatus\": \"ON\",\n \"storeold\": \"ON\",\n \"onoff\": \"ON\",\n \"zip\": \"y\",\n \"check\": \"y\",\n \"mt\": \"0\",\n \"bknum\": \"0\"\n}"
},
"url": {
"raw": "{{base_url}}/{{hostUid}}/database/backup-schedule/{{dbname}}",
"host": [
"{{base_url}}"
],
"path": [
"{{hostUid}}",
"database",
"backup-schedule",
"{{dbname}}"
]
},
"description": "Set automated backup schedule information for a database. Returns response with execution details.\n\n**URI:**\n```\nPUT /:hostUid/database/backup-schedule/:dbname\n```\n**Example:**\n```\nPUT /host-uid-1/database/backup-schedule/demodb\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\nContent-Type: application/json\n```\n\n**Path Parameters:**\n- `hostUid` - Host unique identifier\n- `dbname` - Database name\n\n**Request Body:**\n```json\n{\n \"backupid\": \"t2\",\n \"path\": \"/path/to/backup\",\n \"period_type\": \"Monthly\",\n \"period_date\": \"11,12\",\n \"time\": \"0930\",\n \"level\": \"0\",\n \"archivedel\": \"ON\",\n \"updatestatus\": \"ON\",\n \"storeold\": \"ON\",\n \"onoff\": \"ON\",\n \"zip\": \"y\",\n \"check\": \"y\",\n \"mt\": \"0\",\n \"bknum\": \"0\"\n}\n```\n\n**Success Response (200 OK):**\n```json\n{\n \"__EXEC_TIME\": \"0 ms\",\n \"note\": \"none\",\n \"status\": \"success\",\n \"task\": \"setbackupinfo\"\n}\n```\n\n**Error Response (400 Bad Request):**\n```json\n{\n \"statusCode\": 400,\n \"message\": \"Missing required fields\",\n \"error\": \"Bad Request\"\n}\n```"
},
"response": []
},
{
"name": "Delete Backup Schedule",
"request": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"backupid\": \"t2\"\n}"
},
"url": {
"raw": "{{base_url}}/{{hostUid}}/database/backup-schedule/{{dbname}}",
"host": [
"{{base_url}}"
],
"path": [
"{{hostUid}}",
"database",
"backup-schedule",
"{{dbname}}"
]
},
"description": "Delete automated backup schedule information for a database. Returns response with execution details.\n\n**URI:**\n```\nDELETE /:hostUid/database/backup-schedule/:dbname\n```\n**Example:**\n```\nDELETE /host-uid-1/database/backup-schedule/demodb\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\nContent-Type: application/json\n```\n\n**Path Parameters:**\n- `hostUid` - Host unique identifier\n- `dbname` - Database name\n\n**Request Body:**\n```json\n{\n \"backupid\": \"t2\"\n}\n```\n\n**Success Response (200 OK):**\n```json\n{\n \"__EXEC_TIME\": \"0 ms\",\n \"note\": \"none\",\n \"status\": \"success\",\n \"task\": \"deletebackupinfo\"\n}\n```\n\n**Error Response (400 Bad Request):**\n```json\n{\n \"statusCode\": 400,\n \"message\": \"Missing required fields: backupid\",\n \"error\": \"Bad Request\"\n}\n```"
},
"response": []
},
{
"name": "Get Backup Schedule",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{base_url}}/{{hostUid}}/database/backup-schedule/{{dbname}}",
"host": [
"{{base_url}}"
],
"path": [
"{{hostUid}}",
"database",
"backup-schedule",
"{{dbname}}"
]
},
"description": "Get automated backup schedule information for a database. Returns domain-only data (CMS envelope removed).\n\n**URI:**\n```\nGET /:hostUid/database/backup-schedule/:dbname\n```\n**Example:**\n```\nGET /host-uid-1/database/backup-schedule/demodb\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\n```\n\n**Path Parameters:**\n- `hostUid` - Host unique identifier\n- `dbname` - Database name\n\n**Success Response (200 OK):**\n```json\n{\n \"dbname\": \"demodb\",\n \"backups\": [\n {\n \"backupid\": \"test_backup\",\n \"path\": \"/path/to/backup\",\n \"period_type\": \"daily\",\n \"period_date\": \"1\",\n \"time\": \"02:00\",\n \"level\": \"0\"\n }\n ]\n}\n```\n\n**Error Response (404 Not Found):**\n```json\n{\n \"statusCode\": 404,\n \"message\": \"Database not found\",\n \"error\": \"Not Found\"\n}\n```"
},
"response": []
},
{
"name": "Get Auto Backup DB Err Log",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{base_url}}/{{hostUid}}/database/auto-backup-db-err-log",
"host": [
"{{base_url}}"
],
"path": [
"{{hostUid}}",
"database",
"auto-backup-db-err-log"
]
},
"description": "Get auto-backup database error log. Returns domain-only data (CMS envelope removed).\n\n**URI:**\n```\nPOST /:hostUid/database/auto-backup-db-err-log\n```\n**Example:**\n```\nPOST /host-uid-1/database/auto-backup-db-err-log\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\nContent-Type: application/json\n```\n\n**Path Parameters:**\n- `hostUid` - Host unique identifier\n\n**Request Body:**\n```json\n{}\n```\n\n**Note:** Request body is an empty object. No fields are required.\n\n**Success Response (200 OK) - With Errors:**\n```json\n{\n \"error\": [\n {\n \"backupid\": \"test_backup\",\n \"dbname\": \"demodb\",\n \"error_desc\": \"backupdb(demodb): auto job start\",\n \"error_time\": \"2026/01/24 15:18:00\"\n },\n {\n \"backupid\": \"test_backup\",\n \"dbname\": \"demodb\",\n \"error_desc\": \"backupdb(demodb): success\",\n \"error_time\": \"2026/01/24 15:18:00\"\n }\n ]\n}\n```\n\n**Success Response (200 OK) - No Errors:**\n```json\n{\n \"error\": null\n}\n```\n\n**Response Field Descriptions:**\n- `error` - Array of error log entries (null if no errors)\n - `backupid` - Backup ID\n - `dbname` - Database name\n - `error_desc` - Error description\n - `error_time` - Error time\n\n**Error Response (404 Not Found):**\n```json\n{\n \"statusCode\": 404,\n \"message\": \"Host not found\",\n \"error\": \"Not Found\"\n}\n```\n\n**Error Response (500 Internal Server Error):**\n```json\n{\n \"statusCode\": 500,\n \"message\": \"Failed to get error log\",\n \"error\": \"Internal Server Error\"\n}\n```"
},
"response": []
},
{
"name": "Set Auto Exec Query",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"planlist\": [\n {\n \"queryplan\": []\n }\n ]\n}"
},
"url": {
"raw": "{{base_url}}/{{hostUid}}/database/auto-exec-query/{{dbname}}",
"host": [
"{{base_url}}"
],
"path": [
"{{hostUid}}",
"database",
"auto-exec-query",
"{{dbname}}"
]
},
"description": "Set auto-execution query for a database. Returns empty object on success.\n\n**URI:**\n\n```\nPOST /:hostUid/database/auto-exec-query/:dbname\n\n ```\n\n**Example:**\n\n```\nPOST /host-uid-1/database/auto-exec-query/demodb\n\n ```\n\n**Authentication:** Required \n**Headers:**\n\n```\nAuthorization: Bearer <JWT_TOKEN>\nContent-Type: application/json\n\n ```\n\n**Path Parameters:**\n\n- `hostUid` - Host unique identifier\n \n- `dbname` - Database name\n \n\n**Request Body:**\n\n``` json\n{\n \"planlist\": [\n {\n \"queryplan\": []\n }\n ]\n}\n\n ```\n\n**Success Response (200 OK):**\n\n``` json\n{}\n\n ```\n\n**Error Response (400 Bad Request):**\n\n``` json\n{\n \"statusCode\": 400,\n \"message\": \"Missing required fields: planlist\",\n \"error\": \"Bad Request\"\n}\n\n ```"
},
"response": []
},
{
"name": "Get Auto Exec Query",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{base_url}}/{{hostUid}}/database/auto-exec-query/{{dbname}}",
"host": [
"{{base_url}}"
],
"path": [
"{{hostUid}}",
"database",
"auto-exec-query",
"{{dbname}}"
]
},
"description": "Get auto-execution query for a database. Returns domain-only data (CMS envelope removed).\n\n**URI:**\n```\nGET /:hostUid/database/auto-exec-query/:dbname\n```\n**Example:**\n```\nGET /host-uid-1/database/auto-exec-query/demodb\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\n```\n\n**Path Parameters:**\n- `hostUid` - Host unique identifier\n- `dbname` - Database name\n\n**Success Response (200 OK):**\n```json\n{\n \"planlist\": [\n {\n \"queryplan\": []\n }\n ]\n}\n```\n\n**Error Response (404 Not Found):**\n```json\n{\n \"statusCode\": 404,\n \"message\": \"Database not found\",\n \"error\": \"Not Found\"\n}\n```"
},
"response": []
},
{
"name": "Get Auto Exec Query Err Log",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{base_url}}/{{hostUid}}/database/auto-exec-query-err-log",
"host": [
"{{base_url}}"
],
"path": [
"{{hostUid}}",
"database",
"auto-exec-query-err-log"
]
},
"description": "Get auto-execution query error log. Returns domain-only data (CMS envelope removed).\n\n**URI:**\n```\nPOST /:hostUid/database/auto-exec-query-err-log\n```\n**Example:**\n```\nPOST /host-uid-1/database/auto-exec-query-err-log\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\nContent-Type: application/json\n```\n\n**Path Parameters:**\n- `hostUid` - Host unique identifier\n\n**Request Body:**\n```json\n{}\n```\n\n**Note:** Request body is an empty object. No fields are required.\n\n**Success Response (200 OK) - With Errors:**\n```json\n{\n \"error\": [\n {\n \"@username\": \"admin\",\n \"dbname\": \"demodb\",\n \"error_code\": \"0\",\n \"error_desc\": \"start\",\n \"error_time\": \"2026/01/24 15:10:00\",\n \"query_id\": \"test_query\"\n },\n {\n \"@username\": \"admin\",\n \"dbname\": \"demodb\",\n \"error_code\": \"0\",\n \"error_desc\": \"success\",\n \"error_time\": \"2026/01/24 15:10:00\",\n \"query_id\": \"test_query\"\n }\n ]\n}\n```\n\n**Success Response (200 OK) - No Errors:**\n```json\n{\n \"error\": null\n}\n```\n\n**Response Field Descriptions:**\n- `error` - Array of error log entries (null if no errors)\n - `@username` - Username\n - `dbname` - Database name\n - `error_code` - Error code\n - `error_desc` - Error description\n - `error_time` - Error time\n - `query_id` - Query ID\n\n**Error Response (404 Not Found):**\n```json\n{\n \"statusCode\": 404,\n \"message\": \"Host not found\",\n \"error\": \"Not Found\"\n}\n```\n\n**Error Response (500 Internal Server Error):**\n```json\n{\n \"statusCode\": 500,\n \"message\": \"Failed to get error log\",\n \"error\": \"Internal Server Error\"\n}\n```"
},
"response": []
},
{
"name": "Set Auto Add Volume",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": \"ON\",\n \"data_warn_outofspace\": \"0.15\",\n \"data_ext_page\": \"32768\",\n \"index\": \"ON\",\n \"index_warn_outofspace\": \"0.15\",\n \"index_ext_page\": \"32768\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{base_url}}/{{hostUid}}/database/auto-add-vol/{{dbname}}",
"host": [
"{{base_url}}"
],
"path": [
"{{hostUid}}",
"database",
"auto-add-vol",
"{{dbname}}"
]
},
"description": "Set auto-add volume configuration for a database. Returns empty object on success.\n\n**URI:**\n```\nPOST /:hostUid/database/auto-add-vol/:dbname\n```\n**Example:**\n```\nPOST /host-uid-1/database/auto-add-vol/testdb\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\nContent-Type: application/json\n```\n\n**Path Parameters:**\n- `hostUid` - Host unique identifier\n- `dbname` - Database name\n\n**Request Body:**\n```json\n{\n \"data\": \"ON\",\n \"data_warn_outofspace\": \"0.15\",\n \"data_ext_page\": \"32768\",\n \"index\": \"ON\",\n \"index_warn_outofspace\": \"0.15\",\n \"index_ext_page\": \"32768\"\n}\n```\n\n**Success Response (200 OK):**\n```json\n{}\n```\n\n**Error Response (400 Bad Request):**\n```json\n{\n \"statusCode\": 400,\n \"message\": \"Missing required fields: data, data_warn_outofspace, data_ext_page, index, index_warn_outofspace, index_ext_page\",\n \"error\": \"Bad Request\"\n}\n```\n\n**Error Response (404 Not Found):**\n```json\n{\n \"statusCode\": 404,\n \"message\": \"Database not found\",\n \"error\": \"Not Found\"\n}\n```"
},
"response": []
},
{
"name": "Get Auto Add Volume",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{base_url}}/{{hostUid}}/database/auto-add-vol/{{dbname}}",
"host": ["{{base_url}}"],
"path": ["{{hostUid}}", "database", "auto-add-vol", "{{dbname}}"]
},
"description": "Get auto-add volume configuration for a database (CMS task: getautoaddvol). GET /:hostUid/database/auto-add-vol/:dbname. Success: data, data_ext_page, data_warn_outofspace, index, index_ext_page, index_warn_outofspace, note, execTime."
},
"response": []
},
{
"name": "Set Auto Start",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"confname\": \"cubridconf\",\n \"dbname\": \"testdb\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{base_url}}/{{hostUid}}/database/auto-start",
"host": [
"{{base_url}}"
],
"path": [
"{{hostUid}}",
"database",
"auto-start"
]
},
"description": "Enable auto-start for a database. Adds database name to the server parameter in configuration file. Returns empty object on success.\n\n**URI:**\n```\nPOST /:hostUid/database/auto-start\n```\n**Example:**\n```\nPOST /host-uid-1/database/auto-start\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\nContent-Type: application/json\n```\n\n**Path Parameters:**\n- `hostUid` - Host unique identifier\n\n**Request Body:**\n```json\n{\n \"confname\": \"cubridconf\",\n \"dbname\": \"testdb\"\n}\n```\n\n**Success Response (200 OK):**\n```json\n{}\n```\n\n**Error Response (400 Bad Request):**\n```json\n{\n \"statusCode\": 400,\n \"message\": \"Database name already exists in server parameter\",\n \"error\": \"Bad Request\"\n}\n```\n\n**Error Response (404 Not Found):**\n```json\n{\n \"statusCode\": 404,\n \"message\": \"Server parameter not found in configuration file\",\n \"error\": \"Not Found\"\n}\n```"
},
"response": []
},
{
"name": "Remove Auto Start",
"request": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"confname\": \"cubridconf\",\n \"dbname\": \"testdb\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{base_url}}/{{hostUid}}/database/auto-start",
"host": [
"{{base_url}}"
],
"path": [
"{{hostUid}}",
"database",
"auto-start"
]
},
"description": "Disable auto-start for a database. Removes database name from the server parameter in configuration file. Returns empty object on success.\n\n**URI:**\n```\nDELETE /:hostUid/database/auto-start\n```\n**Example:**\n```\nDELETE /host-uid-1/database/auto-start\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\nContent-Type: application/json\n```\n\n**Path Parameters:**\n- `hostUid` - Host unique identifier\n\n**Request Body:**\n```json\n{\n \"confname\": \"cubridconf\",\n \"dbname\": \"testdb\"\n}\n```\n\n**Success Response (200 OK):**\n```json\n{}\n```\n\n**Error Response (400 Bad Request):**\n```json\n{\n \"statusCode\": 400,\n \"message\": \"Database name not found in server parameter\",\n \"error\": \"Bad Request\"\n}\n```\n\n**Error Response (404 Not Found):**\n```json\n{\n \"statusCode\": 404,\n \"message\": \"Server parameter not found in configuration file\",\n \"error\": \"Not Found\"\n}\n```"
},
"response": []
},
{
"name": "Unload Database",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"targetdir\": \"/path/to/backup\",\n \"isSchemaIncluded\": true,\n \"isDataIncluded\": true,\n \"dbuser\": \"dba\",\n \"dbpasswd\": \"dbapassword\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{base_url}}/{{hostUid}}/database/unload/{{dbname}}",
"host": [
"{{base_url}}"
],
"path": [
"{{hostUid}}",
"database",
"unload",
"{{dbname}}"
]
},
"description": "Unload a database. Returns empty object on success.\n\n**URI:**\n```\nPOST /:hostUid/database/unload/:dbname\n```\n**Example:**\n```\nPOST /host-uid-1/database/unload/demodb\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\nContent-Type: application/json\n```\n\n**Path Parameters:**\n- `hostUid` - Host unique identifier\n- `dbname` - Database name\n\n**Request Body (Required Fields):**\n```json\n{\n \"targetdir\": \"/path/to/backup\",\n \"isSchemaIncluded\": true,\n \"isDataIncluded\": true,\n \"dbuser\": \"dba\",\n \"dbpasswd\": \"dbapassword\"\n}\n```\n\n**Request Body (With Optional Fields):**\n```json\n{\n \"targetdir\": \"/path/to/backup\",\n \"isSchemaIncluded\": true,\n \"isDataIncluded\": true,\n \"dbuser\": \"dba\",\n \"dbpasswd\": \"dbapassword\",\n \"usehash\": \"yes\",\n \"hashdir\": \"/path/to/hash\",\n \"class\": [\n {\n \"classname\": \"test\"\n }\n ],\n \"ref\": \"yes\",\n \"classonly\": \"yes\",\n \"as-dba\": \"yes\",\n \"skip-index-detail\": \"yes\",\n \"split-schema-files\": \"yes\",\n \"delimit\": \"yes\",\n \"estimate\": \"1000\",\n \"prefix\": \"backup\",\n \"cach\": \"100\",\n \"lofile\": \"10\"\n}\n```\n\n**Target Determination:**\n- Both `isSchemaIncluded` and `isDataIncluded` are `true` → `target: \"both\"`\n- Only `isSchemaIncluded` is `true` → `target: \"schema\"`\n- Only `isDataIncluded` is `true` → `target: \"object\"`\n- Both are `false` → Error: `InvalidParameter`\n\n**Success Response (200 OK):**\n```json\n{}\n```\n\n**Error Response (400 Bad Request):**\n```json\n{\n \"statusCode\": 400,\n \"message\": \"Both isSchemaIncluded and isDataIncluded cannot be false\",\n \"error\": \"Bad Request\"\n}\n```\n\n**Error Response (400 Bad Request - Missing Fields):**\n```json\n{\n \"statusCode\": 400,\n \"message\": \"Missing required fields: targetdir, isSchemaIncluded, isDataIncluded, dbuser, dbpasswd\",\n \"error\": \"Bad Request\"\n}\n```"
},
"response": []
},
{
"name": "Get Unload Info",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{base_url}}/{{hostUid}}/database/unload-info",
"host": [
"{{base_url}}"
],
"path": [
"{{hostUid}}",
"database",
"unload-info"
]
},
"description": "Get unload information for databases on a host. Returns domain-only data (CMS envelope removed).\n\n**URI:**\n```\nGET /:hostUid/database/unload-info\n```\n**Example:**\n```\nGET /host-uid-1/database/unload-info\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\n```\n\n**Path Parameters:**\n- `hostUid` - Host unique identifier\n\n**Success Response (200 OK):**\n```json\n{\n \"database\": [\n {\n \"dbname\": \"test4\",\n \"object\": \"/home/cubrid/CUBRID-11.4.4.1832-7f8f019-Linux.x86_64/databases/test4/test4_objects;2026.01.27 12:17\",\n \"schema\": \"/home/cubrid/CUBRID-11.4.4.1832-7f8f019-Linux.x86_64/databases/test4/test4_schema;2026.01.27 12:17\"\n },\n {\n \"dbname\": \"demodb\",\n \"object\": \"/home/cubrid/CUBRID-11.4.4.1832-7f8f019-Linux.x86_64/databases/demodb/demodb_objects;2026.01.27 12:02\",\n \"schema\": \"/home/cubrid/CUBRID-11.4.4.1832-7f8f019-Linux.x86_64/databases/demodb/demodb_schema;2026.01.27 12:02\"\n }\n ]\n}\n```\n\n**Response Fields:**\n- `database` - Array of database unload information\n - `dbname` - Database name\n - `object` - Object file path with timestamp\n - `schema` - Schema file path with timestamp\n\n**Error Response (404 Not Found):**\n```json\n{\n \"statusCode\": 404,\n \"message\": \"Host not found\",\n \"error\": \"Not Found\"\n}\n```\n\n**Error Response (500 Internal Server Error):**\n```json\n{\n \"statusCode\": 500,\n \"message\": \"Failed to get unload information\",\n \"error\": \"Internal Server Error\"\n}\n```"
},
"response": []
},
{
"name": "Check Database",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"repairdb\": \"n\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{base_url}}/{{hostUid}}/database/check/{{dbname}}",
"host": [
"{{base_url}}"
],
"path": [
"{{hostUid}}",
"database",
"check",
"{{dbname}}"
]
},
"description": "Check a database. Returns empty object on success.\n\n**URI:**\n```\nPOST /:hostUid/database/check/:dbname\n```\n**Example:**\n```\nPOST /host-uid-1/database/check/test\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\nContent-Type: application/json\n```\n\n**Path Parameters:**\n- `hostUid` - Host unique identifier\n- `dbname` - Database name\n\n**Request Body (Required Fields):**\n```json\n{\n \"repairdb\": \"n\"\n}\n```\n\n**Request Body Field Descriptions:**\n- `repairdb` - Repair option (`y` = check and repair, `n` = check only)\n\n**Success Response (200 OK):**\n```json\n{}\n```\n\n**Error Response (400 Bad Request):**\n```json\n{\n \"statusCode\": 400,\n \"message\": \"Missing required fields: repairdb\",\n \"error\": \"Bad Request\"\n}\n```\n\n**Error Response (404 Not Found):**\n```json\n{\n \"statusCode\": 404,\n \"message\": \"Database not found\",\n \"error\": \"Not Found\"\n}\n```\n\n**Error Response (500 Internal Server Error):**\n```json\n{\n \"statusCode\": 500,\n \"message\": \"Failed to check database\",\n \"error\": \"Internal Server Error\"\n}\n```"
},
"response": []
},
{
"name": "Lock Database",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{base_url}}/{{hostUid}}/database/lock/{{dbname}}",
"host": [
"{{base_url}}"
],
"path": [
"{{hostUid}}",
"database",
"lock",
"{{dbname}}"
]
},
"description": "Get lock information for a database. Returns lock information including lock entries, transactions, and lock statistics.\n\n**URI:**\n```\nPOST /:hostUid/database/lock/:dbname\n```\n**Example:**\n```\nPOST /host-uid-1/database/lock/demodb\n```\n\n**Authentication:** Required\n**Headers:**\n```\nAuthorization: Bearer <JWT_TOKEN>\nContent-Type: application/json\n```\n\n**Path Parameters:**\n- `hostUid` - Host unique identifier\n- `dbname` - Database name\n\n**Request Body:**\n```json\n{}\n```\n\n**Note:** Request body is an empty object. No fields are required.\n\n**Success Response (200 OK):**\n```json\n{\n \"lockinfo\": [\n {\n \"dinterval\": \"1.00\",\n \"esc\": \"100000\",\n \"lot\": [\n {\n \"entry\": [\n {\n \"lock_holders\": [\n {\n \"count\": \"1\",\n \"granted_mode\": \"IS_LOCK\",\n \"nsubgranules\": \"0\",\n \"tran_index\": \"1\"\n }\n ],\n \"num_b_holders\": \"0\",\n \"num_holders\": \"1\",\n \"num_waiters\": \"0\",\n \"ob_type\": \"Class = code\",\n \"oid\": \"0|201|-32763\"\n }\n ],\n \"maxnumlock\": \"10000\",\n \"numlocked\": \"6\"\n }\n ],\n \"transaction\": [\n {\n \"@uid\": \"DBA\",\n \"host\": \"lgj1089-36\",\n \"index\": \"1\",\n \"isolevel\": \"COMMITTED READ\",\n \"pid\": \"44371\",\n \"pname\": \"csql\",\n \"timeout\": \":\"\n }\n ]\n }\n ]\n}\n```\n\n**Response Field Descriptions:**\n- `lockinfo` - Array of lock information objects\n - `dinterval` - Deadlock interval\n - `esc` - ESC (Escalation) value\n - `lot` - Lock object table array\n - `entry` - Array of lock entries\n - `lock_holders` (optional) - Array of lock holder information (only present when lock is held)\n - `count` - Count\n - `granted_mode` - Granted mode (e.g., \"IS_LOCK\", \"IX_LOCK\")\n - `nsubgranules` - Number of sub-granules\n - `tran_index` - Transaction index\n - `num_b_holders` - Number of B holders (may be \"missing\" or numeric string)\n - `num_holders` - Number of holders (may be \"inser\" or numeric string)\n - `num_waiters` - Number of waiters (may be \"=\" or numeric string)\n - `ob_type` - Object type\n - `oid` - Object ID\n - `maxnumlock` - Maximum number of locks\n - `numallocated` (optional) - Number of allocated locks (may not be present)\n - `numlocked` - Number of locked objects\n - `sizelock` (optional) - Size of lock (may not be present)\n - `transaction` - Array of transaction information\n - `@uid` - User ID\n - `host` - Host name\n - `index` - Transaction index\n - `isolevel` - Isolation level\n - `pid` - Process ID\n - `pname` - Process name\n - `timeout` - Timeout\n\n**Error Response (404 Not Found):**\n```json\n{\n \"statusCode\": 404,\n \"message\": \"Host not found\",\n \"error\": \"Not Found\"\n}\n```\n\n**Error Response (500 Internal Server Error):**\n```json\n{\n \"statusCode\": 500,\n \"message\": \"Failed to get lock information\",\n \"error\": \"Internal Server Error\"\n}\n```"
},
"response": []
},
{
"name": "Get Transaction Info",