/
MO
modoboa
/
Modoboa API
Search skmtc…
⌘K
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Subscribe
v1
latest
OpenAPI 3.0.3
2026-07-17
226
134
463.9 KB
accessrules
AccessRule viewset.
get
/api/v2/accessrules/
Response
AccessRule[]
required
pk
integer
required
mailbox
Mailbox
required
Mailbox serializer.
calendar
integer
required
read
boolean
write
boolean
All 226 operations
get
/api/v2/accessrules/
post
/api/v2/accessrules/
get
/api/v2/accessrules/{id}/
put
/api/v2/accessrules/{id}/
delete
/api/v2/accessrules/{id}/
patch
/api/v2/accessrules/{id}/
get
/api/v2/account/api_token/
post
/api/v2/account/api_token/
delete
/api/v2/account/api_token/
get
/api/v2/account/armessage/
put
/api/v2/account/armessage/
get
/api/v2/account/available_applications/
get
/api/v2/account/filtersets/
post
/api/v2/account/filtersets/
put
/api/v2/account/filtersets/{id}/
delete
/api/v2/account/filtersets/{id}/
post
/api/v2/account/filtersets/{id}/activate/
get
/api/v2/account/filtersets/{id}/download/
get
/api/v2/account/filtersets/{id}/filters/
post
/api/v2/account/filtersets/{id}/filters/
put
/api/v2/account/filtersets/{id}/filters/{filter}/
delete
/api/v2/account/filtersets/{id}/filters/{filter}/
post
/api/v2/account/filtersets/{id}/filters/{filter}/disable/
post
/api/v2/account/filtersets/{id}/filters/{filter}/enable/
post
/api/v2/account/filtersets/{id}/filters/{filter}/move_down/
post
/api/v2/account/filtersets/{id}/filters/{filter}/move_up/
get
/api/v2/account/filtersets/action_templates/
get
/api/v2/account/filtersets/condition_templates/
post
/api/v2/account/filtersets/deactivate_active/
get
/api/v2/account/forward/
post
/api/v2/account/forward/
get
/api/v2/account/me/
put
/api/v2/account/me/
post
/api/v2/account/me/password/
post
/api/v2/account/me/password/change/
post
/api/v2/account/tfa/disable/
post
/api/v2/account/tfa/reset_codes/
post
/api/v2/account/tfa/setup/
post
/api/v2/account/tfa/setup/check/
get
/api/v2/account/tfa/setup/key/
get
/api/v2/accounts/
post
/api/v2/accounts/
get
/api/v2/accounts/{id}/
put
/api/v2/accounts/{id}/
delete
/api/v2/accounts/{id}/
patch
/api/v2/accounts/{id}/
post
/api/v2/accounts/{id}/delete/
put
/api/v2/accounts/{id}/password/
get
/api/v2/accounts/exists/
get
/api/v2/accounts/random_password/
post
/api/v2/accounts/reset_password/
post
/api/v2/accounts/validate/
get
/api/v2/address-books/default/
get
/api/v2/address-books/sync_from_cdav/
get
/api/v2/address-books/sync_to_cdav/
get
/api/v2/admin/components/
get
/api/v2/admin/news_feed/
get
/api/v2/admin/statistics/
get
/api/v2/alarms/
get
/api/v2/alarms/{id}/
delete
/api/v2/alarms/{id}/
patch
/api/v2/alarms/{id}/switch/
post
/api/v2/alarms/bulk_delete/
get
/api/v2/aliases/
post
/api/v2/aliases/
get
/api/v2/aliases/{id}/
put
/api/v2/aliases/{id}/
delete
/api/v2/aliases/{id}/
patch
/api/v2/aliases/{id}/
get
/api/v2/aliases/random_address/
post
/api/v2/aliases/validate/
get
/api/v2/armessages/
post
/api/v2/armessages/
get
/api/v2/armessages/{id}/
put
/api/v2/armessages/{id}/
patch
/api/v2/armessages/{id}/
get
/api/v2/attendees/
get
/api/v2/attendees/{id}/
get
/api/v2/capabilities/
get
/api/v2/categories/
post
/api/v2/categories/
get
/api/v2/categories/{id}/
put
/api/v2/categories/{id}/
delete
/api/v2/categories/{id}/
patch
/api/v2/categories/{id}/
get
/api/v2/contacts/
post
/api/v2/contacts/
get
/api/v2/contacts/{id}/
put
/api/v2/contacts/{id}/
delete
/api/v2/contacts/{id}/
patch
/api/v2/contacts/{id}/
get
/api/v2/credentials/{account_id}/
get
/api/v2/domainaliases/
post
/api/v2/domainaliases/
get
/api/v2/domainaliases/{id}/
put
/api/v2/domainaliases/{id}/
delete
/api/v2/domainaliases/{id}/
patch
/api/v2/domainaliases/{id}/
get
Retrieve a list of domains
post
Create a new domain
get
Retrieve a particular domain
put
/api/v2/domains/{id}/
patch
/api/v2/domains/{id}/
get
/api/v2/domains/{id}/administrators/
post
/api/v2/domains/{id}/administrators/add/
post
/api/v2/domains/{id}/administrators/remove/
post
Delete a particular domain
get
/api/v2/domains/{id}/dmarc/alignment_stats/
get
/api/v2/domains/{id}/dns_detail/
get
/api/v2/domains/export/
post
/api/v2/domains/import/
get
/api/v2/email-providers/
post
/api/v2/email-providers/
get
/api/v2/email-providers/{id}/
put
/api/v2/email-providers/{id}/
delete
/api/v2/email-providers/{id}/
patch
/api/v2/email-providers/{id}/
post
/api/v2/email-providers/check_associated_domain/
post
/api/v2/email-providers/check_connection/
get
/api/v2/emails/
get
/api/v2/emails/{id}/
get
/api/v2/fido/
put
/api/v2/fido/{id}/
delete
/api/v2/fido/{id}/
patch
/api/v2/fido/{id}/
post
/api/v2/fido/registration/begin/
post
/api/v2/fido/registration/end/
get
/api/v2/identities/
get
/api/v2/identities/export/
post
/api/v2/identities/import/
get
/api/v2/languages/
get
/api/v2/logs/audit-trail/
get
/api/v2/logs/audit-trail/{id}/
get
/api/v2/logs/messages/
get
/api/v2/logs/messages/{id}/
get
/api/v2/mailboxes/
get
/api/v2/mailboxes/{id}/
get
/api/v2/migrations/
get
/api/v2/migrations/{id}/
delete
/api/v2/migrations/{id}/
get
/api/v2/notifications/
get
/api/v2/parameters/global/{id}/
put
/api/v2/parameters/global/{id}/
get
/api/v2/parameters/global/applications/
get
/api/v2/parameters/global/structure/
get
/api/v2/parameters/user/{id}/
put
/api/v2/parameters/user/{id}/
get
/api/v2/parameters/user/applications/
get
/api/v2/parameters/user/structure/
post
/api/v2/password_reset/
get
/api/v2/relaydomains/
post
/api/v2/relaydomains/
get
/api/v2/relaydomains/{id}/
put
/api/v2/relaydomains/{id}/
delete
/api/v2/relaydomains/{id}/
patch
/api/v2/relaydomains/{id}/
post
/api/v2/reset_confirm/
get
/api/v2/resources/{id}/
put
/api/v2/resources/{id}/
patch
/api/v2/resources/{id}/
get
/api/v2/senderaddresses/
post
/api/v2/senderaddresses/
get
/api/v2/senderaddresses/{id}/
put
/api/v2/senderaddresses/{id}/
delete
/api/v2/senderaddresses/{id}/
patch
/api/v2/senderaddresses/{id}/
get
/api/v2/shared-calendars/
post
/api/v2/shared-calendars/
get
/api/v2/shared-calendars/{calendar_pk}/events/
post
/api/v2/shared-calendars/{calendar_pk}/events/
get
/api/v2/shared-calendars/{calendar_pk}/events/{id}/
put
/api/v2/shared-calendars/{calendar_pk}/events/{id}/
delete
/api/v2/shared-calendars/{calendar_pk}/events/{id}/
patch
/api/v2/shared-calendars/{calendar_pk}/events/{id}/
post
/api/v2/shared-calendars/{calendar_pk}/events/import_from_file/
get
/api/v2/shared-calendars/{id}/
put
/api/v2/shared-calendars/{id}/
delete
/api/v2/shared-calendars/{id}/
patch
/api/v2/shared-calendars/{id}/
post
/api/v2/shared-calendars/check_token/
post
/api/v2/sms_totp/
get
/api/v2/statistics/
get
/api/v2/theme/
get
/api/v2/transports/
get
/api/v2/user-calendars/
post
/api/v2/user-calendars/
get
/api/v2/user-calendars/{calendar_pk}/events/
post
/api/v2/user-calendars/{calendar_pk}/events/
get
/api/v2/user-calendars/{calendar_pk}/events/{id}/
put
/api/v2/user-calendars/{calendar_pk}/events/{id}/
delete
/api/v2/user-calendars/{calendar_pk}/events/{id}/
patch
/api/v2/user-calendars/{calendar_pk}/events/{id}/
post
/api/v2/user-calendars/{calendar_pk}/events/import_from_file/
get
/api/v2/user-calendars/{id}/
put
/api/v2/user-calendars/{id}/
delete
/api/v2/user-calendars/{id}/
patch
/api/v2/user-calendars/{id}/
post
/api/v2/user-calendars/check_token/
post
/api/v2/webmail/compose-sessions/
get
/api/v2/webmail/compose-sessions/{id}/
post
/api/v2/webmail/compose-sessions/{id}/attachments/
delete
/api/v2/webmail/compose-sessions/{id}/attachments/{name}/
post
/api/v2/webmail/compose-sessions/{id}/save/
post
/api/v2/webmail/compose-sessions/{id}/send/
get
/api/v2/webmail/compose-sessions/allowed_senders/
get
/api/v2/webmail/emails/
get
/api/v2/webmail/emails/attachment/
get
/api/v2/webmail/emails/content/
post
/api/v2/webmail/emails/delete/
post
/api/v2/webmail/emails/flag/
post
/api/v2/webmail/emails/mark_as_junk/
post
/api/v2/webmail/emails/mark_as_not_junk/
post
/api/v2/webmail/emails/move/
get
/api/v2/webmail/emails/source/
get
/api/v2/webmail/mailboxes/
post
/api/v2/webmail/mailboxes/
post
/api/v2/webmail/mailboxes/compress/
post
/api/v2/webmail/mailboxes/delete/
post
/api/v2/webmail/mailboxes/empty/
get
/api/v2/webmail/mailboxes/quota/
post
/api/v2/webmail/mailboxes/rename/
get
/api/v2/webmail/mailboxes/unseen/
get
/api/v2/webmail/scheduled-messages/{id}/
put
/api/v2/webmail/scheduled-messages/{id}/
delete
/api/v2/webmail/scheduled-messages/{id}/
patch
/api/v2/webmail/scheduled-messages/{id}/