V3 REFERENCE Sender Addresses and Domains

/dns

Sender Domain properties.

List dns resources available for this apikey, use a GET request. Alternatively, you may want to add one or more filters.

# list dns resources

curl -s -X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/dns
Unique Key

In addition to the resource $ID, you can also use the unique key $Domain to identify this resource. Please refer to the field(s) description below for more information.

Properties
Name Description
DKIMRecordName Name of the DNS DKIM record to insert for this domain.
  • Read Only
  • [ Type AnsiString ]
DKIMRecordValue Value to insert in the DNS DKIM record for this domain.
  • Read Only
  • [ Type AnsiString ]
DKIMStatus Status of the DKIM record for this domain.
  • Read Only
  • [ Type AnsiString ]
Domain Name of this domain.
  • Mandatory
  • Unique
  • Read Only
  • [ Type AnsiString ]
ID Unique numerical ID for this object.
  • Read Only
  • [ Type Int64 ]
IsCheckInProgress Indicates if a DNS check is in progress. True if checking, False otherwise
  • Read Only
  • [ Type Boolean ]
LastCheckAt Timestamp indicating when last domain check was performed.
  • Read Only
  • [ Type TRFC3339DateTime ]
OwnerShipToken Value of the token to verify the ownership of the domain
  • Read Only
  • [ Type AnsiString ]
OwnerShipTokenRecordName Value to use when configuring TXT record (DNS) verification for the domain
  • Read Only
  • [ Type AnsiString ]
SPFRecordValue Value to insert in the DNS SPF record for this domain.
  • Read Only
  • [ Type AnsiString ]
SPFStatus SPF status.
  • Read Only
  • [ Type AnsiString ]
Filters
Name Description
IsCheckInProgress Only retrieve DNS records where IsCheckInProgress matches the specified value.
  • [ Type TBooleanFilter ]
IsSenderIdentified Only retrieve DNS records where IsSenderIdentified matches the specified value.
  • [ Type TBooleanFilter ]
IsYahooFBL Only retrieve DNS records where IsYahooFBL matches the specified value.
  • [ Type TBooleanFilter ]
MaxLastCheckAt Only retrieve DNS records where LastCheckAt is strictly less than the specified value.
  • [ Type TRFC3339DateTime ]
MinLastCheckAt Only retrieve DNS records where LastCheckAt is larger than the specified value.
  • [ Type TRFC3339DateTime ]
SPFStatus Only retrieve DNS records where SPFStatus matches the specified value.
  • [ Type ShortInt ]

Access a given dns resource, use a GET request, providing the dns's ID value.

# access the dns resource identified by $ID

curl -s -X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/dns/$ID

    
# access the resource through the Domain's value
# note: all keys marked as 'unique' may be used as an alternate ID

curl -s -X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/dns/$Domain
    
    
Unique Key

In addition to the resource $ID, you can also use the unique key $Domain to identify this resource. Please refer to the field(s) description below for more information.

Properties
Name Description
DKIMRecordName Name of the DNS DKIM record to insert for this domain.
  • Read Only
  • [ Type AnsiString ]
DKIMRecordValue Value to insert in the DNS DKIM record for this domain.
  • Read Only
  • [ Type AnsiString ]
DKIMStatus Status of the DKIM record for this domain.
  • Read Only
  • [ Type AnsiString ]
Domain Name of this domain.
  • Mandatory
  • Unique
  • Read Only
  • [ Type AnsiString ]
ID Unique numerical ID for this object.
  • Read Only
  • [ Type Int64 ]
IsCheckInProgress Indicates if a DNS check is in progress. True if checking, False otherwise
  • Read Only
  • [ Type Boolean ]
LastCheckAt Timestamp indicating when last domain check was performed.
  • Read Only
  • [ Type TRFC3339DateTime ]
OwnerShipToken Value of the token to verify the ownership of the domain
  • Read Only
  • [ Type AnsiString ]
OwnerShipTokenRecordName Value to use when configuring TXT record (DNS) verification for the domain
  • Read Only
  • [ Type AnsiString ]
SPFRecordValue Value to insert in the DNS SPF record for this domain.
  • Read Only
  • [ Type AnsiString ]
SPFStatus SPF status.
  • Read Only
  • [ Type AnsiString ]