-
Notifications
You must be signed in to change notification settings - Fork 1
/
miscellaneous.yaml
2655 lines (2626 loc) · 96.1 KB
/
miscellaneous.yaml
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
openapi: 3.0.0
info:
version: 1.0.0
title: Miscellaneous
servers:
- url: https://apiexplorer.support.rocket.chat
paths:
/api/v1/autotranslate.getSupportedLanguages:
get:
tags:
- Auto-Translate
summary: Get Supported Languages
description: |-
To learn how to enable the auto-translate feature, see the <a href="https://docs.rocket.chat/docs/message#autotranslate" target="_blank">Auto-Translate</a> user guide.
Get the supported languages by the auto-translate.
### Changelog
| Version | Description |
| ---------------- | ------------|
|1.3.0 | Added |
operationId: get-api-v1-autotranslate.getSupportedLanguages
parameters:
- $ref: '#/components/parameters/Auth-Token'
- $ref: '#/components/parameters/UserId'
- name: targetLanguage
in: query
description: Language in which the language names will be returned.
required: true
schema:
type: string
example: en
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
languages:
type: array
items:
type: object
properties:
language:
type: string
name:
type: string
success:
type: boolean
examples:
Success Example:
value:
languages:
- language: bg
name: Bulgarian
- language: cs
name: Czech
- language: da
name: Danish
- language: de
name: German
- language: el
name: Greek
- language: en
name: English
- language: es
name: Spanish
- language: et
name: Estonian
success: true
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
error:
type: string
errorType:
type: string
examples:
Target Language Required:
value:
success: false
error: 'must have required property ''targetLanguage'' [invalid-params]'
errorType: invalid-params
'401':
$ref: '#/components/responses/authorizationError'
/api/v1/autotranslate.saveSettings:
post:
tags:
- Auto-Translate
summary: Save Auto-Translate Settings
description: |-
Saves autotranslate settings for a room.
### Changelog
| Version | Description |
| ---------------- | ------------|
|1.3.0 | Added |
operationId: post-api-v1-autotranslate.saveSettings
parameters:
- $ref: '#/components/parameters/Auth-Token'
- $ref: '#/components/parameters/UserId'
requestBody:
content:
application/json:
schema:
type: object
properties:
roomId:
type: string
description: The room's id to apply setting.
field:
type: string
description: The setting to apply to user's subscription.
value:
type: boolean
description: Boolean if the setting is autoTranslate and a string (the language) if the setting is autoTranslateLanguage.
defaultLanguage:
type: string
description: The default language.
required:
- roomId
- field
- value
examples:
Example:
value:
roomId: 7aDSXtjMA3KPLxLjt
field: autoTranslate
value: true
defaultLanguage: en
responses:
'200':
$ref: '#/components/responses/trueSuccess'
'401':
$ref: '#/components/responses/authorizationError'
/api/v1/autotranslate.translateMessage:
post:
tags:
- Auto-Translate
summary: Translate Message
description: |-
Auto-translates the provided message.
### Changelog
| Version | Description |
| ---------------- | ------------|
|1.3.0 | Added |
operationId: post-api-v1-autotranslate.translateMessage
parameters:
- $ref: '#/components/parameters/Auth-Token'
- $ref: '#/components/parameters/UserId'
requestBody:
content:
application/json:
schema:
type: object
properties:
messageId:
type: string
description: The message's id to be translated.
targetLanguage:
type: string
description: The target language that the message will be translated.
required:
- messageId
examples:
Example:
value:
messageId: Fq7sQNSnDEfzj8qoS
targetLanguage: en
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
message:
type: object
properties:
_id:
type: string
rid:
type: string
msg:
type: string
ts:
type: string
u:
type: object
properties:
_id:
type: string
username:
type: string
name:
type: string
_updatedAt:
type: string
mentions:
type: array
items:
type: object
channels:
type: array
items:
type: object
translations:
type: object
properties:
en:
type: string
success:
type: boolean
examples:
Success:
value:
message:
_id: Fq7sQNSnDEfzj8qoS
rid: GENERAL
msg: Isso é um teste
ts: '2019-06-27T15:35:20.753Z'
u:
_id: pC6Z2N2ijivxdsYSu
username: marcos
name: marcos
_updatedAt: '2019-06-27T15:47:01.486Z'
mentions: []
channels: []
translations:
en: This is a test
success: true
'401':
$ref: '#/components/responses/authorizationError'
/api/v1/email-inbox.list:
get:
tags:
- Email Inbox
summary: List Email Inbox
description: |-
Gets email inbox list.
Permissions required:- `manage-email-inbox`
### Changelog
| Version | Description |
| ---------------- | ------------|
|3.11.0-rc.0 | Added |
operationId: get-api-v1-email-inbox.list
parameters:
- $ref: '#/components/parameters/Auth-Token'
- $ref: '#/components/parameters/UserId'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/query'
- $ref: '#/components/parameters/fields'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
emailInboxes:
type: array
items:
type: object
properties:
_id:
type: string
active:
type: boolean
name:
type: string
email:
type: string
description:
type: string
senderInfo:
type: string
department:
type: string
smtp:
type: object
properties:
server:
type: string
port:
type: integer
username:
type: string
password:
type: string
secure:
type: boolean
imap:
type: object
properties:
server:
type: string
port:
type: integer
username:
type: string
password:
type: string
secure:
type: boolean
_createdAt:
type: string
_updatedAt:
type: string
_createdBy:
type: object
properties:
_id:
type: string
username:
type: string
count:
type: integer
offset:
type: integer
total:
type: integer
success:
type: boolean
examples:
Success:
value:
emailInboxes:
- _id: 60197e8ff82d6c83b96c53ff
active: false
name: Rocket.Chat sample account
email: info@rocket.chat
description: ''
senderInfo: ''
department: GgYvrkAF63aeQmsh4
smtp:
server: smtp.gmail.com
port: 465
username: info@rocket.chat
password: kkviepoenakbccwf
secure: true
imap:
server: imap.gmail.com
port: 993
username: info@rocket.chat
password: kkviepoenakbccwf
secure: true
_createdAt: '2021-02-02T16:32:15.069Z'
_updatedAt: '2021-09-06T17:43:49.257Z'
_createdBy:
_id: JxemcN9PDCdfzJeZr
username: renato.becker
count: 1
offset: 0
total: 1
success: true
'401':
$ref: '#/components/responses/authorizationError'
'403':
$ref: '#/components/responses/forbiddenError'
/api/v1/email-inbox:
post:
tags:
- Email Inbox
summary: Set Email Inbox
description: |-
Sets the email inbox for your server.
Permissions required:- `manage-email-inbox`
### Changelog
| Version | Description |
| ---------------- | ------------|
|3.11.0-rc.0 | Added |
operationId: post-api-v1-email-inbox
parameters:
- $ref: '#/components/parameters/Auth-Token'
- $ref: '#/components/parameters/UserId'
requestBody:
content:
application/json:
schema:
type: object
properties:
_id:
type: string
description: Email Id
name:
type: string
description: The name you wish to set for your email.
email:
type: string
description: The email to be used
active:
type: boolean
description: Set whether or not the email is active.
description:
type: string
description: The description for this entry.
senderInfo:
type: string
description: Sender info to be attached on outgoing emails.
department:
type: string
description: The department to which the email will be available.
smtp:
type: object
description: An object with your SMTP credentials to be used for outgoing emails.
properties:
password:
type: string
port:
type: integer
secure:
type: boolean
server:
type: string
username:
type: string
imap:
type: object
description: An object having your IMAP credentials to be used for incomming emails.
properties:
password:
type: string
port:
type: integer
secure:
type: boolean
server:
type: string
username:
type: string
required:
- name
- email
- active
- smtp
- imap
examples:
Example:
value:
name: new email
email: mdyemaasil@rocket.chat
active: false
description: This email has been set
senderInfo: email sender
department: awesome department
smtp:
password: 10fae4dc374fb87d
port: 25
secure: true
server: smtp.mailtrap.io
username: b5ef5safd6cb806c
imap:
password: 10fae4374sdfb87d
port: 993
secure: true
server: imap.mailtrap.io
username: b5ef5aafd6cb806c
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
_id:
type: string
success:
type: boolean
examples:
Success:
value:
_id: JdVkn_dkOlms_
success: true
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
error:
type: string
examples:
Duplicate:
value:
success: false
error: 'E11000 duplicate key error index: rocketchat.rocketchat_email_inbox.$email_1 dup key: { : "mdyemail@rocket.chat" }'
Invalid Inbox:
value:
success: false
error: error-invalid-email-inbox
'401':
$ref: '#/components/responses/authorizationError'
'403':
$ref: '#/components/responses/forbiddenError'
'/api/v1/email-inbox/{_id}':
get:
tags:
- Email Inbox
summary: Email Inbox by ID
description: |-
Gets email inbox by ID.
Permissions required: `manage-email-inbox`
### Changelog
| Version | Description |
| ---------------- | ------------|
|5.3.0 | Not Found Error Added |
|3.11.0-rc.0 | Added |
operationId: get-api-v1-email-inbox-id
parameters:
- $ref: '#/components/parameters/Auth-Token'
- $ref: '#/components/parameters/UserId'
- name: _id
in: path
description: Email inbox ID
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
_id:
type: string
active:
type: boolean
name:
type: string
email:
type: string
description:
type: string
senderInfo:
type: string
department:
type: string
smtp:
type: object
properties:
server:
type: string
port:
type: integer
username:
type: string
password:
type: string
secure:
type: boolean
imap:
type: object
properties:
server:
type: string
port:
type: integer
username:
type: string
password:
type: string
secure:
type: boolean
_createdAt:
type: string
_updatedAt:
type: string
_createdBy:
type: object
properties:
_id:
type: string
username:
type: string
success:
type: boolean
examples:
Success Example:
value:
_id: 60197e8ff82d6c83b96c53ff
active: false
name: Rocket.Chat sample account
email: info@rocket.chat
description: ''
senderInfo: ''
department: GgYvrkAF63aeQmsh4
smtp:
server: smtp.gmail.com
port: 465
username: info@rocket.chat
password: kkviepoenakbccwf
secure: true
imap:
server: imap.gmail.com
port: 993
username: info@rocket.chat
password: kkviepoenakbccwf
secure: true
_createdAt: '2021-02-02T16:32:15.069Z'
_updatedAt: '2021-09-06T17:43:49.257Z'
_createdBy:
_id: JxemcN9PDCdfzJeZr
username: ren.be
success: true
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
error:
type: string
examples:
Resource not found:
value:
success: false
error: Resource not found
'401':
$ref: '#/components/responses/authorizationError'
'403':
$ref: '#/components/responses/forbiddenError'
delete:
tags:
- Email Inbox
summary: Delete Email Inbox by ID
description: |-
Deletes email inbox using ID.
Permissions required: `manage-email-inbox`
### Changelog
| Version | Description |
| ---------------- | ------------|
|3.11.0-rc.0 | Added |
operationId: delete-api-v1-email-inbox-_id
parameters:
- $ref: '#/components/parameters/Auth-Token'
- $ref: '#/components/parameters/UserId'
- name: _id
in: path
description: Email inbox ID
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
_id:
type: string
success:
type: boolean
examples:
Success Example:
value:
_id: 61717dd1066bc500096cb36d
success: true
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
error:
type: string
examples:
Email not found:
value:
success: false
error: Resource not found
'401':
$ref: '#/components/responses/authorizationError'
'403':
$ref: '#/components/responses/forbiddenError'
/api/v1/email-inbox.search:
get:
tags:
- Email Inbox
summary: Search Email Inbox
description: |-
Searches email inbox by email address.
Permissions required: `manage-email-inbox`
### Changelog
| Version | Description |
| ---------------- | ------------|
|3.11.0-rc.0 | Added |
operationId: get-api-v1-email-inbox.search
parameters:
- $ref: '#/components/parameters/Auth-Token'
- $ref: '#/components/parameters/UserId'
- name: email
in: query
description: Email inbox address
required: true
schema:
type: string
example: info@rockt.chat
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
emailInbox:
type: object
properties:
_id:
type: string
active:
type: boolean
name:
type: string
email:
type: string
description:
type: string
senderInfo:
type: string
department:
type: string
smtp:
type: object
properties:
server:
type: string
port:
type: integer
username:
type: string
password:
type: string
secure:
type: boolean
imap:
type: object
properties:
server:
type: string
port:
type: integer
username:
type: string
password:
type: string
secure:
type: boolean
_createdAt:
type: string
_updatedAt:
type: string
_createdBy:
type: object
properties:
_id:
type: string
username:
type: string
success:
type: boolean
examples:
Success Example:
value:
emailInbox:
_id: 60197e8ff82d6c83b96c53ff
active: false
name: Rocket.Chat sample account
email: info@rocket.chat
description: ''
senderInfo: ''
department: GgYvrkAF63aeQmsh4
smtp:
server: smtp.gmail.com
port: 465
username: info@rocket.chat
password: kkviepoenakbccwf
secure: true
imap:
server: imap.gmail.com
port: 993
username: info@rocket.chat
password: kkviepoenakbccwf
secure: true
_createdAt: '2021-02-02T16:32:15.069Z'
_updatedAt: '2021-09-06T17:43:49.257Z'
_createdBy:
_id: JxemcN9PDCdfzJeZr
username: renato.becker
success: true
'403':
$ref: '#/components/responses/forbiddenError'
'/api/v1/email-inbox.send-test/{_id}':
get:
tags:
- Email Inbox
summary: Send test email to email inbox
description: |-
Send a test email to the inbox.
Permissions required: `manage-email-inbox`
### Changelog
| Version | Description |
| ---------------- | ------------|
|3.11.0-rc.0 | Added |
operationId: get-api-v1-email-inbox.send-test-id
parameters:
- $ref: '#/components/parameters/Auth-Token'
- $ref: '#/components/parameters/UserId'
- name: _id
in: path
description: Email inbox id
required: true
schema:
type: string
example: 60197e8ff82d6c83b96c53ff
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
_id:
type: string
success:
type: boolean
examples:
Success Example:
value:
_id: 60197e8ff82d6c83b96c53ff
success: true
'401':
$ref: '#/components/responses/authorizationError'
'403':
$ref: '#/components/responses/forbiddenError'
/api/v1/shield.svg:
get:
summary: Shield SVG
description: |-
A simple method, requires no authentication, that returns the shield svg(badge) to add in your website. It must have `API_Enable_Shields` enabled.
### Changelog
| Version | Description |
| ---------------- | ------------|
|0.55.0 | Added |
operationId: get-api-v1-shield.svg
parameters:
- name: type
in: query
description: 'Can either be `online`, `user`, `channel`'
schema:
type: string
example: online
- name: icon
in: query
schema:
type: string
example: 'false'
- name: channel
in: query
description: Name of the channel
required: true
schema:
type: string
example: general
- name: name
in: query
description: Name to show
required: true
schema:
type: string
example: Rocket.Chat
responses:
'200':
description: OK
content:
text/plain:
schema:
type: object
examples:
Example:
value: '<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="141" height="20"> <linearGradient id="b" x2="0" y2="100%"> <stop offset="0" stop-color="#bbb" stop-opacity=".1"/> <stop offset="1" stop-opacity=".1"/> </linearGradient> <mask id="a"> <rect width="141" height="20" rx="3" fill="#fff"/> </mask> <g mask="url(#a)"> <path fill="#555" d="M0 0h67v20H0z"/> <path fill="#4c1" d="M67 0h74v20H67z"/> <path fill="url(#b)" d="M0 0h141v20H0z"/> </g> <image x="5" y="3" width="14" height="14" xlink:href="/assets/favicon.svg"/> <g fill="#fff" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11"> <text x="24" y="15" fill="#010101" fill-opacity=".3">Rocket</text> <text x="24" y="14">Rocket</text> <text x="74" y="15" fill="#010101" fill-opacity=".3">JOIN CHAT</text> <text x="74" y="14">JOIN CHAT</text> </g> </svg>'
headers:
Content-Type:
schema:
type: string
example: image/svg+xml;charset=utf-8
description: image/svg+xml;charset=utf-8
/api/v1/spotlight:
get:
summary: Spotlight
description: |-
Searches for users or rooms that are visible to the user. It will only return rooms that user didn't join yet.
### Changelog
| Version | Description |
| ---------------- | ------------|
|0.64.0 | Added support to '#' and '@' searches, for channels and users respectively. |
|0.61.0 | Added |
operationId: get-api-v1-spotlight
parameters:
- $ref: '#/components/parameters/Auth-Token'
- $ref: '#/components/parameters/UserId'
- name: query
in: query
description: The term to be searched. Supports '#' for channels and '@' for users
required: true
schema:
type: string
example: john
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
users:
type: array
items:
type: object
properties:
_id:
type: string
name:
type: string
username:
type: string
status:
type: string
avatarETag:
type: string
rooms:
type: array
items:
type: object
success:
type: boolean
examples:
Success:
value:
users:
- _id: rocket.cat
name: Rocket.Cat
username: rocket.cat
status: online
avatarETag: 5BB9B5ny5DkKdrwkq
rooms: []
success: true
'401':
$ref: '#/components/responses/authorizationError'
/api/v1/stdout.queue:
get:
summary: Get stdout queue
description: |-
Retrieves last 1000 lines of server logs
Permissions required: `view-logs`
operationId: get-api-v1-stdout.queue
parameters:
- $ref: '#/components/parameters/Auth-Token'
- $ref: '#/components/parameters/UserId'
responses:
'200':
description: OK