[Mimecast] This endpoint returns the summary details for an account in Mimecast. POST /api/account/get-account. Email Security Cloud Gateway, MX-based deployments only. Mimecast documents no request payload for this route. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This feed can be used to return dashboard notifications from the Administration Console Dashboard. POST /api/account/get-dashboard-notifications. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (optional). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: accountCode. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Returns the Emergency Contact information for the account. GET /account/cloud-gateway/v1/emergency-contact. Email Security Cloud Gateway. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This endpoint returns products that are available to be provisioned by a partner. POST /api/provisioning/get-packages. Email Security Cloud Gateway, MX-based deployments only. Mimecast documents no request payload for this route. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This endpoint returns support information that is associated with a Mimecast tenant. POST /api/account/get-support-info. Email Security Cloud Gateway, MX-based deployments only. Mimecast documents no request payload for this route. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Returns details of a partner, including information such as Partner type, Mimecast account code in CI, CG and X1 platform. Refer to guideline tutorial page for more information on using this endpoint. GET /identity/whoami. Email Security Cloud Gateway. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] DESTRUCTIVE: creates an Emergency Contact for the account. Why this is destructive: wholesale replace - the body becomes the entire emergency-contact record and any field omitted from it is cleared. PUT /account/cloud-gateway/v1/emergency-contact. Email Security Cloud Gateway. Send the request body as JSON (required). Documented body fields: contactName, contactEmailAddress, mobilePhone, telephone, alternateEmailAddresses. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Updates the Emergency Contact information for the account. PATCH /account/cloud-gateway/v1/emergency-contact. Email Security Cloud Gateway. Send the request body as JSON (required). Documented body fields: contactName, contactEmailAddress, mobilePhone, telephone, alternateEmailAddresses. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Create a backup snapshot of the customers Mimecast configurations for: Managed Senders, Managed URLs and Profile Groups. POST /config-snapshot/v1/create. Email Security Cloud Gateway. Send the request body as JSON (required). Documented body fields: data. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Export a backup snapshot of the customers Mimecast configurations for: Managed Senders, Managed URLs and Profile Groups. POST /config-snapshot/v1/export. Email Security Cloud Gateway. Send the request body as JSON (required). Documented body fields: data. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Get the comprehensive list of configuration snapshots for the customers Mimecast settings, including those for: Managed Senders, Managed URLs and Profile Groups. POST /config-snapshot/v1/list. Email Security Cloud Gateway. Send the request body as JSON (required). Not paginated: Mimecast documents no page parameters here, so expect the whole collection in one response - on a large tenant it can exceed the result-size cap. Documented body fields: data. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] DESTRUCTIVE: restore a backup snapshot of the customers Mimecast configurations for: Managed Senders, Managed URLs and Profile Groups. Why this is destructive: overwrites the account's LIVE configuration with the snapshot, replacing current policy and gateway settings. POST /config-snapshot/v1/restore. Email Security Cloud Gateway. Send the request body as JSON (required). Documented body fields: data. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Get one managed customer. GET /partner/v1/customers/. Email Security Cloud Gateway. Path parameters: customer_account_code. MSP discovery read for a single managed customer. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] List managed customers. GET /partner/v1/customers. Email Security Cloud Gateway. Not paginated: Mimecast documents no page parameters here, so expect the whole collection in one response - on a large tenant it can exceed the result-size cap. MSP discovery read. Returns each managed customer's accountCode, accountName, region, seatCount, industry, customerStatus and billingType. The accountCode is what every other tool's accountCode argument takes. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Retrieves the file or attachment for given id. POST /api/archive/get-file. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (required). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: id. This answers a JSON envelope, NOT the file itself: data[].urls carries short-lived pre-signed download URLs on Mimecast's own storage host. Fetch a URL yourself and promptly - StackJack proxies none of those bytes and cannot refresh an expired link. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Retrieves archived message details. POST /api/archive/get-message-detail. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (required). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Retrieves archive message list. POST /api/archive/get-message-list. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (required). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: end, includeAliases, includeDelegates, mailbox, start, view. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Retrieves the message part - HTML, plain or RFC822. POST /api/archive/get-message-part. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (required). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: context, extractFromHtml, id, mailbox, stripDangerous, stripImg, stripStyles, transposeInlineCID, type. This answers a JSON envelope, NOT the file itself: data[].urls carries short-lived pre-signed download URLs on Mimecast's own storage host. Fetch a URL yourself and promptly - StackJack proxies none of those bytes and cannot refresh an expired link. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Retrieves archive search items. POST /api/archive/search. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (required). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: admin, query. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Add messages to a smart tag. POST /dataretention/v1/smart-tags//messages. Email Security Cloud Gateway. Path parameters: smartTagId. Send the request body as JSON (required). Documented body fields: messageIds. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Get all smart tags for account. GET /dataretention/v1/smart-tags. Email Security Cloud Gateway. Optional filters: pageSize, pageToken. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Search for messages in a smart tag. POST /dataretention/v1/smart-tags//messages/search. Email Security Cloud Gateway. Path parameters: smartTagId. Optional filters: pageSize, pageToken. Send the request body as JSON (required). Documented body fields: startDateTime, endDateTime. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Set message visibility. POST /dataretention/v1/messages/visibility. Email Security Cloud Gateway. Send the request body as JSON (required). Documented body fields: visible, messageIds. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] DESTRUCTIVE: update retention adjustment for messages. Why this is destructive: it sets retainDays for the messages the body names, and retainDays: 0 purges them from the archive immediately - Mimecast keeps no copy and StackJack cannot recover them. POST /dataretention/v1/retention-adjustment. Email Security Cloud Gateway. Send the request body as JSON (required). Documented body fields: messageIds, retainDays. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Retrieves archive search logs. POST /api/archive/get-archive-search-logs. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (optional). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: query. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Retrieves the search logs. POST /api/archive/get-search-logs. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (optional). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: end, query, start. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Retrieves the email view logs. POST /api/archive/get-view-logs. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (optional). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: end, query, start. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Returns the list of audit categories available. POST /api/audit/get-categories. Email Security Cloud Gateway, MX-based deployments only. Mimecast documents no request payload for this route. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Returns the audit events matching the request. POST /api/audit/get-audit-events. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (required). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: categories, endDateTime, query, startDateTime. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This endpoint can be used to find messages that were either released to the recipient, with details about the user that processed the release. POST /api/gateway/get-held-release-logs. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (required). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: end, filterBy, searchBy, start. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This endpoint can be used to find rejected messages and the reasons for their rejection. POST /api/gateway/get-rejections. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (required). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: admin, end, mailbox, searchBy, start. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This API endpoint can be used to get Awareness Training Mime | OS Training Module user level Performance details by Department and Performance Type (data displayed on Performance > Achievements. POST /api/awareness-training/company/get-performance-details. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (optional). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: attributeIds, filterBy, includeUserDetails, searchBy. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This API endpoint can be used to get the Awareness Training Mime | OS Training Module company-level Performance Summary by total user answer count. POST /api/awareness-training/company/get-performance-summary. Email Security Cloud Gateway, MX-based deployments only. Mimecast documents no request payload for this route. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This API endpoint can be used to get Awareness Training Mime | OS SAFE Score user level details and grades, including User Risk, Human Error, Sentiment, Engagement and Knowledge. POST /api/awareness-training/company/get-safe-score-details. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (optional). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: attributeIds, filterBy, searchBy. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This API endpoint can be used to get Awareness Training Mime | OS Training SAFE Score company-level Summary by User Count per User Risk Grade. (Data displayed on Performance > User Risk Dashboard). POST /api/awareness-training/company/get-safe-score-summary. Email Security Cloud Gateway, MX-based deployments only. Mimecast documents no request payload for this route. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This API endpoint can be used to get Awareness Training Mime | OS Training Module user level Watchlist details by Department and Watchlist Type. (Data displayed on Performance > Watchlist Details). POST /api/awareness-training/company/get-watchlist-details. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (optional). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: attributeIds, filterBy, searchBy. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This API endpoint can be used to get the Awareness Training Mime | OS Training Module company-level Watchlist Summary by total user unwatched count. POST /api/awareness-training/company/get-watchlist-summary. Email Security Cloud Gateway, MX-based deployments only. Mimecast documents no request payload for this route. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Get individual risk profiles with scores. POST /human-risk/v1/individuals/risk-profiles. Email Security Cloud Gateway. Optional filters: pageToken, pageSize, monthsBack, fields. Send the request body as JSON (required). Documented body fields: ids. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Get organizational attack data. GET /human-risk/v1/organization/attacks. Email Security Cloud Gateway. Optional filters: monthsBack, fields. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Get organizational behavior data. GET /human-risk/v1/organization/behaviors. Email Security Cloud Gateway. Optional filters: monthsBack, fields. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Get organization risk trends. GET /human-risk/v1/organization. Email Security Cloud Gateway. Optional filters: monthsBack, fields. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] List departments with aggregated risk data. GET /human-risk/v1/departments. Email Security Cloud Gateway. Optional filters: orderBy, pageSize, pageToken, count. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] List locations with aggregated risk data. GET /human-risk/v1/locations. Email Security Cloud Gateway. Optional filters: orderBy, pageSize, pageToken, count. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Search individuals with risk data. POST /human-risk/v1/individuals/search. Email Security Cloud Gateway. Optional filters: pageSize, pageToken, count, fields. Send the request body as JSON (optional). Documented body fields: filters, orderBy. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This API endpoint can be used to get all campaign-level information on Awareness Training Mime | OS Phishing Campaigns created, both pending and launched. (Data displayed on Phishing > Campaigns). POST /api/awareness-training/phishing/campaign/get-campaign. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (optional). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This API endpoint can be used to get an aggregated summary of Awareness Training Mime | OS Phishing Campaigns grouped by recipient email address. POST /api/awareness-training/phishing/campaign/get-user-data. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (required). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: attributeIds, filterBy, id, searchBy. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This API endpoint can be used to get all module-level information on Awareness Training Mime | OS Training Modules created, both pending and launched. POST /api/awareness-training/queue/get-queue. Email Security Cloud Gateway, MX-based deployments only. Mimecast documents no request payload for this route. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This API endpoint can be used to get user enrollment and completion information on Awareness Training Mime | OS Training Modules. POST /api/awareness-training/user/get-training-details. Email Security Cloud Gateway, MX-based deployments only. Mimecast documents no request payload for this route. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Retrieves a list of roles for the account. Filterable by role Name. GET /role/cloud-gateway/v1/roles. Email Security Cloud Gateway. Optional filters: roleName, pageSize, pageToken. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Creates a new directory integration for Active Directory. POST /directory/cloud-gateway/v1/integrations/active-directory. Email Security Cloud Gateway. Send the request body as JSON (required). Documented body fields: description, info, domains, hostname, alternateHostname, port, userDn, password, rootDn, encryptionMode, acknowledgeDisabledAccounts, enabled, maxUnlink, syncContacts. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Requests a sync of all directory integrations for account. POST /directory/cloud-gateway/v1/integrations/sync-requests. Email Security Cloud Gateway. Send the request body as JSON (required). Documented body fields: action. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Creates a new directory integration for Google. POST /directory/cloud-gateway/v1/integrations/google. Email Security Cloud Gateway. Send the request body as JSON (required). Documented body fields: enabled, description, info, domains, maxUnlink, deleteUsers, acknowledgeDisabledAccounts, user, key. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Creates a new directory integration for M365. POST /directory/cloud-gateway/v1/integrations/m365. Email Security Cloud Gateway. Send the request body as JSON (required). Documented body fields: description, info, domains, connectorId, tenantDomain, serverSubtype, syncGuestUsers, acknowledgeDisabledAccounts, enabled, maxUnlink, syncContacts, deleteUsers. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] DESTRUCTIVE: deletes an Active Directory directory integration. Why this is destructive: delete semantics - the record is removed and StackJack cannot recover it. DELETE /directory/cloud-gateway/v1/integrations/active-directory/. Email Security Cloud Gateway. Path parameters: integration_id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] DESTRUCTIVE: deletes a Google directory integration. Why this is destructive: delete semantics - the record is removed and StackJack cannot recover it. DELETE /directory/cloud-gateway/v1/integrations/google/. Email Security Cloud Gateway. Path parameters: integration_id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] DESTRUCTIVE: deletes a M365 directory integration. Why this is destructive: delete semantics - the record is removed and StackJack cannot recover it. DELETE /directory/cloud-gateway/v1/integrations/m365/. Email Security Cloud Gateway. Path parameters: integration_id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This endpoint can be used to initiate directory synchronization. POST /api/directory/execute-sync. Email Security Cloud Gateway, MX-based deployments only. Mimecast documents no request payload for this route. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Gets an Active Directory directory integration. GET /directory/cloud-gateway/v1/integrations/active-directory/. Email Security Cloud Gateway. Path parameters: integration_id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This endpoint can be used to retrieve directory connectors that are configured on the tenant. POST /api/directory/get-connection. Email Security Cloud Gateway, MX-based deployments only. Mimecast documents no request payload for this route. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Gets a Google directory integration. GET /directory/cloud-gateway/v1/integrations/google/. Email Security Cloud Gateway. Path parameters: integration_id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Gets a M365 directory integration. GET /directory/cloud-gateway/v1/integrations/m365/. Email Security Cloud Gateway. Path parameters: integration_id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Gets all (m365, google, ldap) directory integrations for account. GET /directory/cloud-gateway/v1/integrations. Email Security Cloud Gateway. Optional filters: pageSize, pageToken. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Tests if Active directory integration can authenticate. POST /directory/cloud-gateway/v1/integrations/active-directory//test-authentication. Email Security Cloud Gateway. Path parameters: integration_id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Tests the certificates of an Active Directory integration. POST /directory/cloud-gateway/v1/integrations/active-directory//test-certificates. Email Security Cloud Gateway. Path parameters: integration_id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Tests the connectivity of an Active Directory integration. POST /directory/cloud-gateway/v1/integrations/active-directory//test-connectivity. Email Security Cloud Gateway. Path parameters: integration_id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Tests the Egress connectivity of an Active Directory integration. POST /directory/cloud-gateway/v1/integrations/active-directory//test-egress-connectivity. Email Security Cloud Gateway. Path parameters: integration_id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Tests if an Active Directory integration can retrieve directory samples. POST /directory/cloud-gateway/v1/integrations/active-directory//test-email. Email Security Cloud Gateway. Path parameters: integration_id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Tests the validity of an Active Directory integration. POST /directory/cloud-gateway/v1/integrations/active-directory//test-validation. Email Security Cloud Gateway. Path parameters: integration_id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Tests a Google directory authentication. POST /directory/cloud-gateway/v1/integrations/google//test-authentication. Email Security Cloud Gateway. Path parameters: integration_id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Tests a Google directory has the correct authorised permission set. POST /directory/cloud-gateway/v1/integrations/google//test-authorisation. Email Security Cloud Gateway. Path parameters: integration_id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Tests the connectivity of a Google directory integration. POST /directory/cloud-gateway/v1/integrations/google//test-connectivity. Email Security Cloud Gateway. Path parameters: integration_id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Tests if a Google Directory integration can retrieve directory samples. POST /directory/cloud-gateway/v1/integrations/google//test-email. Email Security Cloud Gateway. Path parameters: integration_id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Tests a Microsoft 365 directory authentication. POST /directory/cloud-gateway/v1/integrations/m365//test-authentication. Email Security Cloud Gateway. Path parameters: integration_id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Tests a M365 directory has the correct authorised permission set. POST /directory/cloud-gateway/v1/integrations/m365//test-authorisation. Email Security Cloud Gateway. Path parameters: integration_id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Tests the connectivity of a Microsoft 365 directory integration. POST /directory/cloud-gateway/v1/integrations/m365//test-connectivity. Email Security Cloud Gateway. Path parameters: integration_id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Tests the connector associated to a M365 directory authorisation. POST /directory/cloud-gateway/v1/integrations/m365//test-connector. Email Security Cloud Gateway. Path parameters: integration_id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Tests if a Microsoft 365 Directory integration can retrieve directory samples. POST /directory/cloud-gateway/v1/integrations/m365//test-email. Email Security Cloud Gateway. Path parameters: integration_id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Updates an Active Directory directory integration. PATCH /directory/cloud-gateway/v1/integrations/active-directory/. Email Security Cloud Gateway. Path parameters: integration_id. Send the request body as JSON (required). Documented body fields: description, info, domains, hostname, alternateHostname, port, userDn, password, rootDn, encryptionMode, acknowledgeDisabledAccounts, enabled, maxUnlink, syncContacts. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Updates a Google directory integration. PATCH /directory/cloud-gateway/v1/integrations/google/. Email Security Cloud Gateway. Path parameters: integration_id. Send the request body as JSON (required). Documented body fields: acknowledgeDisabledAccounts, enabled, description, info, domains, maxUnlink, deleteUsers, user, key. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Updates an M365 directory integration. PATCH /directory/cloud-gateway/v1/integrations/m365/. Email Security Cloud Gateway. Path parameters: integration_id. Send the request body as JSON (required). Documented body fields: description, info, domains, connectorId, tenantDomain, serverSubtype, syncGuestUsers, acknowledgeDisabledAccounts, enabled, maxUnlink, syncContacts, deleteUsers. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This endpoint can be used to add user email addresses or domains to a profile group. POST /api/directory/add-group-member. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (required). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: domain, emailAddress, id, notes. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This endpoint can be used to add user email addresses or domains to a profile group. POST /directory/cloud-gateway/v1/groups//members. Email Security Cloud Gateway. Path parameters: group_id. Send the request body as JSON (required). Documented body fields: groupMembers. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Creates a new Profile Groups at the root level, or as a child-group. POST /directory/cloud-gateway/v1/groups. Email Security Cloud Gateway. Send the request body as JSON (required). Documented body fields: description, parentId. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This API endpoint can be used to create new Profile Groups at the root level, or as a child-group. Groups can be used to apply permissions and policies. POST /api/directory/create-group. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (required). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: description, parentId. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] DESTRUCTIVE: this endpoint can be used to delete an exiting profile group. Why this is destructive: delete semantics - the record is removed and StackJack cannot recover it. POST /api/directory/delete-group. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (required). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This endpoint can be used to find groups that exist on a tenant. POST /api/directory/find-groups. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (optional). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: query, source. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This endpoint can be used to get a profile group from a tenant. GET /directory/cloud-gateway/v1/groups/. Email Security Cloud Gateway. Path parameters: group_id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This endpoint can be used to retrieve group members from groups the exist on a tenant. POST /api/directory/get-group-members. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (required). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This endpoint can be used to get group members from a tenant. GET /directory/cloud-gateway/v1/groups//members. Email Security Cloud Gateway. Path parameters: group_id. Optional filters: domain, pageSize, pageToken. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This endpoint can be used to find groups that exist on a tenant. GET /directory/cloud-gateway/v1/groups. Email Security Cloud Gateway. Optional filters: pageSize, pageToken. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] DESTRUCTIVE: this endpoint can be used to remove group members from Mimecast Profile groups. Why this is destructive: removes the member, alias or delegate named in the request. POST /api/directory/remove-group-member. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (required). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: domain, emailAddress, id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] DESTRUCTIVE: this endpoint can be used to remove group members from Mimecast Profile groups. Why this is destructive: removes the member, alias or delegate named in the request. POST /directory/cloud-gateway/v1/groups//remove-members. Email Security Cloud Gateway. Path parameters: group_id. Send the request body as JSON (required). Documented body fields: groupMembers. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] The update group endpoint can be used to update the description of Mimecast Profile groups. POST /api/directory/update-group. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (required). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: description, id, parentId. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This API endpoint provides the ability to create a new delegate permission for a user based on their primary address. More information about delegates is available in Mimecaster Central. POST /api/user/add-delegate-user. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (required). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: delegateAddress, primaryAddress. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] DESTRUCTIVE: this endpoint can be used to add internal or external users to the Purge List. The Purge List gets examined each evening as part of the nightly housekeeping tasks. Why this is destructive: queues the mailbox for purge; Mimecast removes its retained mail. POST /api/user/add-to-purge-list. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (required). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: emailAddresses. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This endpoint allows the creation of a new user within the account. POST /user/cloud-gateway/v1/users. Email Security Cloud Gateway. Send the request body as JSON (required). Documented body fields: accountCode, emailAddress, name, password, forcePasswordChange. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This endpoint can be used to create new cloud-users in Mimecast's Internal Directories. POST /api/user/create-user. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (required). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: accountCode, emailAddress, forcePasswordChange, name, password. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This API endpoint can be used to find account attribute types. POST /api/attribute/find-attribute-types. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (optional). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: filterBy, searchBy. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This API endpoint provides the ability to return delegate permissions for a user based on their primary address. More information about delegates is availabile in Mimecaster Central. POST /api/user/find-delegate-users. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (required). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: primaryAddress. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This endpoint can be used to retrieve all internal users for a given domain. POST /api/user/get-internal-users. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (optional). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: domain. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This endpoint returns the most used contacts synced from Azure Active Directory. POST /api/user/get-most-used-contacts. Email Security Cloud Gateway, MX-based deployments only. Mimecast documents no request payload for this route. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] The get aliases endpoint can be used to retrieve aliases associated with a primary email address. POST /api/user/get-aliases. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (required). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: emailAddress. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This endpoint can be used to retrieve attributes that are registered on the tenant, for a given user. POST /api/user/get-attributes. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (optional). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: emailAddress. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This endpoint can the used to get the current status of a user import request, using /api/user/import-users. POST /api/user/get-import-status. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (optional). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] DESTRUCTIVE: the import users endpoint can be used to import users to an Internal Directory or a Profile Group. Why this is destructive: the x-mc-arg options include clearGroup, which EMPTIES the target Profile Group before the import runs - every member is taken out of the group and Mimecast keeps no copy, so a policy scoped to that group stops applying to anyone the import does not put back. POST /api/user/import-users. Email Security Cloud Gateway, MX-based deployments only. THE BODY IS THE FILE ITSELF, not a JSON payload: provide the import EITHER as CSV content in csvText OR as an XLS/XLSX workbook in contentBase64 or sourceUrl - exactly one of the two forms, never both and never neither. StackJack downloads an https URL server-side and refuses anything over 25 MB, a non-https URL, or a redirect to a different host. The import options travel in the x-mc-arg header, not in the body. This route is NOT one of Mimecast's legacy paginated routes despite its /api/ prefix: it takes no data array and no meta.pagination, and dataJson is refused for that reason. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Get internal users for account. GET /user/cloud-gateway/v1/users. Email Security Cloud Gateway. Optional filters: emailAddress, domain, includeAliases, pageSize, pageToken. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] DESTRUCTIVE: this API endpoint provides the ability to remove delegate permissions for a user based on their primary address. More information about delegates is availabile in Mimecaster Central. Why this is destructive: removes the member, alias or delegate named in the request. POST /api/user/remove-delegate-user. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (required). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] DESTRUCTIVE: the remove alias endpoint can be used to remove a alias that has been associated with a primary email address. Why this is destructive: removes the member, alias or delegate named in the request. POST /api/user/remove-alias. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (required). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: alias, aliasFor. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] DESTRUCTIVE: this endpoint can be used to remove internal or external users from the Purge List in case you added them by accident. Why this is destructive: changes retention for a mailbox already queued for purge. POST /api/user/remove-from-purge-list. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (required). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: emailAddresses. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] The update user endpoint can be used to update users within an Internal Directory. POST /api/user/update-user. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (required). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: accountDisabled, accountLocked, allowPop, allowSmtp, archiveStartDate, emailAddress, forcePasswordChange, name, password, passwordNeverExpires. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This API endpoint can be used to modify secondary email addresses for users. POST /api/user/update-alias. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (required). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: alias, aliasFor. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] This API endpoint can be used to update a non-directory synced user's attributes. POST /api/user/update-attributes. Email Security Cloud Gateway, MX-based deployments only. Send the payload as JSON; Mimecast wraps it in its data array for you (required). Paging: pageSize (max 100) and pageToken travel in the request body under meta.pagination. The response omits meta.pagination.next on the last page, so stop when it is absent rather than when a page comes back empty. Documented body fields: attributes, emailAddress. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Get BIMI record check. GET /dmarc-analyzer/v1/dns/bimi. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Get DKIM record check. GET /dmarc-analyzer/v1/dns/dkim. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Get DMARC record check. GET /dmarc-analyzer/v1/dns/dmarc. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Get SPF record check. GET /dmarc-analyzer/v1/dns/spf. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Optional filters: record. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Create a DKIM definition. POST /dmarc-analyzer/v1/delegated-domains//dkim. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Path parameters: domainId. Send the request body as JSON (required). Documented body fields: sourceId, version, selector, recordType, hostname, publicKey, serviceType, notes, flags. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Create a DMARC definition. POST /dmarc-analyzer/v1/delegated-domains//dmarc. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Path parameters: domainId. Send the request body as JSON (required). Documented body fields: dmarcPolicyPresetId. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Create a delegated domain entry. POST /dmarc-analyzer/v1/delegated-domains. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Send the request body as JSON (required). Documented body fields: items. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] DESTRUCTIVE: delete all DKIM delegation for a domain. Why this is destructive: delete semantics - the record is removed and StackJack cannot recover it. DELETE /dmarc-analyzer/v1/delegated-domains//dkim. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Path parameters: domainId. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] DESTRUCTIVE: delete DKIM definition. Why this is destructive: delete semantics - the record is removed and StackJack cannot recover it. DELETE /dmarc-analyzer/v1/delegated-domains//dkim/. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Path parameters: domainId, selector. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] DESTRUCTIVE: delete DMARC definition. Why this is destructive: delete semantics - the record is removed and StackJack cannot recover it. DELETE /dmarc-analyzer/v1/delegated-domains//dmarc. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Path parameters: domainId. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] DESTRUCTIVE: delete delegated domains. Why this is destructive: delete semantics - the record is removed and StackJack cannot recover it. DELETE /dmarc-analyzer/v1/delegated-domains. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] DESTRUCTIVE: delete SPF definition. Why this is destructive: delete semantics - the record is removed and StackJack cannot recover it. DELETE /dmarc-analyzer/v1/delegated-domains//spf. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Path parameters: domainId. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Get DKIM delegation details. GET /dmarc-analyzer/v1/delegated-domains//dkim/details. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Path parameters: domainId. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Get a DKIM definition. GET /dmarc-analyzer/v1/delegated-domains//dkim/. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Path parameters: domainId, selector. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Get DMARC definition. GET /dmarc-analyzer/v1/delegated-domains//dmarc. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Path parameters: domainId. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Get delegated domains statistics. GET /dmarc-analyzer/v1/delegated-domains/statistics. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Get SPF definition details. GET /dmarc-analyzer/v1/delegated-domains//spf/details. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Path parameters: domainId. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Get SPF definition. GET /dmarc-analyzer/v1/delegated-domains//spf. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Path parameters: domainId. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] List DKIM definitions. GET /dmarc-analyzer/v1/delegated-domains//dkim. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Path parameters: domainId. Optional filters: pageSize, pageToken, orderBy. Paging: pageSize (default 50) and pageToken travel in the QUERY STRING on DMARC Analyzer, not in the request body - the pageSize parameter names this route's own maximum, which is not the same on every route. The response carries meta.nextPage; stop when it is absent. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Get delegated domains. GET /dmarc-analyzer/v1/delegated-domains. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Optional filters: pageSize, pageToken, orderBy, domain, domainDelegationStatus, dmarcDelegationStatus, dmarcPolicy, dkimDelegationStatus, spfDelegationStatus. Paging: pageSize (default 50) and pageToken travel in the QUERY STRING on DMARC Analyzer, not in the request body - the pageSize parameter names this route's own maximum, which is not the same on every route. The response carries meta.nextPage; stop when it is absent. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] DESTRUCTIVE: update a DKIM definition. Why this is destructive: wholesale replace - the body becomes the whole DKIM definition for that selector, so a wrong or omitted public key stops mail signed with it authenticating. PUT /dmarc-analyzer/v1/delegated-domains//dkim/. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Path parameters: domainId, selector. Send the request body as JSON (required). Documented body fields: sourceId, version, selector, recordType, hostname, publicKey, serviceType, notes, flags. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] DESTRUCTIVE: update the SPF definition. Why this is destructive: wholesale replace - the body becomes the delegated domain's ENTIRE published SPF record and `terms` is optional, so a body without it publishes a record that authorizes no sending source at all and every legitimate sender starts failing SPF. PUT /dmarc-analyzer/v1/delegated-domains//spf. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Path parameters: domainId. Send the request body as JSON (required). Documented body fields: version, terms, allQualifier. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Get detected domains. GET /dmarc-analyzer/v1/detected-domains. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Optional filters: pageSize, pageToken, domain, acceptanceStatus, orderBy. Paging: pageSize (default 50) and pageToken travel in the QUERY STRING on DMARC Analyzer, not in the request body - the pageSize parameter names this route's own maximum, which is not the same on every route. The response carries meta.nextPage; stop when it is absent. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Update detected domain status. PUT /dmarc-analyzer/v1/detected-domains//status. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Path parameters: id. Send the request body as JSON (required). Documented body fields: status. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Batch update detected domains status. PATCH /dmarc-analyzer/v1/detected-domains. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Send the request body as JSON (required). Documented body fields: ids, status. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Create a domain group. POST /dmarc-analyzer/v1/domain-groups. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Send the request body as JSON (required). Documented body fields: name, type, doesAutoIncludeOrgSubdomains, includeDomainsWithStatus, includedDomains, includeDomainsRegex. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Add domains to domain group. POST /dmarc-analyzer/v1/domain-groups//association. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Path parameters: id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] DESTRUCTIVE: remove domains from domain group. Why this is destructive: delete semantics - the record is removed and StackJack cannot recover it. DELETE /dmarc-analyzer/v1/domain-groups//association. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Path parameters: id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] DESTRUCTIVE: delete domain groups. Why this is destructive: delete semantics - the record is removed and StackJack cannot recover it. DELETE /dmarc-analyzer/v1/domain-groups. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Get a domain group. GET /dmarc-analyzer/v1/domain-groups/. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Path parameters: id. Optional filters: filterOnActivityStatus. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Get domain groups. GET /dmarc-analyzer/v1/domain-groups. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Optional filters: pageSize, pageToken, name, ids, orderBy, filterOnActivityStatus, includeDomainsCount. Paging: pageSize (default 50) and pageToken travel in the QUERY STRING on DMARC Analyzer, not in the request body - the pageSize parameter names this route's own maximum, which is not the same on every route. The response carries meta.nextPage; stop when it is absent. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] DESTRUCTIVE: update a domain group. Why this is destructive: wholesale replace - includedDomains, includeDomainsWithStatus and includeDomainsRegex become exactly what the body carries, so a domain left out drops out of the group and every report, notification and policy scoped to that group stops covering it. PUT /dmarc-analyzer/v1/domain-groups/. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Path parameters: id. Send the request body as JSON (required). Documented body fields: name, type, doesAutoIncludeOrgSubdomains, includeDomainsWithStatus, includedDomains, includeDomainsRegex. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Create a managed domain entry. POST /dmarc-analyzer/v1/domains. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Send the request body as JSON (required). Documented body fields: items. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] DESTRUCTIVE: delete domains. Why this is destructive: delete semantics - the record is removed and StackJack cannot recover it. DELETE /dmarc-analyzer/v1/domains. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Get a managed domain. GET /dmarc-analyzer/v1/domains/. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Path parameters: id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Get managed domain statistics. GET /dmarc-analyzer/v1/domains/statistics. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Get managed domains. GET /dmarc-analyzer/v1/domains. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Optional filters: pageSize, pageToken, orderBy, domain, domains, ids, group, filterOnActivityStatus, activityStatus, status, dmarcPolicy, dmarcStatus, dmarcDelegation, dkimStatus, dkimDelegation, spfStatus, spfDelegation, dnsDelegation, presetFilter, createdAt. Paging: pageSize (default 50) and pageToken travel in the QUERY STRING on DMARC Analyzer, not in the request body - the pageSize parameter names this route's own maximum, which is not the same on every route. The response carries meta.nextPage; stop when it is absent. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Get domain vendor configurations. GET /dmarc-analyzer/v1/domains/vendor-configurations. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Optional filters: domainIds, domains. Not paginated: Mimecast documents no page parameters here, so expect the whole collection in one response - on a large tenant it can exceed the result-size cap. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Refresh managed domain DNS records. POST /dmarc-analyzer/v1/domains//refresh-dns. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Path parameters: id. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] Update managed domain activity status. PATCH /dmarc-analyzer/v1/domains/. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Path parameters: id. Send the request body as JSON (required). Mimecast applies this body as an RFC 7386 merge patch (Content-Type application/merge-patch+json), so a field you omit is left unchanged and a field you set to null is REMOVED - null is not the same as omitting it. Documented body fields: activityStatus. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] DESTRUCTIVE: create a new DMARC policy preset. Why this is destructive: a DMARC policy preset is applied to managed domains, and a preset at p=reject tells receiving mail servers to DISCARD mail that fails authentication - misconfigured, it stops legitimate mail being delivered. POST /dmarc-analyzer/v1/dmarc-policy-preset. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. Send the request body as JSON (required). Documented body fields: version, policy, subdomainPolicy, ruaAddresses, rufAddresses, dkimAlignment, spfAlignment, reportInterval, failureReportingOptions, failureReportFormat, percentage, name, description. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.

[Mimecast] DESTRUCTIVE: delete a DMARC policy preset by ID. Why this is destructive: delete semantics - the record is removed and StackJack cannot recover it. DELETE /dmarc-analyzer/v1/dmarc-policy-preset. Mimecast DMARC Analyzer - requires the DMARC Analyzer product on the Mimecast API application; a 401 or 403 app_forbidden here means the application is missing that product, not that the credential is wrong. MSP: pass accountCode to act on a managed customer; omit it to act on your own account. Returns raw Mimecast JSON.