-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
5649 lines (5624 loc) · 178 KB
/
openapi.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:
description: >-
mailcow is complete e-mailing solution with advanced antispam, antivirus,
nice UI and API.
In order to use this API you have to create a API key and add your IP
address to the whitelist of allowed IPs this can be done by logging into the
Mailcow UI using your admin account, then go to Configuration > Access >
Edit administrator details > API. There you will find a collapsed API menu.
There are two types of API keys
- The read only key can only be used for all get endpoints
- The read write key can be used for all endpoints
title: mailcow API
version: "1.0.0"
servers:
- url: /
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-Key
responses:
Unauthorized:
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
type:
type: string
example: error
msg:
type: string
example: authentication failed
required:
- type
- msg
security:
- ApiKeyAuth: []
paths:
/api/v1/add/alias:
post:
responses:
"401":
$ref: "#/components/responses/Unauthorized"
"200":
content:
application/json:
examples:
response:
value:
- log:
- mailbox
- add
- alias
- active: "1"
address: [email protected]
goto: [email protected]
- null
msg:
- alias_added
type: success
schema:
properties:
log:
description: contains request object
items: {}
type: array
msg:
items: {}
type: array
type:
enum:
- success
- danger
- error
type: string
type: object
description: OK
headers: {}
tags:
- Aliases
description: >-
You may create your own mailbox alias using this action. It takes a JSON
object containing a domain informations.
Only one `goto*` option can be used, for ex. if you want learn as spam,
then send just `goto_spam = 1` in request body.
operationId: Create alias
requestBody:
content:
application/json:
schema:
example:
active: "1"
address: [email protected]
goto: [email protected]
properties:
active:
description: is alias active or not
type: boolean
address:
description: 'alias address, for catchall use "@domain.tld"'
type: string
goto:
description: "destination address, comma separated"
type: string
goto_ham:
description: learn as ham
type: boolean
goto_null:
description: silently ignore
type: boolean
goto_spam:
description: learn as spam
type: boolean
sogo_visible:
description: toggle visibility as selectable sender in SOGo
type: boolean
type: object
summary: Create alias
/api/v1/add/time_limited_alias:
post:
responses:
"401":
$ref: "#/components/responses/Unauthorized"
"200":
content:
application/json:
examples:
response:
value:
- log:
- mailbox
- add
- time_limited_alias
- address: [email protected]
domain: domain.tld
- null
msg:
- mailbox_modified
type: success
schema:
properties:
log:
description: contains request object
items: {}
type: array
msg:
items: {}
type: array
type:
enum:
- success
- danger
- error
type: string
type: object
description: OK
headers: {}
tags:
- Aliases
description: >-
You may create a time limited alias using this action. It takes a JSON
object containing a domain and mailbox informations.
Mailcow will generate a random alias.
operationId: Create time limited alias
requestBody:
content:
application/json:
schema:
example:
username: [email protected]
domain: domain.tld
properties:
username:
description: 'the mailbox an alias should be created for'
type: string
domain:
description: "the domain"
type: string
type: object
summary: Create time limited alias
/api/v1/add/app-passwd:
post:
responses:
"401":
$ref: "#/components/responses/Unauthorized"
"200":
content:
application/json:
examples:
response:
value:
- log:
- app_passwd
- add
- active: "1"
username: [email protected]
app_name: wordpress
app_passwd: keyleudecticidechothistishownsan31
app_passwd2: keyleudecticidechothistishownsan31
protocols:
- imap_access
- dav_access
- smtp_access
- eas_access
- pop3_access
- sieve_access
msg: app_passwd_added
type: success
schema:
properties:
log:
description: contains request object
items: {}
type: array
msg:
items: {}
type: array
type:
enum:
- success
- danger
- error
type: string
type: object
description: OK
headers: {}
tags:
- App Passwords
description: >-
Using this endpoint you can create a new app password for a specific
mailbox.
operationId: Create App Password
requestBody:
content:
application/json:
schema:
example:
active: "1"
username: [email protected]
app_name: wordpress
app_passwd: keyleudecticidechothistishownsan31
app_passwd2: keyleudecticidechothistishownsan31
protocols:
- imap_access
- dav_access
- smtp_access
- eas_access
- pop3_access
- sieve_access
properties:
active:
description: is alias active or not
type: boolean
username:
description: mailbox for which the app password should be created
type: string
app_name:
description: name of your app password
type: string
app_passwd:
description: your app password
type: string
app_passwd2:
description: your app password
type: string
type: object
summary: Create App Password
/api/v1/add/bcc:
post:
responses:
"401":
$ref: "#/components/responses/Unauthorized"
"200":
content:
application/json:
examples:
response:
value:
- log:
- bcc
- add
- active: "1"
bcc_dest: [email protected]
local_dest: mailcow.tld
type: sender
- null
msg: bcc_saved
type: success
schema:
properties:
log:
description: contains request object
items: {}
type: array
msg:
items: {}
type: array
type:
enum:
- success
- danger
- error
type: string
type: object
description: OK
headers: {}
tags:
- Address Rewriting
description: >-
Using this endpoint you can create a BCC map to forward all mails via a
bcc for a given domain.
operationId: Create BCC Map
requestBody:
content:
application/json:
schema:
example:
active: "1"
bcc_dest: [email protected]
local_dest: mailcow.tld
type: sender
properties:
active:
description: 1 for a active user account 0 for a disabled user account
type: number
bcc_dest:
description: the email address where all mails should be send to
type: string
local_dest:
description: the domain which emails should be forwarded
type: string
type:
description: the type of bcc map can be `sender` or `recipient`
type: string
type: object
summary: Create BCC Map
/api/v1/add/dkim:
post:
responses:
"401":
$ref: "#/components/responses/Unauthorized"
"200":
content:
application/json:
examples:
response:
value:
- log:
- dkim
- add
- dkim_selector: dkim
domains: hanspeterlol.de
key_size: "2048"
msg:
- dkim_added
- hanspeterlol.de
type: success
schema:
properties:
log:
description: contains request object
items: {}
type: array
msg:
items: {}
type: array
type:
enum:
- success
- danger
- error
type: string
type: object
description: OK
headers: {}
tags:
- DKIM
description: Using this endpoint you can generate new DKIM keys.
operationId: Generate DKIM Key
requestBody:
content:
application/json:
schema:
example:
dkim_selector: dkim
domains: mailcow.tld
key_size: "2048"
properties:
dkim_selector:
description: the DKIM selector default dkim
type: string
domains:
description: a list of domains for which a dkim key should be generated
type: string
key_size:
description: the key size (1024 or 2048)
type: number
type: object
summary: Generate DKIM Key
/api/v1/add/dkim_duplicate:
post:
responses:
"401":
$ref: "#/components/responses/Unauthorized"
"200":
content:
application/json:
examples:
response:
value:
- log:
- dkim
- duplicate
- from_domain: mailcow.tld
to_domain: awesomecow.tld
msg:
- dkim_duplicated
- mailcow.tld
- awesomecow.tld
type: success
schema:
properties:
log:
description: contains request object
items: {}
type: array
msg:
items: {}
type: array
type:
enum:
- success
- danger
- error
type: string
type: object
description: OK
headers: {}
tags:
- DKIM
description: Using this endpoint you can duplicate the DKIM Key of one domain.
operationId: Duplicate DKIM Key
requestBody:
content:
application/json:
schema:
example:
from_domain: mailcow.tld
to_domain: awesomecow.tld
properties:
fron_domain:
description: the domain where the dkim key should be copied from
type: string
to_domain:
description: the domain where the dkim key should be copied to
type: string
type: object
summary: Duplicate DKIM Key
/api/v1/add/domain:
post:
responses:
"401":
$ref: "#/components/responses/Unauthorized"
"200":
content:
application/json:
examples:
response:
value:
- log:
- ratelimit
- edit
- domain
- object: domain.tld
rl_frame: s
rl_value: "10"
msg:
- rl_saved
- domain.tld
type: success
- log:
- mailbox
- add
- domain
- active: "1"
aliases: "400"
restart_sogo: "1"
backupmx: "0"
defquota: "3072"
description: some decsription
domain: domain.tld
mailboxes: "10"
maxquota: "10240"
quota: "10240"
relay_all_recipients: "0"
rl_frame: s
rl_value: "10"
tags: ["tag1", "tag2"]
- null
msg:
- domain_added
- domain.tld
type: success
schema:
type: array
items:
type: object
properties:
log:
description: contains request object
items: {}
type: array
msg:
items: {}
type: array
type:
enum:
- success
- danger
- error
type: string
description: OK
headers: {}
tags:
- Domains
description: >-
You may create your own domain using this action. It takes a JSON object
containing a domain informations.
operationId: Create domain
requestBody:
content:
application/json:
schema:
example:
active: "1"
aliases: "400"
backupmx: "0"
defquota: "3072"
description: some decsription
domain: domain.tld
mailboxes: "10"
maxquota: "10240"
quota: "10240"
relay_all_recipients: "0"
rl_frame: s
rl_value: "10"
restart_sogo: "10"
tags: ["tag1", "tag2"]
properties:
active:
description: is domain active or not
type: boolean
aliases:
description: limit count of aliases associated with this domain
type: number
backupmx:
description: relay domain or not
type: boolean
defquota:
description: predefined mailbox quota in `add mailbox` form
type: number
description:
description: Description of domain
type: string
domain:
description: Fully qualified domain name
type: string
gal:
description: >-
is domain global address list active or not, it enables
shared contacts accross domain in SOGo webmail
type: boolean
mailboxes:
description: limit count of mailboxes associated with this domain
type: number
maxquota:
description: maximum quota per mailbox
type: number
quota:
description: maximum quota for this domain (for all mailboxes in sum)
type: number
restart_sogo:
description: restart SOGo to activate the domain in SOGo
type: number
relay_all_recipients:
description: >-
if not, them you have to create "dummy" mailbox for each
address to relay
type: boolean
relay_unknown_only:
description: Relay non-existing mailboxes only. Existing mailboxes will be delivered locally.
type: boolean
rl_frame:
enum:
- s
- m
- h
- d
type: string
rl_value:
description: rate limit value
type: number
tags:
description: tags for this Domain
type: array
items:
type: string
type: object
summary: Create domain
/api/v1/add/domain-admin:
post:
responses:
"401":
$ref: "#/components/responses/Unauthorized"
"200":
content:
application/json:
examples:
response:
value:
- log:
- domain_admin
- add
- active: "1"
domains: mailcow.tld
password: "*"
password2: "*"
username: testadmin
msg:
- domain_admin_added
- testadmin
type: success
schema:
properties:
log:
description: contains request object
items: {}
type: array
msg:
items: {}
type: array
type:
enum:
- success
- danger
- error
type: string
type: object
description: OK
headers: {}
tags:
- Domain admin
description: >-
Using this endpoint you can create a new Domain Admin user. This user
has full control over a domain, and can create new mailboxes and
aliases.
operationId: Create Domain Admin user
requestBody:
content:
application/json:
schema:
example:
active: "1"
domains: mailcow.tld
password: supersecurepw
password2: supersecurepw
username: testadmin
properties:
active:
description: 1 for a active user account 0 for a disabled user account
type: number
domains:
description: the domains the user should be a admin of
type: string
password:
description: domain admin user password
type: string
password2:
description: domain admin user password
type: string
username:
description: the username for the admin user
type: string
type: object
summary: Create Domain Admin user
/api/v1/add/sso/domain-admin:
post:
responses:
"401":
$ref: "#/components/responses/Unauthorized"
"200":
content:
application/json:
examples:
response:
value:
token: "591F6D-5C3DD2-7455CD-DAF1C1-AA4FCC"
description: OK
headers: { }
tags:
- Single Sign-On
description: >-
Using this endpoint you can issue a token for Domain Admin user. This token can be used for
autologin Domain Admin user by using query_string var sso_token={token}. Token expiration time is 30s
operationId: Issue Domain Admin SSO token
requestBody:
content:
application/json:
schema:
example:
username: testadmin
properties:
username:
description: the username for the admin user
type: object
type: object
summary: Issue Domain Admin SSO token
/api/v1/edit/da-acl:
post:
responses:
"401":
$ref: "#/components/responses/Unauthorized"
"200":
content:
application/json:
examples:
response:
value:
- type: success
log:
- acl
- edit
- testadmin
- username:
- testadmin
da_acl:
- syncjobs
- quarantine
- login_as
- sogo_access
- app_passwds
- bcc_maps
- pushover
- filters
- ratelimit
- spam_policy
- extend_sender_acl
- unlimited_quota
- protocol_access
- smtp_ip_access
- alias_domains
- domain_desc
msg:
- acl_saved
- testadmin
schema:
properties:
log:
description: contains request object
items: {}
type: array
msg:
items: {}
type: array
type:
enum:
- success
- danger
- error
type: string
type: object
description: OK
headers: {}
tags:
- Domain admin
description: >-
Using this endpoint you can edit the ACLs of a Domain Admin user. This user
has full control over a domain, and can create new mailboxes and
aliases.
operationId: Edit Domain Admin ACL
requestBody:
content:
application/json:
schema:
example:
items:
- testadmin
attr:
da_acl:
- syncjobs
- quarantine
- login_as
- sogo_access
- app_passwds
- bcc_maps
- pushover
- filters
- ratelimit
- spam_policy
- extend_sender_acl
- unlimited_quota
- protocol_access
- smtp_ip_access
- alias_domains
- domain_desc
properties:
items:
description: contains the domain admin username you want to edit
type: object
attr:
properties:
da_acl:
description: contains the list of acl names that are active for this user
type: object
type: object
summary: Edit Domain Admin ACL
/api/v1/edit/domain-admin:
post:
responses:
"401":
$ref: "#/components/responses/Unauthorized"
"200":
content:
application/json:
examples:
response:
value:
- type: success
log:
- domain_admin
- edit
- username: testadmin
active: ["0","1"]
username_new: testadmin
domains: ["domain.tld"]
password: "*"
password2: "*"
msg:
- domain_admin_modified
- testadmin
schema:
properties:
type:
enum:
- success
- danger
- error
type: string
log:
description: contains request object
items: {}
type: array
msg:
items: {}
type: array
type: object
description: OK
headers: {}
tags:
- Domain admin
description: >-
Using this endpoint you can edit a existing Domain Admin user. This user
has full control over a domain, and can create new mailboxes and
aliases.
operationId: Edit Domain Admin user
requestBody:
content:
application/json:
schema:
example:
items:
- testadmin
attr:
active:
- '0'
- '1'
username_new: testadmin
domains: ["domain.tld"]
password: supersecurepassword
password2: supersecurepassword
properties:
attr:
properties:
active:
description: is the domain admin active or not
type: boolean
username_new:
description: the username of the domain admin, change this to change the username
type: string
domains:
description: a list of all domains managed by this domain admin
type: array
items:
type: string
password:
description: the new domain admin user password
type: string
password2:
description: the new domain admin user password for confirmation
type: string
type: object
items:
description: contains the domain admin username you want to edit
type: object
summary: Edit Domain Admin user
/api/v1/add/domain-policy:
post:
responses:
"401":
$ref: "#/components/responses/Unauthorized"
"200":
content:
application/json:
examples:
response:
value:
- log:
- policy
- add
- domain
- domain: domain.tld
object_from: "*@baddomain.tld"
object_list: bl
msg:
- domain_modified
- domain.tld
type: success
schema:
properties:
log:
description: contains request object
items: {}
type: array
msg:
items: {}
type: array
type:
enum:
- success
- danger
- error
type: string
type: object
description: OK
headers: {}
tags:
- Domain antispam policies
description: >-
You may create your own domain policy using this action. It takes a JSON
object containing a domain informations.
operationId: Create domain policy
requestBody:
content:
application/json:
schema:
example:
domain: domain.tld
object_from: "*@baddomain.tld"
object_list: bl
properties:
domain:
description: domain name to which policy is associated to
type: string
object_from:
description: exact address or use wildcard to match whole domain
type: string
object_list:
enum:
- wl
- bl
type: string
type: object
summary: Create domain policy
/api/v1/add/fwdhost:
post:
responses:
"401":
$ref: "#/components/responses/Unauthorized"
"200":
content:
application/json:
examples:
response:
value: