From 370e6dc415d928646316d80e4e3fce693e592f1e Mon Sep 17 00:00:00 2001 From: ntimo Date: Thu, 17 Sep 2020 20:35:13 +0200 Subject: [PATCH] [API docs] Removed active_int Reflecting d9b91fc04f286eaba4266ca60254a02dc5e91867 --- data/web/api/openapi.yaml | 1336 ++++++++++++++++++------------------- 1 file changed, 661 insertions(+), 675 deletions(-) diff --git a/data/web/api/openapi.yaml b/data/web/api/openapi.yaml index fe82f2a8..802748e3 100644 --- a/data/web/api/openapi.yaml +++ b/data/web/api/openapi.yaml @@ -16,7 +16,7 @@ info: - The read write key can be used for all endpoints title: mailcow API - version: '1.0.0' + version: "1.0.0" servers: - url: / @@ -42,8 +42,8 @@ components: type: string example: authentication failed required: - - type - - msg + - type + - msg security: - ApiKeyAuth: [] @@ -52,9 +52,9 @@ paths: /api/v1/add/alias: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -64,7 +64,7 @@ paths: - mailbox - add - alias - - active: '1' + - active: "1" address: alias@domain.tld goto: destination@domain.tld - null @@ -104,7 +104,7 @@ paths: application/json: schema: example: - active: '1' + active: "1" address: alias@domain.tld goto: destination@domain.tld properties: @@ -115,7 +115,7 @@ paths: description: 'alias address, for catchall use "@domain.tld"' type: string goto: - description: 'destination address, comma separated' + description: "destination address, comma separated" type: string goto_ham: description: learn as ham @@ -131,9 +131,9 @@ paths: /api/v1/add/app-passwd: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -142,7 +142,7 @@ paths: - log: - app_passwd - add - - active: '1' + - active: "1" app_name: emclient app_passwd: keyleudecticidechothistishownsan31 app_passwd2: keyleudecticidechothistishownsan31 @@ -178,7 +178,7 @@ paths: application/json: schema: example: - active: '1' + active: "1" username: info@domain.tld app_name: wordpress app_passwd: keyleudecticidechothistishownsan31 @@ -197,16 +197,16 @@ paths: description: your app password type: string app_passwd2: - description: your app password - type: string + description: your app password + type: string type: object summary: Create App Password /api/v1/add/bcc: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -215,7 +215,7 @@ paths: - log: - bcc - add - - active: '1' + - active: "1" bcc_dest: bcc@awesomecow.tld local_dest: mailcow.tld type: sender @@ -251,7 +251,7 @@ paths: application/json: schema: example: - active: '1' + active: "1" bcc_dest: bcc@awesomecow.tld local_dest: mailcow.tld type: sender @@ -273,9 +273,9 @@ paths: /api/v1/add/dkim: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -286,7 +286,7 @@ paths: - add - dkim_selector: dkim domains: hanspeterlol.de - key_size: '2048' + key_size: "2048" msg: - dkim_added - hanspeterlol.de @@ -320,7 +320,7 @@ paths: example: dkim_selector: dkim domains: mailcow.tld - key_size: '2048' + key_size: "2048" properties: dkim_selector: description: the DKIM selector default dkim @@ -336,9 +336,9 @@ paths: /api/v1/add/dkim_duplicate: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -395,9 +395,9 @@ paths: /api/v1/add/domain: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -409,7 +409,7 @@ paths: - domain - object: domain.tld rl_frame: s - rl_value: '10' + rl_value: "10" msg: - rl_saved - domain.tld @@ -418,19 +418,19 @@ paths: - mailbox - add - domain - - active: '1' - aliases: '400' - backupmx: '0' - defquota: '3072' + - active: "1" + aliases: "400" + backupmx: "0" + defquota: "3072" description: some decsription domain: domain.tld lang: cs - mailboxes: '10' - maxquota: '10240' - quota: '10240' - relay_all_recipients: '0' + mailboxes: "10" + maxquota: "10240" + quota: "10240" + relay_all_recipients: "0" rl_frame: s - rl_value: '10' + rl_value: "10" - null msg: - domain_added @@ -465,19 +465,19 @@ paths: application/json: schema: example: - active: '1' - aliases: '400' - backupmx: '0' - defquota: '3072' + active: "1" + aliases: "400" + backupmx: "0" + defquota: "3072" description: some decsription domain: domain.tld lang: cs - mailboxes: '10' - maxquota: '10240' - quota: '10240' - relay_all_recipients: '0' + mailboxes: "10" + maxquota: "10240" + quota: "10240" + relay_all_recipients: "0" rl_frame: s - rl_value: '10' + rl_value: "10" properties: active: description: is domain active or not @@ -542,9 +542,9 @@ paths: /api/v1/add/domain-admin: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -553,10 +553,10 @@ paths: - log: - domain_admin - add - - active: '1' + - active: "1" domains: mailcow.tld - password: '*' - password2: '*' + password: "*" + password2: "*" username: testadmin msg: - domain_admin_added @@ -592,7 +592,7 @@ paths: application/json: schema: example: - active: '1' + active: "1" domains: mailcow.tld password: supersecurepw password2: supersecurepw @@ -618,9 +618,9 @@ paths: /api/v1/add/domain-policy: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -631,7 +631,7 @@ paths: - add - domain - domain: domain.tld - object_from: '*@baddomain.tld' + object_from: "*@baddomain.tld" object_list: bl msg: - domain_modified @@ -667,7 +667,7 @@ paths: schema: example: domain: domain.tld - object_from: '*@baddomain.tld' + object_from: "*@baddomain.tld" object_list: bl properties: domain: @@ -686,9 +686,9 @@ paths: /api/v1/add/fwdhost: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -697,11 +697,11 @@ paths: - log: - fwdhost - add - - filter_spam: '0' + - filter_spam: "0" hostname: hosted.mailcow.de msg: - forwarding_host_added - - '5.1.76.202, 2a00:f820:417::202' + - "5.1.76.202, 2a00:f820:417::202" type: success schema: properties: @@ -733,11 +733,11 @@ paths: application/json: schema: example: - filter_spam: '0' + filter_spam: "0" hostname: hosted.mailcow.de properties: filter_spam: - description: '1 to enable spam filter, 0 to disable spam filter' + description: "1 to enable spam filter, 0 to disable spam filter" type: number hostname: description: contains the hostname you want to add @@ -747,9 +747,9 @@ paths: /api/v1/add/mailbox: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -759,16 +759,16 @@ paths: - mailbox - add - mailbox - - active: '1' + - active: "1" domain: domain.tld local_part: info name: Full name - password: '*' - password2: '*' - quota: '3072' - force_pw_update: '1' - tls_enforce_in: '1' - tls_enforce_out: '1' + password: "*" + password2: "*" + quota: "3072" + force_pw_update: "1" + tls_enforce_in: "1" + tls_enforce_out: "1" - null msg: - mailbox_added @@ -803,16 +803,16 @@ paths: application/json: schema: example: - active: '1' + active: "1" domain: domain.tld local_part: info name: Full name password: atedismonsin password2: atedismonsin - quota: '3072' - force_pw_update: '1' - tls_enforce_in: '1' - tls_enforce_out: '1' + quota: "3072" + force_pw_update: "1" + tls_enforce_in: "1" + tls_enforce_out: "1" properties: active: description: is mailbox active or not @@ -850,9 +850,9 @@ paths: /api/v1/add/oauth2-client: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -862,7 +862,7 @@ paths: - oauth2 - add - client - - redirect_uri: 'https://mailcow.tld' + - redirect_uri: "https://mailcow.tld" msg: Added client access type: success schema: @@ -892,7 +892,7 @@ paths: application/json: schema: example: - redirect_uri: 'https://mailcow.tld' + redirect_uri: "https://mailcow.tld" properties: redirect_uri: description: the uri where you should be redirected after oAuth @@ -902,9 +902,9 @@ paths: /api/v1/add/recipient_map: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -913,7 +913,7 @@ paths: - log: - recipient_map - add - - active: '1' + - active: "1" recipient_map_new: target@mailcow.tld recipient_map_old: recipient@mailcow.tld - null @@ -950,7 +950,7 @@ paths: application/json: schema: example: - active: '1' + active: "1" recipient_map_new: target@mailcow.tld recipient_map_old: recipient@mailcow.tld properties: @@ -968,9 +968,9 @@ paths: /api/v1/add/relayhost: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -979,12 +979,12 @@ paths: - log: - relayhost - add - - hostname: 'mailcow.tld:25' + - hostname: "mailcow.tld:25" password: supersecurepassword username: testuser msg: - relayhost_added - - '' + - "" type: success schema: properties: @@ -1013,7 +1013,7 @@ paths: application/json: schema: example: - hostname: 'mailcow.tld:25' + hostname: "mailcow.tld:25" password: supersecurepassword username: testuser properties: @@ -1031,9 +1031,9 @@ paths: /api/v1/add/resource: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -1043,13 +1043,13 @@ paths: - mailbox - add - resource - - active: '1' + - active: "1" description: test domain: mailcow.tld kind: location - multiple_bookings: '0' - multiple_bookings_custom: '' - multiple_bookings_select: '0' + multiple_bookings: "0" + multiple_bookings_custom: "" + multiple_bookings_select: "0" - null msg: - resource_added @@ -1082,13 +1082,13 @@ paths: application/json: schema: example: - active: '1' + active: "1" description: test domain: mailcow.tld kind: location - multiple_bookings: '0' - multiple_bookings_custom: '' - multiple_bookings_select: '0' + multiple_bookings: "0" + multiple_bookings_custom: "" + multiple_bookings_select: "0" properties: active: description: 1 for a active transport map 0 for a disabled transport map @@ -1108,8 +1108,8 @@ paths: type: string multiple_bookings: enum: - - '-1' - - '1' + - "-1" + - "1" - custom type: string multiple_bookings_custom: @@ -1117,8 +1117,8 @@ paths: type: number multiple_bookings_select: enum: - - '-1' - - '1' + - "-1" + - "1" - custom type: string type: object @@ -1126,9 +1126,9 @@ paths: /api/v1/add/syncjob: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -1138,25 +1138,25 @@ paths: - mailbox - add - syncjob - - active: '1' - automap: '1' - custom_params: '' - delete1: '0' - delete2: '0' - delete2duplicates: '1' + - active: "1" + automap: "1" + custom_params: "" + delete1: "0" + delete2: "0" + delete2duplicates: "1" enc1: SSL exclude: (?i)spam|(?i)junk host1: imap.server.tld - maxage: '0' - maxbytespersecond: '0' - mins_interval: '20' + maxage: "0" + maxbytespersecond: "0" + mins_interval: "20" password1: supersecret port1: 993 - skipcrossduplicates: '0' + skipcrossduplicates: "0" subfolder2: External - subscribeall: '1' - timeout1: '600' - timeout2: '600' + subscribeall: "1" + timeout1: "600" + timeout2: "600" user1: username username: mailbox@domain.tld - null @@ -1196,25 +1196,25 @@ paths: example: username: lisa@mailcow.tld host1: mail.mailcow.tld - port1: '143' + port1: "143" user1: demo@mailcow.tld password1: supersecretpw enc1: TLS - mins_interval: '20' + mins_interval: "20" subfolder2: "/SyncIntoSubfolder" - maxage: '0' - maxbytespersecond: '0' - timeout1: '600' - timeout2: '600' + maxage: "0" + maxbytespersecond: "0" + timeout1: "600" + timeout2: "600" exclude: "(?i)spam|(?i)junk" custom_params: "--dry" - delete2duplicates: '1' - delete1: '1' - delete2: '0' - automap: '1' - skipcrossduplicates: '0' - subscribeall: '0' - active: '1' + delete2duplicates: "1" + delete1: "1" + delete2: "0" + automap: "1" + skipcrossduplicates: "0" + subscribeall: "0" + active: "1" properties: parameters: description: your local mailcow mailbox @@ -1280,9 +1280,9 @@ paths: /api/v1/add/tls-policy-map: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -1291,8 +1291,8 @@ paths: - log: - tls_policy_maps - add - - parameters: '' - active: '1' + - parameters: "" + active: "1" dest: mailcow.tld policy: encrypt - null @@ -1327,8 +1327,8 @@ paths: application/json: schema: example: - parameters: '' - active: '1' + parameters: "" + active: "1" dest: mailcow.tld policy: encrypt properties: @@ -1350,7 +1350,7 @@ paths: - may - encrypt - dane - - '''dane' + - "'dane" - fingerprint - verify - secure @@ -1360,9 +1360,9 @@ paths: /api/v1/add/transport/all: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -1371,14 +1371,14 @@ paths: - log: - transport - add - - active: '1' + - active: "1" destination: example2.org - nexthop: 'host:25' + nexthop: "host:25" password: supersecurepw username: testuser msg: - relayhost_added - - '' + - "" type: success schema: properties: @@ -1407,9 +1407,9 @@ paths: application/json: schema: example: - active: '1' + active: "1" destination: example.org - nexthop: 'host:25' + nexthop: "host:25" password: supersecurepw username: testuser properties: @@ -1431,9 +1431,9 @@ paths: /api/v1/delete/alias: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -1444,8 +1444,8 @@ paths: - delete - alias - id: - - '6' - - '9' + - "6" + - "9" - null msg: - alias_removed @@ -1456,8 +1456,8 @@ paths: - delete - alias - id: - - '6' - - '9' + - "6" + - "9" - null msg: - alias_removed @@ -1491,17 +1491,17 @@ paths: schema: items: example: - - '6' - - '9' + - "6" + - "9" type: string type: array summary: Delete alias /api/v1/delete/app-passwd: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -1511,10 +1511,10 @@ paths: - app_passwd - delete - id: - - '2' + - "2" msg: - app_passwd_removed - - '2' + - "2" type: success schema: properties: @@ -1543,7 +1543,7 @@ paths: application/json: schema: example: - - '1' + - "1" properties: items: description: contains list of app passwords you want to delete @@ -1553,9 +1553,9 @@ paths: /api/v1/delete/bcc: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -1565,11 +1565,11 @@ paths: - bcc - delete - id: - - '4' + - "4" - null msg: - bcc_deleted - - '4' + - "4" type: success schema: properties: @@ -1600,7 +1600,7 @@ paths: application/json: schema: example: - - '3' + - "3" properties: items: description: contains list of bcc maps you want to delete @@ -1610,9 +1610,9 @@ paths: /api/v1/delete/dkim: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -1662,9 +1662,9 @@ paths: /api/v1/delete/domain: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -1732,9 +1732,9 @@ paths: /api/v1/delete/domain-admin: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -1786,9 +1786,9 @@ paths: /api/v1/delete/domain-policy: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -1799,22 +1799,22 @@ paths: - delete - domain - prefid: - - '1' - - '2' + - "1" + - "2" msg: - item_deleted - - '1' + - "1" type: success - log: - policy - delete - domain - prefid: - - '1' - - '2' + - "1" + - "2" msg: - item_deleted - - '2' + - "2" type: success schema: properties: @@ -1843,8 +1843,8 @@ paths: application/json: schema: example: - - '1' - - '2' + - "1" + - "2" properties: items: description: contains list of domain policys you want to delete @@ -1854,9 +1854,9 @@ paths: /api/v1/delete/fwdhost: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -1867,7 +1867,7 @@ paths: - delete - forwardinghost: - 5.1.76.202 - - '2a00:f820:417::202' + - "2a00:f820:417::202" msg: - forwarding_host_removed - 5.1.76.202 @@ -1877,10 +1877,10 @@ paths: - delete - forwardinghost: - 5.1.76.202 - - '2a00:f820:417::202' + - "2a00:f820:417::202" msg: - forwarding_host_removed - - '2a00:f820:417::202' + - "2a00:f820:417::202" type: success schema: properties: @@ -1912,7 +1912,7 @@ paths: schema: example: - 5.1.76.202 - - '2a00:f820:417::202' + - "2a00:f820:417::202" properties: ip: description: contains the ip of the fowarding host you want to delete @@ -1922,9 +1922,9 @@ paths: /api/v1/delete/mailbox: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -1992,9 +1992,9 @@ paths: /api/v1/delete/mailq: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -2027,9 +2027,9 @@ paths: /api/v1/delete/oauth2-client: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -2040,10 +2040,10 @@ paths: - delete - client - id: - - '1' + - "1" msg: - items_deleted - - '1' + - "1" type: success schema: properties: @@ -2074,7 +2074,7 @@ paths: application/json: schema: example: - - '3' + - "3" properties: items: description: contains list of oAuth clients you want to delete @@ -2084,9 +2084,9 @@ paths: /api/v1/delete/qitem: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -2096,10 +2096,10 @@ paths: - quarantine - delete - id: - - '33' + - "33" msg: - item_deleted - - '33' + - "33" type: success schema: properties: @@ -2130,7 +2130,7 @@ paths: application/json: schema: example: - - '33' + - "33" properties: items: description: contains list of emails you want to delete @@ -2140,9 +2140,9 @@ paths: /api/v1/delete/recipient_map: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -2152,11 +2152,11 @@ paths: - recipient_map - delete - id: - - '1' + - "1" - null msg: - recipient_map_entry_deleted - - '1' + - "1" type: success schema: properties: @@ -2187,7 +2187,7 @@ paths: application/json: schema: example: - - '1' + - "1" properties: items: description: contains list of recipient maps you want to delete @@ -2197,9 +2197,9 @@ paths: /api/v1/delete/relayhost: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -2209,10 +2209,10 @@ paths: - relayhost - delete - id: - - '1' + - "1" msg: - relayhost_removed - - '1' + - "1" type: success schema: properties: @@ -2243,7 +2243,7 @@ paths: application/json: schema: example: - - '1' + - "1" properties: items: description: >- @@ -2255,9 +2255,9 @@ paths: /api/v1/delete/resource: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -2313,9 +2313,9 @@ paths: /api/v1/delete/syncjob: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -2356,8 +2356,8 @@ paths: application/json: schema: example: - - '6' - - '9' + - "6" + - "9" properties: items: description: contains list of aliases you want to delete @@ -2367,9 +2367,9 @@ paths: /api/v1/delete/tls-policy-map: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -2379,11 +2379,11 @@ paths: - tls_policy_maps - delete - id: - - '1' + - "1" - null msg: - tls_policy_map_entry_deleted - - '1' + - "1" type: success schema: properties: @@ -2414,7 +2414,7 @@ paths: application/json: schema: example: - - '3' + - "3" properties: items: description: contains list of tls policy maps you want to delete @@ -2424,9 +2424,9 @@ paths: /api/v1/delete/transport: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -2436,10 +2436,10 @@ paths: - transport - delete - id: - - '1' + - "1" msg: - relayhost_removed - - '1' + - "1" type: success schema: properties: @@ -2470,7 +2470,7 @@ paths: application/json: schema: example: - - '1' + - "1" properties: items: description: contains list of transport maps you want to delete @@ -2480,9 +2480,9 @@ paths: /api/v1/edit/alias: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -2492,11 +2492,11 @@ paths: - mailbox - edit - alias - - active: '1' + - active: "1" address: alias@domain.tld goto: destination@domain.tld id: - - '6' + - "6" private_comment: private comment public_comment: public comment - null @@ -2534,12 +2534,12 @@ paths: schema: example: attr: - active: '1' + active: "1" address: alias@domain.tld goto: destination@domain.tld private_comment: private comment public_comment: public comment - items: '6' + items: "6" properties: attr: properties: @@ -2550,7 +2550,7 @@ paths: description: 'alias address, for catchall use "@domain.tld"' type: string goto: - description: 'destination address, comma separated' + description: "destination address, comma separated" type: string goto_ham: description: learn as ham @@ -2574,11 +2574,11 @@ paths: /api/v1/edit/domain: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: - '*/*': + "*/*": schema: properties: log: @@ -2612,18 +2612,18 @@ paths: schema: example: attr: - active: '1' - aliases: '400' - backupmx: '1' - defquota: '3072' + active: "1" + aliases: "400" + backupmx: "1" + defquota: "3072" description: domain description - gal: '1' + gal: "1" lang: cs - mailboxes: '10' - maxquota: '10240' - quota: '10240' - relay_all_recipients: '0' - relayhost: '2' + mailboxes: "10" + maxquota: "10240" + quota: "10240" + relay_all_recipients: "0" + relayhost: "2" items: domain.tld properties: attr: @@ -2691,11 +2691,11 @@ paths: /api/v1/edit/fail2ban: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: - '*/*': + "*/*": schema: properties: log: @@ -2726,12 +2726,12 @@ paths: schema: example: attr: - ban_time: '86400' - blacklist: '10.100.6.5/32,10.100.8.4/32' - max_attempts: '5' - netban_ipv4: '24' - netban_ipv6: '64' - retry_window: '600' + ban_time: "86400" + blacklist: "10.100.6.5/32,10.100.8.4/32" + max_attempts: "5" + netban_ipv4: "24" + netban_ipv6: "64" + retry_window: "600" whitelist: mailcow.tld items: none properties: @@ -2769,9 +2769,9 @@ paths: /api/v1/edit/mailbox: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -2781,18 +2781,18 @@ paths: - mailbox - edit - mailbox - - active: '1' - force_pw_update: '0' + - active: "1" + force_pw_update: "0" name: Full name - password: '*' - password2: '*' - quota: '3072' + password: "*" + password2: "*" + quota: "3072" sender_acl: - default - info@domain2.tld - domain3.tld - - '*' - sogo_access: '1' + - "*" + sogo_access: "1" username: - info@domain.tld - null @@ -2830,18 +2830,18 @@ paths: schema: example: attr: - active: '1' - force_pw_update: '0' + active: "1" + force_pw_update: "0" name: Full name - password: '' - password2: '' - quota: '3072' + password: "" + password2: "" + quota: "3072" sender_acl: - default - info@domain2.tld - domain3.tld - - '*' - sogo_access: '1' + - "*" + sogo_access: "1" items: info@domain.tld properties: attr: @@ -2879,9 +2879,9 @@ paths: /api/v1/edit/mailq: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -2914,9 +2914,9 @@ paths: /api/v1/edit/pushover: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -2925,13 +2925,13 @@ paths: - log: - pushover - edit - - active: '0' - evaluate_x_prio: '0' + - active: "0" + evaluate_x_prio: "0" key: 21e8918e1jksdjcpis712 - only_x_prio: '0' - senders: '' - senders_regex: '' - text: '' + only_x_prio: "0" + senders: "" + senders_regex: "" + text: "" title: Mail token: 9023e2ohcwed27d1idu2 username: @@ -2968,13 +2968,13 @@ paths: schema: example: attr: - active: '0' - evaluate_x_prio: '0' + active: "0" + evaluate_x_prio: "0" key: 21e8918e1jksdjcpis712 - only_x_prio: '0' - senders: '' - senders_regex: '' - text: '' + only_x_prio: "0" + senders: "" + senders_regex: "" + text: "" title: Mail token: 9023e2ohcwed27d1idu2 items: info@domain.tld @@ -3017,9 +3017,9 @@ paths: /api/v1/edit/quarantine_notification: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": description: OK headers: {} tags: @@ -3059,9 +3059,9 @@ paths: /api/v1/edit/syncjob: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -3105,27 +3105,27 @@ paths: schema: example: attr: - active: '1' - automap: '1' - custom_params: '' - delete1: '0' - delete2: '0' - delete2duplicates: '1' + active: "1" + automap: "1" + custom_params: "" + delete1: "0" + delete2: "0" + delete2duplicates: "1" enc1: SSL exclude: (?i)spam|(?i)junk host1: imap.server.tld - maxage: '0' - maxbytespersecond: '0' - mins_interval: '20' + maxage: "0" + maxbytespersecond: "0" + mins_interval: "20" password1: supersecret - port1: '993' - skipcrossduplicates: '0' + port1: "993" + skipcrossduplicates: "0" subfolder2: External - subscribeall: '1' - timeout1: '600' - timeout2: '600' + subscribeall: "1" + timeout1: "600" + timeout2: "600" user1: username - items: '1' + items: "1" properties: attr: properties: @@ -3210,9 +3210,9 @@ paths: /api/v1/edit/user-acl: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -3297,7 +3297,7 @@ paths: type: object type: object summary: Update mailbox ACL - '/api/v1/get/alias/{id}': + "/api/v1/get/alias/{id}": get: parameters: - description: id of entry you want to get @@ -3308,10 +3308,10 @@ paths: schema: enum: - all - - '1' - - '2' - - '5' - - '10' + - "1" + - "2" + - "5" + - "10" type: string - description: e.g. api-key-string example: api-key-string @@ -3321,34 +3321,32 @@ paths: schema: type: string responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: response: value: - - active: '✔' - active_int: 1 + - active: "1" address: alias@domain.tld - created: '2019-04-04 19:29:49' + created: "2019-04-04 19:29:49" domain: domain.tld goto: destination@domain.tld id: 6 - in_primary_domain: '' + in_primary_domain: "" is_catch_all: 0 modified: null private_comment: null public_comment: null - - active: '✔' - active_int: 1 - address: '@domain.tld' - created: '2019-04-27 13:42:39' + - active: "1" + address: "@domain.tld" + created: "2019-04-27 13:42:39" domain: domain.tld goto: destination@domain.tld id: 10 - in_primary_domain: '' + in_primary_domain: "" is_catch_all: 1 modified: null private_comment: null @@ -3360,7 +3358,7 @@ paths: description: You can list mailbox aliases existing in system. operationId: Get aliases summary: Get aliases - '/api/v1/get/app-passwd/all/{mailbox}': + "/api/v1/get/app-passwd/all/{mailbox}": get: parameters: - description: mailbox of entry you want to get @@ -3380,17 +3378,16 @@ paths: schema: type: string responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: response: value: - - active: '✓' - active_int: 1 - created: '2019-12-21 16:04:55' + - active: "1" + created: "2019-12-21 16:04:55" domain: mailcow.email id: 2 mailbox: hello@mailcow.email @@ -3405,7 +3402,7 @@ paths: mailbox. operationId: Get App Password summary: Get App Password - '/api/v1/get/bcc/{id}': + "/api/v1/get/bcc/{id}": get: parameters: - description: id of entry you want to get @@ -3416,10 +3413,10 @@ paths: schema: enum: - all - - '1' - - '2' - - '5' - - '10' + - "1" + - "2" + - "5" + - "10" type: string - description: e.g. api-key-string example: api-key-string @@ -3429,21 +3426,20 @@ paths: schema: type: string responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: response: value: - - active: '✓' - active_int: 1 + - active: "1" bcc_dest: bcc@awesomecow.tld - created: '2019-10-02 21:44:34' + created: "2019-10-02 21:44:34" domain: mailcow.tld id: 3 - local_dest: '@mailcow.tld' + local_dest: "@mailcow.tld" modified: null type: sender description: OK @@ -3453,7 +3449,7 @@ paths: description: Using this endpoint you can get all BCC maps. operationId: Get BCC Map summary: Get BCC Map - '/api/v1/get/dkim/{domain}': + "/api/v1/get/dkim/{domain}": get: parameters: - description: name of domain @@ -3470,9 +3466,9 @@ paths: schema: type: string responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -3481,8 +3477,8 @@ paths: dkim_selector: dkim dkim_txt: >- v=DKIM1;k=rsa;t=s;s=email;p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA21tUSjyasQy/hJmVjPnlRGfzx6TPhYj8mXY9DVOzSAE64Gddw/GnE/GcCR6WXNT23u9q4zPnz1IPoNt5kFOps8vg/iNqrcH++494noaZuYyFPPFnebkfryO4EvEyxC/c66qts+gnOUml+M8uv5WObBJld2gG12jLwFM0263J/N6J8LuUsaXOB2uCIfx8Nf4zjuJ6Ieez2uyHNK5dXjDLfKA4mTr+EEK6W6e34M4KN1liWM6r9Oy5S1FlLrD42VpURxxBZtBiEtaJPEKSQuk6GQz8ihu7W20Yr53tyCdaORu8dhxXVUWVf+GjuuMEdAmQCjYkarXdYCrt56Psw703kwIDAQAB - length: '2048' - privkey: '' + length: "2048" + privkey: "" pubkey: >- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA21tUSjyasQy/hJmVjPnlRGfzx6TPhYj8mXY9DVOzSAE64Gddw/GnE/GcCR6WXNT23u9q4zPnz1IPoNt5kFOps8vg/iNqrcH++494noaZuYyFPPFnebkfryO4EvEyxC/c66qts+gnOUml+M8uv5WObBJld2gG12jLwFM0263J/N6J8LuUsaXOB2uCIfx8Nf4zjuJ6Ieez2uyHNK5dXjDLfKA4mTr+EEK6W6e34M4KN1liWM6r9Oy5S1FlLrD42VpURxxBZtBiEtaJPEKSQuk6GQz8ihu7W20Yr53tyCdaORu8dhxXVUWVf+GjuuMEdAmQCjYkarXdYCrt56Psw703kwIDAQAB description: OK @@ -3497,20 +3493,19 @@ paths: /api/v1/get/domain-admin/all: get: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: response: value: - - active: '✓' - active_int: 1 - created: '2019-10-02 10:29:41' + - active: "1" + created: "2019-10-02 10:29:41" selected_domains: - mailcow.tld - tfa_active: '✕' + tfa_active: "✕" tfa_active_int: null unselected_domains: - awesomemailcow.de @@ -3520,10 +3515,10 @@ paths: headers: {} tags: - Domain admin - description: '' + description: "" operationId: Get Domain Admins summary: Get Domain Admins - '/api/v1/get/domain/{id}': + "/api/v1/get/domain/{id}": get: parameters: - description: id of entry you want to get @@ -3544,26 +3539,25 @@ paths: schema: type: string responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: response: value: - - active: '✔' - active_int: 1 + - active: "1" aliases_in_domain: 0 aliases_left: 400 - backupmx: '✘' + backupmx: "✘" backupmx_int: 0 - bytes_total: '5076666944' + bytes_total: "5076666944" def_new_mailbox_quota: 3221225472 def_quota_for_mbox: 3221225472 description: Some description domain_name: domain.tld - gal: '✘' + gal: "✘" gal_int: 0 lang: en max_new_mailbox_quota: 10737418240 @@ -3573,24 +3567,23 @@ paths: max_quota_for_mbox: 10737418240 mboxes_in_domain: 0 mboxes_left: 10 - msgs_total: '172440' - quota_used_in_domain: '0' - relay_all_recipients: '✘' + msgs_total: "172440" + quota_used_in_domain: "0" + relay_all_recipients: "✘" relay_all_recipients_int: 0 - relayhost: '0' + relayhost: "0" rl: false - - active: '✔' - active_int: 1 + - active: "1" aliases_in_domain: 0 aliases_left: 400 - backupmx: '✔' + backupmx: "1" backupmx_int: 1 - bytes_total: '5076666944' + bytes_total: "5076666944" def_new_mailbox_quota: 3221225472 def_quota_for_mbox: 3221225472 description: domain description domain_name: domain2.tld - gal: '✘' + gal: "✘" gal_int: 0 lang: cs max_new_mailbox_quota: 10737418240 @@ -3600,11 +3593,11 @@ paths: max_quota_for_mbox: 10737418240 mboxes_in_domain: 0 mboxes_left: 10 - msgs_total: '172440' - quota_used_in_domain: '0' - relay_all_recipients: '✘' + msgs_total: "172440" + quota_used_in_domain: "0" + relay_all_recipients: "✘" relay_all_recipients_int: 0 - relayhost: '0' + relayhost: "0" rl: false description: OK headers: {} @@ -3616,9 +3609,9 @@ paths: /api/v1/get/fail2ban: get: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -3646,19 +3639,19 @@ paths: /api/v1/get/fwdhost/all: get: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: response: value: - host: 5.1.76.202 - keep_spam: 'yes' + keep_spam: "yes" source: hosted.mailcow.de - - host: '2a00:f820:417::202' - keep_spam: 'yes' + - host: "2a00:f820:417::202" + keep_spam: "yes" source: hosted.mailcow.de description: OK headers: {} @@ -3667,7 +3660,7 @@ paths: description: You can list all Forwarding Hosts in your mailcow. operationId: Get Forwarding Hosts summary: Get Forwarding Hosts - '/api/v1/get/logs/acme/{count}': + "/api/v1/get/logs/acme/{count}": get: parameters: - description: Number of logs to return @@ -3684,9 +3677,9 @@ paths: schema: type: string responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -3695,7 +3688,7 @@ paths: - message: >- Certificate validation done, neither changed nor due for renewal, sleeping for another day. - time: '1569927728' + time: "1569927728" description: OK headers: {} tags: @@ -3708,7 +3701,7 @@ paths: the end of the api url. operationId: Get ACME logs summary: Get ACME logs - '/api/v1/get/logs/api/{count}': + "/api/v1/get/logs/api/{count}": get: parameters: - description: Number of logs to return @@ -3725,15 +3718,15 @@ paths: schema: type: string responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: response: value: - - data: '' + - data: "" method: GET remote: 1.1.1.1 time: 1569939001 @@ -3749,7 +3742,7 @@ paths: the end of the api url. operationId: Get Api logs summary: Get Api logs - '/api/v1/get/logs/autodiscover/{count}': + "/api/v1/get/logs/autodiscover/{count}": get: parameters: - description: Number of logs to return @@ -3766,9 +3759,9 @@ paths: schema: type: string responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -3791,7 +3784,7 @@ paths: the end of the api url. operationId: Get Autodiscover logs summary: Get Autodiscover logs - '/api/v1/get/logs/dovecot/{count}': + "/api/v1/get/logs/dovecot/{count}": get: parameters: - description: Number of logs to return @@ -3808,9 +3801,9 @@ paths: schema: type: string responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -3821,7 +3814,7 @@ paths: secs): user=<>, rip=172.22.1.3, lip=172.22.1.250 priority: info program: dovecot - time: '1569938740' + time: "1569938740" description: OK headers: {} tags: @@ -3833,7 +3826,7 @@ paths: the end of the api url. operationId: Get Dovecot logs summary: Get Dovecot logs - '/api/v1/get/logs/netfilter/{count}': + "/api/v1/get/logs/netfilter/{count}": get: parameters: - description: Number of logs to return @@ -3850,15 +3843,15 @@ paths: schema: type: string responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: response: value: - - message: 'Whitelist was changed, it has 1 entries' + - message: "Whitelist was changed, it has 1 entries" priority: info time: 1569754911 - message: Add host/network 1.1.1.1/32 to blacklist @@ -3875,7 +3868,7 @@ paths: the end of the api url. operationId: Get Netfilter logs summary: Get Netfilter logs - '/api/v1/get/logs/postfix/{count}': + "/api/v1/get/logs/postfix/{count}": get: parameters: - description: Number of logs to return @@ -3892,18 +3885,18 @@ paths: schema: type: string responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: response: value: - - message: 'EF1711500458: removed' + - message: "EF1711500458: removed" priority: info program: postfix/qmgr - time: '1569937433' + time: "1569937433" description: OK headers: {} tags: @@ -3915,7 +3908,7 @@ paths: the end of the api url. operationId: Get Postfix logs summary: Get Postfix logs - '/api/v1/get/logs/ratelimited/{count}': + "/api/v1/get/logs/ratelimited/{count}": get: parameters: - description: Number of logs to return @@ -3932,9 +3925,9 @@ paths: schema: type: string responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -3963,7 +3956,7 @@ paths: the end of the api url. operationId: Get Ratelimit logs summary: Get Ratelimit logs - '/api/v1/get/logs/rspamd-history/{count}': + "/api/v1/get/logs/rspamd-history/{count}": get: parameters: - description: Number of logs to return @@ -3980,9 +3973,9 @@ paths: schema: type: string responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": description: OK headers: {} tags: @@ -3994,7 +3987,7 @@ paths: the end of the api url. operationId: Get Rspamd logs summary: Get Rspamd logs - '/api/v1/get/logs/sogo/{count}': + "/api/v1/get/logs/sogo/{count}": get: parameters: - description: Number of logs to return @@ -4011,9 +4004,9 @@ paths: schema: type: string responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -4025,7 +4018,7 @@ paths: "GET /SOGo.index/ HTTP/1.1" 200 2531/0 0.005 - - 0 priority: notice program: sogod - time: '1569938874' + time: "1569938874" description: OK headers: {} tags: @@ -4037,7 +4030,7 @@ paths: the end of the api url. operationId: Get SOGo logs summary: Get SOGo logs - '/api/v1/get/logs/watchdog/{count}': + "/api/v1/get/logs/watchdog/{count}": get: parameters: - description: Number of logs to return @@ -4054,26 +4047,26 @@ paths: schema: type: string responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: response: value: - - hpdiff: '0' - hpnow: '1' - hptotal: '1' - lvl: '100' + - hpdiff: "0" + hpnow: "1" + hptotal: "1" + lvl: "100" service: Fail2ban - time: '1569938958' - - hpdiff: '0' - hpnow: '5' - hptotal: '5' - lvl: '100' + time: "1569938958" + - hpdiff: "0" + hpnow: "5" + hptotal: "5" + lvl: "100" service: Rspamd - time: '1569938956' + time: "1569938956" description: OK headers: {} tags: @@ -4085,7 +4078,7 @@ paths: the end of the api url. operationId: Get Watchdog logs summary: Get Watchdog logs - '/api/v1/get/mailbox/{id}': + "/api/v1/get/mailbox/{id}": get: parameters: - description: id of entry you want to get @@ -4106,23 +4099,22 @@ paths: schema: type: string responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: response: value: - - active: '✔' - active_int: 1 + - active: "1" attributes: - force_pw_update: '0' - mailbox_format: 'maildir:' + force_pw_update: "0" + mailbox_format: "maildir:" quarantine_notification: never - sogo_access: '1' - tls_enforce_in: '0' - tls_enforce_out: '0' + sogo_access: "1" + tls_enforce_in: "0" + tls_enforce_out: "0" domain: doman3.tld is_relayed: 0 local_part: info @@ -4146,9 +4138,9 @@ paths: /api/v1/get/mailq/all: get: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -4168,7 +4160,7 @@ paths: description: Get the current mail queue and everything it contains. operationId: Get Queue summary: Get Queue - '/api/v1/get/oauth2-client/{id}': + "/api/v1/get/oauth2-client/{id}": get: parameters: - description: id of entry you want to get @@ -4179,10 +4171,10 @@ paths: schema: enum: - all - - '1' - - '2' - - '5' - - '10' + - "1" + - "2" + - "5" + - "10" type: string - description: e.g. api-key-string example: api-key-string @@ -4192,9 +4184,9 @@ paths: schema: type: string responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -4204,7 +4196,7 @@ paths: client_secret: 73fc668a88147e32a31ff80c grant_types: null id: 1 - redirect_uri: 'https://mailcow.tld' + redirect_uri: "https://mailcow.tld" scope: profile user_id: null description: OK @@ -4214,7 +4206,7 @@ paths: description: Using this endpoint you can get all oAuth clients. operationId: Get oAuth Clients summary: Get oAuth Clients - '/api/v1/get/policy_bl_domain/{domain}': + "/api/v1/get/policy_bl_domain/{domain}": get: parameters: - description: name of domain @@ -4231,9 +4223,9 @@ paths: schema: type: string responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -4241,7 +4233,7 @@ paths: value: - object: domain.tld prefid: 2 - value: '*@baddomain.tld' + value: "*@baddomain.tld" description: OK headers: {} tags: @@ -4249,7 +4241,7 @@ paths: description: You can list all blacklist policies per domain. operationId: List blacklist domain policy summary: List blacklist domain policy - '/api/v1/get/policy_wl_domain/{domain}': + "/api/v1/get/policy_wl_domain/{domain}": get: parameters: - description: name of domain @@ -4266,9 +4258,9 @@ paths: schema: type: string responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -4276,7 +4268,7 @@ paths: value: - object: domain.tld prefid: 1 - value: '*@gooddomain.tld' + value: "*@gooddomain.tld" description: OK headers: {} tags: @@ -4287,9 +4279,9 @@ paths: /api/v1/get/quarantine/all: get: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -4311,7 +4303,7 @@ paths: description: Get all mails that are currently in Quarantine. operationId: Get mails in Quarantine summary: Get mails in Quarantine - '/api/v1/get/recipient_map/{id}': + "/api/v1/get/recipient_map/{id}": get: parameters: - description: id of entry you want to get @@ -4322,10 +4314,10 @@ paths: schema: enum: - all - - '1' - - '2' - - '5' - - '10' + - "1" + - "2" + - "5" + - "10" type: string - description: e.g. api-key-string example: api-key-string @@ -4335,17 +4327,16 @@ paths: schema: type: string responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: response: value: - - active: '✓' - active_int: 1 - created: '2019-10-02 22:06:29' + - active: "1" + created: "2019-10-02 22:06:29" id: 3 modified: null recipient_map_new: target@mailcow.tld @@ -4357,7 +4348,7 @@ paths: description: Using this endpoint you can get all recipient maps. operationId: Get Recipient Map summary: Get Recipient Map - '/api/v1/get/relayhost/{id}': + "/api/v1/get/relayhost/{id}": get: parameters: - description: id of entry you want to get @@ -4368,10 +4359,10 @@ paths: schema: enum: - all - - '1' - - '2' - - '5' - - '10' + - "1" + - "2" + - "5" + - "10" type: string - description: e.g. api-key-string example: api-key-string @@ -4381,21 +4372,20 @@ paths: schema: type: string responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: response: value: - - active: '✓' - active_int: 1 - hostname: 'mailcow.tld:25' + - active: "1" + hostname: "mailcow.tld:25" id: 1 password: supersecurepassword password_short: tes... - used_by_domains: '' + used_by_domains: "" username: testuser description: OK headers: {} @@ -4407,16 +4397,15 @@ paths: /api/v1/get/resource/all: get: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: response: value: - - active: '✓' - active_int: 1 + - active: "1" description: test domain: mailcow.tld kind: location @@ -4430,7 +4419,7 @@ paths: description: Using this endpoint you can get all Resources. operationId: Get Resources summary: Get Resources - '/api/v1/get/rl-mbox/{mailbox}': + "/api/v1/get/rl-mbox/{mailbox}": get: parameters: - description: name of mailbox or all @@ -4447,9 +4436,9 @@ paths: schema: type: string responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -4457,10 +4446,10 @@ paths: value: - frame: s mailbox: leon@mailcow.tld - value: '5' + value: "5" - frame: s mailbox: lisa@mailcow.tld - value: '3' + value: "3" description: OK headers: {} tags: @@ -4470,7 +4459,7 @@ paths: You can use all for all mailboxes. operationId: Get mailbox ratelimits summary: Get mailbox ratelimits - '/api/v1/get/rl-domain/{domain}': + "/api/v1/get/rl-domain/{domain}": get: parameters: - description: name of domain or all @@ -4487,9 +4476,9 @@ paths: schema: type: string responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -4497,10 +4486,10 @@ paths: value: - frame: s domain: domain.tld - value: '5' + value: "5" - frame: s mailbox: domain2.tld - value: '3' + value: "3" description: OK headers: {} tags: @@ -4513,9 +4502,9 @@ paths: /api/v1/edit/rl-mbox/: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -4523,16 +4512,16 @@ paths: value: - type: success log: - - ratelimit - - edit - - mailbox - - object: - - info@domain.tld - rl_value: "10" - rl_frame: h + - ratelimit + - edit + - mailbox + - object: + - info@domain.tld + rl_value: "10" + rl_frame: h msg: - - rl_saved - - info@domain.tld + - rl_saved + - info@domain.tld schema: properties: log: @@ -4583,9 +4572,9 @@ paths: /api/v1/edit/rl-domain/: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -4597,7 +4586,7 @@ paths: - edit - domain - object: - - domain.tld + - domain.tld rl_value: "50" rl_frame: "h" msg: @@ -4653,9 +4642,9 @@ paths: /api/v1/get/status/containers: get: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -4663,110 +4652,110 @@ paths: value: acme-mailcow: container: acme-mailcow - image: 'mailcow/acme:1.63' - started_at: '2019-12-22T21:00:08.270660275Z' + image: "mailcow/acme:1.63" + started_at: "2019-12-22T21:00:08.270660275Z" state: running type: info clamd-mailcow: container: clamd-mailcow - image: 'mailcow/clamd:1.35' - started_at: '2019-12-22T21:00:01.622856172Z' + image: "mailcow/clamd:1.35" + started_at: "2019-12-22T21:00:01.622856172Z" state: running type: info dockerapi-mailcow: container: dockerapi-mailcow - image: 'mailcow/dockerapi:1.36' - started_at: '2019-12-22T20:59:59.984797808Z' + image: "mailcow/dockerapi:1.36" + started_at: "2019-12-22T20:59:59.984797808Z" state: running type: info dovecot-mailcow: container: dovecot-mailcow - image: 'mailcow/dovecot:1.104' - started_at: '2019-12-22T21:00:08.988680259Z' + image: "mailcow/dovecot:1.104" + started_at: "2019-12-22T21:00:08.988680259Z" state: running type: info ipv6nat-mailcow: container: ipv6nat-mailcow image: robbertkl/ipv6nat - started_at: '2019-12-22T21:06:37.273225445Z' + started_at: "2019-12-22T21:06:37.273225445Z" state: running type: info memcached-mailcow: container: memcached-mailcow - image: 'memcached:alpine' - started_at: '2019-12-22T20:59:58.0907785Z' + image: "memcached:alpine" + started_at: "2019-12-22T20:59:58.0907785Z" state: running type: info mysql-mailcow: container: mysql-mailcow - image: 'mariadb:10.3' - started_at: '2019-12-22T21:00:02.201937528Z' + image: "mariadb:10.3" + started_at: "2019-12-22T21:00:02.201937528Z" state: running type: info netfilter-mailcow: container: netfilter-mailcow - image: 'mailcow/netfilter:1.31' - started_at: '2019-12-22T21:00:09.851559297Z' + image: "mailcow/netfilter:1.31" + started_at: "2019-12-22T21:00:09.851559297Z" state: running type: info nginx-mailcow: container: nginx-mailcow - image: 'nginx:mainline-alpine' - started_at: '2019-12-22T21:00:12.9843038Z' + image: "nginx:mainline-alpine" + started_at: "2019-12-22T21:00:12.9843038Z" state: running type: info olefy-mailcow: container: olefy-mailcow - image: 'mailcow/olefy:1.2' - started_at: '2019-12-22T20:59:59.676259274Z' + image: "mailcow/olefy:1.2" + started_at: "2019-12-22T20:59:59.676259274Z" state: running type: info php-fpm-mailcow: container: php-fpm-mailcow - image: 'mailcow/phpfpm:1.55' - started_at: '2019-12-22T21:00:00.955808957Z' + image: "mailcow/phpfpm:1.55" + started_at: "2019-12-22T21:00:00.955808957Z" state: running type: info postfix-mailcow: container: postfix-mailcow - image: 'mailcow/postfix:1.44' - started_at: '2019-12-22T21:00:07.186717617Z' + image: "mailcow/postfix:1.44" + started_at: "2019-12-22T21:00:07.186717617Z" state: running type: info redis-mailcow: container: redis-mailcow - image: 'redis:5-alpine' - started_at: '2019-12-22T20:59:56.827166834Z' + image: "redis:5-alpine" + started_at: "2019-12-22T20:59:56.827166834Z" state: running type: info rspamd-mailcow: container: rspamd-mailcow - image: 'mailcow/rspamd:1.56' - started_at: '2019-12-22T21:00:12.456075355Z' + image: "mailcow/rspamd:1.56" + started_at: "2019-12-22T21:00:12.456075355Z" state: running type: info sogo-mailcow: container: sogo-mailcow - image: 'mailcow/sogo:1.65' - started_at: '2019-12-22T20:59:58.382274592Z' + image: "mailcow/sogo:1.65" + started_at: "2019-12-22T20:59:58.382274592Z" state: running type: info solr-mailcow: container: solr-mailcow - image: 'mailcow/solr:1.7' - started_at: '2019-12-22T20:59:59.635413798Z' + image: "mailcow/solr:1.7" + started_at: "2019-12-22T20:59:59.635413798Z" state: running type: info unbound-mailcow: container: unbound-mailcow - image: 'mailcow/unbound:1.10' - started_at: '2019-12-22T20:59:58.760595825Z' + image: "mailcow/unbound:1.10" + started_at: "2019-12-22T20:59:58.760595825Z" state: running type: info watchdog-mailcow: container: watchdog-mailcow - image: 'mailcow/watchdog:1.65' - started_at: '2019-12-22T20:59:56.028660382Z' + image: "mailcow/watchdog:1.65" + started_at: "2019-12-22T20:59:56.028660382Z" state: running type: info description: OK @@ -4781,9 +4770,9 @@ paths: /api/v1/get/status/solr: get: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -4805,9 +4794,9 @@ paths: /api/v1/get/status/vmail: get: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -4830,38 +4819,37 @@ paths: /api/v1/get/syncjobs/all/no_log: get: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: response: value: - - active: '✓' - active_int: 1 + - active: "1" authmd51: 0 authmech1: PLAIN automap: 1 - created: '2019-05-22 11:37:25' - custom_params: '' + created: "2019-05-22 11:37:25" + custom_params: "" delete1: 0 delete2: 0 delete2duplicates: 1 - domain2: '' + domain2: "" enc1: TLS exclude: (?i)spam|(?i)junk host1: imap.server.tld id: 1 is_running: 0 - last_run: '2019-05-22 11:40:02' - log: '' + last_run: "2019-05-22 11:40:02" + log: "" maxage: 0 - maxbytespersecond: '0' - mins_interval: '20' - modified: '2019-05-22 11:40:02' + maxbytespersecond: "0" + mins_interval: "20" + modified: "2019-05-22 11:40:02" port1: 993 - regextrans2: '' + regextrans2: "" skipcrossduplicates: 0 subfolder2: External subscribeall: 1 @@ -4876,7 +4864,7 @@ paths: description: You can list all syn jobs existing in system. operationId: Get sync jobs summary: Get sync jobs - '/api/v1/get/tls-policy-map/{id}': + "/api/v1/get/tls-policy-map/{id}": get: parameters: - description: id of entry you want to get @@ -4887,10 +4875,10 @@ paths: schema: enum: - all - - '1' - - '2' - - '5' - - '10' + - "1" + - "2" + - "5" + - "10" type: string - description: e.g. api-key-string example: api-key-string @@ -4900,18 +4888,17 @@ paths: schema: type: string responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: response: value: - - parameters: '' - active: '✓' - active_int: 1 - created: '2019-10-03 08:42:12' + - parameters: "" + active: "1" + created: "2019-10-03 08:42:12" dest: mailcow.tld id: 1 modified: null @@ -4923,7 +4910,7 @@ paths: description: Using this endpoint you can get all TLS policy map override maps. operationId: Get TLS Policy Map summary: Get TLS Policy Map - '/api/v1/get/transport/{id}': + "/api/v1/get/transport/{id}": get: parameters: - description: id of entry you want to get @@ -4934,10 +4921,10 @@ paths: schema: enum: - all - - '1' - - '2' - - '5' - - '10' + - "1" + - "2" + - "5" + - "10" type: string - description: e.g. api-key-string example: api-key-string @@ -4947,21 +4934,20 @@ paths: schema: type: string responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: response: value: - - active: '✓' - active_int: 1 + - active: "1" destination: example.org id: 1 - lookup_mx: '✕' + lookup_mx: "✕" lookup_mx_int: 0 - nexthop: 'host:25' + nexthop: "host:25" password: supersecurepw password_short: sup... username: testuser @@ -4975,9 +4961,9 @@ paths: /api/v1/edit/spam-score/: post: responses: - '401': - $ref: '#/components/responses/Unauthorized' - '200': + "401": + $ref: "#/components/responses/Unauthorized" + "200": content: application/json: examples: @@ -4985,15 +4971,15 @@ paths: value: - type: success log: - - mailbox - - edit - - spam_score - - username: - - info@domain.tld - spam_score: '8,15' + - mailbox + - edit + - spam_score + - username: + - info@domain.tld + spam_score: "8,15" msg: - - mailbox_modified - - info@domain.tld + - mailbox_modified + - info@domain.tld schema: properties: log: @@ -5023,9 +5009,9 @@ paths: schema: example: - items: - - info@domain.tld + - info@domain.tld attr: - spam_score: '8,15' + spam_score: "8,15" summary: Edit mailbox spam filter score tags: