Overview

grommunio Admin API 1.20.0

Grommunio administration REST API

Operations

The Admin API is organised into the following operation groups. Select an operation for full request/response details and ready-to-copy code samples.

System Admin/Dashboard

GET Get System dashboard data — /system/dashboard
GET Get list of services — /system/dashboard/services
GET Get information about a specific service — /system/dashboard/services/{unit}
POST Send signal to a service — /system/dashboard/services/{unit}/{action}

System Admin/DBConf

GET Get list of services — /system/dbconf/
GET Get lists of allowed commit commands — /system/dbconf/commands
GET Get list of configuration files for service — /system/dbconf/{service}/
PATCH Rename or merge service — /system/dbconf/{service}/
DELETE Delete service configurations — /system/dbconf/{service}/
GET Get configuration file — /system/dbconf/{service}/{file}/
PUT Upload configuration file. If the file exists it is overwritten — /system/dbconf/{service}/{file}/
PATCH Update or rename configuration file — /system/dbconf/{service}/{file}/
DELETE Delete configuration file — /system/dbconf/{service}/{file}/

System Admin/Domains

GET Get lists of domains — /system/domains
POST Create new domain — /system/domains
GET Get detailed info about domain — /system/domains/{domainID}
PATCH Update domain — /system/domains/{domainID}
DELETE Delete domain — /system/domains/{domainID}
GET Get list of all users — /system/users

System Admin/License

GET Get information about the currently installed License — /system/license
PUT Upload new license file — /system/license
GET downloadCert — /system/license/certificate.pem
GET getLicenseCredentials — /system/license/creds
PUT setLicenseCredentials — /system/license/creds

System Admin/Logs

GET Get available log files — /system/logs
GET Get log file content — /system/logs/{file}
GET Get update log file — /system/updateLog/{pid}

System Admin/MConf

GET Get the current authmgr configuration — /system/mconf/authmgr
PUT Set new authmgr configuration — /system/mconf/authmgr
DELETE Reset authmgr configuration to default — /system/mconf/authmgr

System Admin/Organizations

GET Get a list of organizations — /system/orgs
POST Create new organization — /system/orgs
GET Get detailed information about an organization — /system/orgs/{ID}
PATCH Update organization — /system/orgs/{ID}
DELETE Delete organization — /system/orgs/{ID}
GET Get organization specific LDAP configuration — /system/orgs/{ID}/ldap
PUT Set organization specific LDAP configuration — /system/orgs/{ID}/ldap
DELETE Reset organization specific LDAP configuration — /system/orgs/{ID}/ldap

System Admin/Proxies

GET Make call to grommunio-antispam — /system/antispam/{path}
GET Get list of vhosts — /system/vhostStatus
GET Make call nginx vhost status endpoint — /system/vhostStatus/{host}

System Admin/Roles

GET Get list of available permissions — /system/roles/permissions
GET Get list of available roles — /system/roles
POST Create a new role — /system/roles
GET Get role — /system/roles/{ID}
PATCH Update a role — /system/roles/{ID}
DELETE Delete role — /system/roles/{ID}
PATCH Update user roles — /domains/{domainID}/users/{userID}/roles

System Admin/Servers

GET Get a list of servers — /system/servers
POST Register a new server — /system/servers
GET Get detailed information about a server — /system/servers/{ID}
PATCH Update server — /system/servers/{ID}
DELETE Delete server — /system/servers/{ID}
GET Get a dns check result for all servers — /system/servers/dnsCheck

Domain Admin/Folders

GET Get list of public folders — /domains/{domainID}/folders
POST Create a new public folder — /domains/{domainID}/folders
GET Get hierarchical view of folders — /domains/{domainID}/folders/tree
GET Get public folder — /domains/{domainID}/folders/{folderID}
PATCH Update public folder — /domains/{domainID}/folders/{folderID}
DELETE Delete public folder — /domains/{domainID}/folders/{folderID}
GET Get list of folder owners — /domains/{domainID}/folders/{folderID}/owners
POST Add a user to the owner list — /domains/{domainID}/folders/{folderID}/owners
PUT Set folder member permissions — /domains/{domainID}/folders/{folderID}/owners/{memberID}
DELETE Remove a user from the owner list — /domains/{domainID}/folders/{folderID}/owners/{memberID}

Domain Admin/MLists

GET Get list of mailing lists — /domains/{domainID}/mlists
POST Create new mailing list — /domains/{domainID}/mlists
GET Get information about a mailing list — /domains/{domainID}/mlists/{ID}
PATCH Update mailing list — /domains/{domainID}/mlists/{ID}
DELETE Delete mailing list — /domains/{domainID}/mlists/{ID}

Domain Admin/Users

GET Get lists of users — /domains/{domainID}/users
POST Create new user — /domains/{domainID}/users
GET Get information about a specific user — /domains/{domainID}/users/{userID}
PATCH Update user — /domains/{domainID}/users/{userID}
DELETE Delete user — /domains/{domainID}/users/{userID}
GET Get list of users that can send mails on the users behalf — /domains/{domainID}/users/{userID}/delegates
PUT Set list of users that can send mails on the users behalf — /domains/{domainID}/users/{userID}/delegates
GET Get list of users that can send mails as the user — /domains/{domainID}/users/{userID}/sendas
PUT Set list of users that can send mails as the user — /domains/{domainID}/users/{userID}/sendas
GET Get user store properties — /domains/{domainID}/users/{userID}/storeProps
PATCH Update store properties — /domains/{domainID}/users/{userID}/storeProps
DELETE Delete user store props — /domains/{domainID}/users/{userID}/storeProps
GET Get status of synced devices — /domains/{domainID}/users/{userID}/sync
DELETE Remove device states — /domains/{domainID}/users/{userID}/sync
DELETE Remove device (issue a resync) — /domains/{domainID}/users/{userID}/sync/{deviceID}
PUT Request a device resync — /domains/{domainID}/users/{userID}/sync/{deviceID}/resync
POST Request a device wipe — /domains/{domainID}/users/{userID}/sync/{deviceID}/wipe
DELETE Cancel wipe request — /domains/{domainID}/users/{userID}/sync/{deviceID}/wipe
GET Get list of users that can access the users store — /domains/{domainID}/users/{userID}/storeAccess
POST Grant store access to another user — /domains/{domainID}/users/{userID}/storeAccess
PUT Overwrite the list of users with store access — /domains/{domainID}/users/{userID}/storeAccess
DELETE Remove user from store access list — /domains/{domainID}/users/{userID}/storeAccess/{username}
PUT Set user password — /domains/{domainID}/users/{userID}/password
PUT Update user from LDAP — /domains/{domainID}/users/{userID}/downsync
GET Get user’s out of office state — /domains/{domainID}/users/{userID}/oof
PUT Set user’s out of office state — /domains/{domainID}/users/{userID}/oof
GET Get effective domain sync policy — /domains/{domainID}/syncPolicy

Defaults

GET Get default create parameters — /defaults/createParams
PUT Replace create default parameters — /defaults/createParams
PATCH Update create default parameters — /defaults/createParams
GET Get default create parameter overrides for domain — /defaults/createParams/{domainID}
PUT Replace create default parameter overrides for domain — /defaults/createParams/{domainID}
PATCH Update create default parameter overrides for domain — /defaults/createParams/{domainID}
GET Get list of available user store languages — /defaults/storeLangs

LDAP

GET Perform LDAP user search — /domains/ldap/search
POST Import user from ldap — /domains/ldap/importUser
GET Check status of ldap imported users — /domains/ldap/check
DELETE Check status of ldap import users and delete orphaned — /domains/ldap/check
POST Update all LDAP imported users — /domains/ldap/downsync
POST Update all LDAP imported users in this domain — /domains/{domainID}/ldap/downsync
GET Dump LDAP object — /domains/ldap/dump
GET Get the current LDAP configuration — /system/mconf/ldap
PUT Set new LDAP configuration — /system/mconf/ldap
DELETE Remove LDAP configuration and disable service — /system/mconf/ldap
POST Update all LDAP imported users in this organization — /system/orgs/{ID}/ldap/downsync

Service

GET Get sync policy for specific user — /service/syncPolicy/{username}
GET Get device wipe status for user — /service/wipe/{username}
POST Set device wipe status for user — /service/wipe/{username}
GET Get device last connect time for user — /service/lastconnect/{username}
GET Get basic user information — /service/userinfo/{username}

TasQ

POST Notify the TasQ server of externally added tasks — /tasq/notify
GET Get current status of the TasQ system — /tasq/status
POST Start the builtin TasQ server — /tasq/start
POST Stop the builtin TasQ server — /tasq/stop
GET Get list of currently running tasks — /tasq/tasks
GET Get information about a specific task — /tasq/tasks/{ID}
DELETE Delete task — /tasq/tasks/{ID}
POST Cancel task in tasq — /tasq/tasks/{ID}/cancel

Misc

GET Check API connectivity and status — /status
GET Get general information about the backend — /about
POST Login user — /login
GET Get information about currently logged in user — /profile
PUT Change current users password — /passwd
PUT Change user password — /passwd/{username}
GET Get list of usernames — /users
GET Retrieve mailq output — /system/mailq
POST Flush postfix mail queue — /system/mailq/flush
POST Delete entries from postfix mail queue — /system/mailq/delete
POST Requeue entries from postfix mail queue — /system/mailq/requeue
GET Check format of input — /chkFormat
POST Remote CLI invocation — /system/cli
GET Get grommunio-sync usage information — /system/sync/top
GET Get list of domains the user has access to — /domains
GET Get detailed dns check for domain — /domains/{domainID}/dnsCheck
POST TODO — /domains/{domainID}/generateDkimKeys

exmdb

GET User folder tree — /system/exmdb/{username}/folders
GET Get user folder details — /system/exmdb/{username}/folders/{fid}
POST Add new member — /system/exmdb/{username}/folders/{fid}/permissions
DELETE Add new member — /system/exmdb/{username}/folders/{fid}/permissions

Other

POST Run script to check for available updates — /system/updates/{command}

Information

OpenAPI version: 3.0.0

Authentication

JWTCookie

Security scheme type: apiKey

Cookie parameter name: grommunioAuthJwt