> ## Documentation Index > Fetch the complete documentation index at: https://docs.msportal.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get email domain security > Email authentication posture of client domains from MSPortal's daily public-DNS check: SPF, DMARC (policy, pct, enforced), DKIM, MTA-STS, TLS-RPT, DNSSEC and BIMI per domain, worst first, plus a summary. DKIM is only looked up at selectors the mail provider is known to use, so unknown DKIM is never a failure. Requires the domain_email_auth_checks feature and the linked user's read_documentation_domains or read_security permission. ## OpenAPI ````yaml /openapi.json get /api/public/v1/documentation/email-domain-security openapi: 3.0.3 info: title: MSPortal Public API version: 1.0.0 description: >- Public API for MSPortal - provides programmatic access to tenant data. ## Authentication All endpoints require authentication via API key passed as a Bearer token: ``` Authorization: Bearer ``` API keys can be created in the MSPortal dashboard under Settings → Integrations → API Access. **Important:** Do not include cookies in API requests. The public API uses stateless authentication only. ## Scopes API keys are granted specific scopes that determine what operations they can perform. Each endpoint documents its required scope(s). ## Rate Limiting API calls are rate limited per API key. Rate limit information is returned in response headers: - `X-RateLimit-Limit`: Maximum requests per minute - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: When the rate limit resets (ISO 8601) ## Request ID All responses include an `X-Request-Id` header for debugging and support. You can also pass your own `X-Request-Id` header to correlate requests. contact: name: MSPortal Support email: support@msportal.ai license: name: Proprietary servers: - url: https://app.msportal.ai description: Production (US) - url: https://eu.msportal.ai description: Production (EU) security: - BearerAuth: [] tags: - name: Budgets description: >- Budget management - create, track, and forecast budgets with line items, categories, and products - name: Calendar description: Calendar and meeting management - events, participants, and meeting types - name: Companies description: Company management endpoints - name: Company Users description: Company user management - client portal contacts (read-only, paginated) - name: Compliance description: Compliance check management - runs, assigned checks, and status updates - name: Dashboards description: Dashboard management - external iframe resources and internal dashboards - name: Devices description: Device management - inventory, types, and locations - name: Goals description: Goal management - create, track, and manage goals with tasks and updates - name: NPS Surveys description: >- NPS survey management - Net Promoter Score surveys, responses, and analytics - name: Reports description: >- Report management - create, manage, and schedule reports with templates and types - name: Planner description: >- Planner item management - tasks, roadmap items, and project planning with linked goals, compliance, and projects - name: Surveys description: >- General survey management - multi-question surveys, responses, and statistics - name: Tickets description: Ticket management - view and filter tickets from PSA integrations - name: Training description: >- Training management - courses, enrollments, certificates, and progress tracking - name: Users description: Tenant user management - internal staff and team members (read-only) - name: Automation Rules description: >- Automation rule management - create, configure, and monitor automation rules with triggers, conditions, and actions - name: Analytics description: >- Analytics and reporting - company audit data, training analytics, user activity, and portfolio metrics - name: Client Onboarding description: >- Client onboarding - portals (phases, tasks, contacts, activation), templates, checklist templates, forms and documentation pages - name: Backup description: >- Backup - summaries, protected devices, alerts and SaaS protection (Datto, Axcient, Slide, Kaseya) - name: Microsoft 365 description: Microsoft 365 - licenses, users, domains and Secure Score - name: Security description: >- Security - posture summary, EDR incidents, vulnerabilities, email threats, firewalls, DNS filtering and security awareness - name: Financial description: Financial - quotes, invoices and revenue summaries - name: Integrations description: Integrations - status, sync health, pause and resume (never credentials) - name: Documentation description: >- Documentation - pages, folders and articles synced from Hudu or IT Glue, plus built-in pages - name: Broadcasts description: Broadcasts - emergency broadcasts, recipients and groups - name: Notifications description: Notifications - the linked user's in-app notifications - name: Standards description: >- Standards - technology standards catalog, service plans, applicability, deployment statuses, compliance rollups, white space and costs - name: Customer Success description: >- Customer success - client health scores, trends, benchmarks and Traffic Light Reviews - name: Tasks description: Tasks - the linked user's personal task list - name: Tenant Setup description: Tenant setup - profile, branding and portal settings (never secrets) - name: Roles description: Roles - staff and client roles and their permission grants - name: Ticket Templates description: Ticket templates - reusable ticket definitions - name: Readiness description: Client readiness - account readiness assessments - name: Projects description: >- Projects - PSA projects with health overlays (deliverables, milestones, client actions, weekly updates), phases, tickets, time entries, PSA status/owner/priority write-through, ticket notes, task controls, display settings and the document library paths: /api/public/v1/documentation/email-domain-security: get: tags: - Documentation summary: Get email domain security description: >- Email authentication posture of client domains from MSPortal's daily public-DNS check: SPF, DMARC (policy, pct, enforced), DKIM, MTA-STS, TLS-RPT, DNSSEC and BIMI per domain, worst first, plus a summary. DKIM is only looked up at selectors the mail provider is known to use, so unknown DKIM is never a failure. Requires the domain_email_auth_checks feature and the linked user's read_documentation_domains or read_security permission. parameters: - schema: type: integer minimum: 1 maximum: 100000 default: 1 required: false name: page in: query - schema: type: integer minimum: 1 maximum: 100 default: 25 description: Items per page required: false description: Items per page name: limit in: query - schema: type: string format: uuid description: Restrict to one company required: false description: Restrict to one company name: companyId in: query - schema: type: string enum: - pass - warn - fail - pending - dmarc_not_enforced description: Only domains in this state required: false description: Only domains in this state name: status in: query - schema: type: string maxLength: 200 description: Search domain or company name required: false description: Search domain or company name name: search in: query responses: '200': description: Domains, worst first, with the summary content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/EmailDomainSecurity' pagination: $ref: '#/components/schemas/Pagination' summary: $ref: '#/components/schemas/EmailDomainSecuritySummary' required: - data - pagination - summary '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: >- Forbidden - missing scope (documentation.read) or the linked user lacks the permission named in the endpoint description content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '503': description: Email domain checks are not available yet content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] components: schemas: EmailDomainSecurity: type: object properties: company_domain_id: type: string format: uuid company_id: type: string format: uuid company_name: type: string nullable: true domain: type: string is_primary: type: boolean overall: type: string enum: - pass - warn - fail - unknown - error - pending description: >- pass, warn, fail, unknown (domain not in DNS), error or pending (not checked yet) checks: type: object properties: spf: type: string nullable: true enum: - pass - warn - fail - missing - unknown - error - null description: pass, warn, fail, missing, unknown or error dmarc: type: string nullable: true enum: - pass - warn - fail - missing - unknown - error - null description: pass, warn, fail, missing, unknown or error dkim: type: string nullable: true enum: - pass - warn - fail - missing - unknown - error - null description: pass, warn, fail, missing, unknown or error mta_sts: type: string nullable: true enum: - pass - warn - fail - missing - unknown - error - null description: pass, warn, fail, missing, unknown or error tls_rpt: type: string nullable: true enum: - pass - warn - fail - missing - unknown - error - null description: pass, warn, fail, missing, unknown or error dnssec: type: string nullable: true enum: - pass - warn - fail - missing - unknown - error - null description: pass, warn, fail, missing, unknown or error bimi: type: string nullable: true enum: - pass - warn - fail - missing - unknown - error - null description: pass, warn, fail, missing, unknown or error required: - spf - dmarc - dkim - mta_sts - tls_rpt - dnssec - bimi dmarc_policy: type: string nullable: true dmarc_pct: type: integer nullable: true dmarc_enforced: type: boolean description: DMARC policy is quarantine or reject spf_safe: type: boolean mail_provider: type: string nullable: true spf_record: type: string nullable: true dmarc_record: type: string nullable: true dkim_selectors_checked: type: array items: type: string dkim_selectors_found: type: array items: type: string findings: type: array items: type: string checked_at: type: string nullable: true last_error: type: string nullable: true description: The latest attempt failed; the checks are the previous result required: - company_domain_id - company_id - company_name - domain - is_primary - overall - checks - dmarc_policy - dmarc_pct - dmarc_enforced - spf_safe - mail_provider - spf_record - dmarc_record - dkim_selectors_checked - dkim_selectors_found - findings - checked_at - last_error Pagination: type: object properties: page: type: integer minimum: 1 description: Current page number limit: type: integer minimum: 1 maximum: 100 description: Items per page totalCount: type: integer description: Total number of items totalPages: type: integer description: Total number of pages hasNextPage: type: boolean description: Whether there is a next page hasPrevPage: type: boolean description: Whether there is a previous page required: - page - limit - totalCount - totalPages - hasNextPage - hasPrevPage EmailDomainSecuritySummary: type: object properties: domains: type: integer checked: type: integer passing: type: integer warning: type: integer failing: type: integer dmarcEnforced: type: integer dmarcMonitoring: type: integer dmarcMissing: type: integer spfSafe: type: integer spfMissing: type: integer dkimFound: type: integer mtaSts: type: integer tlsRpt: type: integer dnssec: type: integer bimi: type: integer lastCheckedAt: type: string nullable: true required: - domains - checked - passing - warning - failing - dmarcEnforced - dmarcMonitoring - dmarcMissing - spfSafe - spfMissing - dkimFound - mtaSts - tlsRpt - dnssec - bimi - lastCheckedAt ErrorResponse: type: object properties: error: type: string description: Error message requestId: type: string description: Request correlation ID details: nullable: true description: Additional error details code: type: string description: Error code required: - error securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: API Key description: >- Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.