Add domains' SPF records

This function installs a Sender Policy Framework (SPF) record for a domain on the DNS server.

Authorizations:
query Parameters
domain
required
string

The domain for which to install an SPF record on the DNS server.

Note:

To install multiple SPF records, duplicate the parameter name. For example, use the domain=example.com, domain=example2.com, and domain=example3.com parameters.

Examples:
domain=domain=example.com&domain=example2.com&domain=example3.com
domain=example.com
record
required
string

An SPF record.

Note:

You must provide this parameter for each domain parameter.

Example: record="v=spf1 ip4:10.0.0.1 %2Ba %2Bmx %2Bip4:10.0.0.2 %2Bip4:10.0.0.3 -all"

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --output=jsonpretty \
  --user=username \
  EmailAuth \
  install_spf_records \
  domain='example.com' \
  record='"v=spf1 ip4:10.0.0.1 %2Ba %2Bmx %2Bip4:10.0.0.2 %2Bip4:10.0.0.3 -all"'

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "install_spf_records",
  • "module": "EmailAuth",
  • "result": {
    • "data": [
      • {
        • "domain": "example.com",
        • "msg": "[ADD:TXT@example.com.:v=spf1 ip4:10.0.0.1 %2Ba %2Bmx %2Bip4:10.0.0.2 %2Bip4:10.0.0.3 -all]",
        • "status": 1
        }
      ],
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}