Domain

Add a domain

post/domains

Request

  • Base URL: https://api.palisade.email
  • URL: https://api.palisade.email/domains
  • Auth: one of:
    • HTTP bearer
    • HTTP basic

Headers

Palisade-Version'2025-04-30' | 'unstable' required

Request body

urlstring required
group_idstring uuid
use_stored_scanboolean

Response

Success

idstring uuid required
urlstring required
dmarc_policystring required
monitoring_status'drifted' | 'none' | 'pending' | 'setup' | 'failed' required
monitoring_failure_reason'nameservers_unresolvable' | 'dmarc_record_missing' | 'dmarc_record_added_as_txt_not_cname' | 'dmarc_record_on_parent_only' | 'dmarc_record_missing_palisade_rua' | 'dmarc_record_invalid' | 'dmarc_multiple_records' nullable required
monitoring_emailstring required
open_tasks_countnumber required

Open tickets on this domain. Opportunity tickets such as set_up_bimi are not counted, and expand[]=tasks leaves them out to match.

highest_open_task_priorityinteger nullable required

Priority of the most urgent open task on this domain, on the same inverted scale as a task's own priority: 0 critical, 1 high, 2 medium, 3 low. Null when the domain has no open tasks. Sort on "severity" to order domains by it.

scorenumber required
score_band'critical' | 'bad' | 'good' | 'great' required

Risk band the score falls in: critical, bad, good, or great. The same banding the dashboard shows, so clients do not have to reimplement the thresholds.

is_parkedboolean required
is_dmarc_managedboolean required
is_spf_managedboolean required
is_dkim_managedboolean required
is_bimi_managedboolean required
is_mta_sts_managedboolean required
bimi_error_reason'setup_timeout' | 'drift' | 'certificate_invalid' | 'record_conflict' | 'delegation_missing' | 'publish_failed' | 'dkim_key_error' | 'check_failed' nullable required

Why managed_dns_status.bimi is "error". "setup_timeout" means the customer CNAME was never detected within the verification window (setup was never completed); "drift" means a previously verified CNAME stopped pointing at Palisade; "record_conflict" means default._bimi holds conflicting records — see dns_conflicts. Null when there is no error or the error predates reason tracking.

dmarc_error_reason'setup_timeout' | 'drift' | 'certificate_invalid' | 'record_conflict' | 'delegation_missing' | 'publish_failed' | 'dkim_key_error' | 'check_failed' nullable required

Why managed_dns_status.dmarc is "error". "record_conflict" means _dmarc holds records that conflict with each other — a CNAME coexisting with other data, or more than one DMARC record — and the domain's DMARC policy is not reliably enforced. See dns_conflicts for the offending records. Null when there is no error or the error predates reason tracking.

spf_error_reason'setup_timeout' | 'drift' | 'certificate_invalid' | 'record_conflict' | 'delegation_missing' | 'publish_failed' | 'dkim_key_error' | 'check_failed' nullable required

Why managed_dns_status.spf is "error". See dmarc_error_reason for the meaning of each value.

dkim_error_reason'setup_timeout' | 'drift' | 'certificate_invalid' | 'record_conflict' | 'delegation_missing' | 'publish_failed' | 'dkim_key_error' | 'check_failed' nullable required

Why managed_dns_status.dkim is "error". See dmarc_error_reason for the meaning of each value.

mta_sts_error_reason'setup_timeout' | 'drift' | 'certificate_invalid' | 'record_conflict' | 'delegation_missing' | 'publish_failed' | 'dkim_key_error' | 'check_failed' nullable required

Why managed_dns_status.mta_sts is "error". See dmarc_error_reason for the meaning of each value.

bimi_cname_targetstring required

The host a customer CNAMEs default._bimi.{domain} to for Palisade-served BIMI.

bimi_txt_valuestring nullable required

The fully-formed BIMI TXT value, populated whenever bimi_options.logo is set (via asset ingestion or a direct bimi_options update). The a= tag is included only when a certificate URL is also set. Customers who prefer not to delegate via CNAME can publish this value at default._bimi.{domain} themselves.

target_spfstring nullable required
last_14_days_volumenumber required
last_14_days_dmarc_pass_pctnumber required
last_14_days_spf_pass_pctnumber required
last_14_days_dkim_pass_pctnumber required
group_idstring uuid nullable required
registrarstring nullable required
dmarc_setup_atstring date-time nullable required
dmarc_verified_atstring date-time nullable required

When the domain first reached the "setup" monitoring status and DMARC report collection began.

monitoring_sincestring nullable required

The first day (yyyy-MM-dd) a DMARC aggregate report was actually received for this domain. The honest denominator for any activity claim: nothing before this day was observable, so a domain monitored for a week can never truthfully read as quiet for ninety days. Null until the first report arrives.

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "monitoring_since": "2025-09-14"
}

Changes

No recorded changes to this operation across all 1 revision of this API.