Skip to content
Browse the docs

GET /tools/dns/{domain}

The DNS records a sending domain needs, and the exact records to publish.

No API key. 10 checks a minute from one network. Looks up SPF, DKIM, DMARC and the return-path records only, and stores nothing. An optional selector query parameter chooses the DKIM name and defaults to as1. Any other query parameter is ignored and is not looked up. Each record includes a plain reading of every line.

Request

The same call in curl, Node and Python. A path id in the sample is a placeholder.

curl

curl -sS -X GET https://api.agentisend.com/tools/dns/example \
  -H "Authorization: Bearer $AGENTISEND_API_KEY"

Node

import { AgentiSend } from 'agentisend';

const client = new AgentiSend(process.env.AGENTISEND_API_KEY);
const result = await client.request({
  method: 'GET',
  path: '/tools/dns/example',
});

Python

import json, os, urllib.request

url = 'https://api.agentisend.com/tools/dns/example'
headers = {'Authorization': 'Bearer ' + os.environ['AGENTISEND_API_KEY']}
request = urllib.request.Request(url, headers=headers, method='GET')
print(urllib.request.urlopen(request).read().decode())

Tag: meta. Generated from openapi.json; the anchor get-tools-dns-domain is the id the console's error fix links point at.

Parameters

  • domain path · string · required

Responses

  • 200 — Success
  • 400 — The request is malformed or a field failed validation. Codes: validation_error, invalid_idempotency_key, invalid_cursor, plan_not_purchasable, stripe_signature_invalid, support_upload_rejected, appsumo_license_not_confirmed, appsumo_ticket_invalid, sign_in_check_required.
  • 422 — A field is well formed but was refused. Codes: missing_required_field, invalid_from_address, invalid_parameter, invalid_attachment, invalid_region, tracking_subdomain_unverified, tracking_subdomain_cannot_be_removed, domain_field_immutable, open_tracking_on_transactional, header_replaced, html_clipped_by_gmail, link_domain_listed, domain_blocklisted, mailbox_provider_domain, onboarding_shape_refused, dkim_key_mismatch, domain_check_window_expired, spf_conflict, spf_lookup_limit, review_sandbox_recipient_only, suppressed_recipient, agent_signup_refused, content_refused, recipient_blocklisted, last_owner_required, seat_limit_reached, invite_not_valid, key_budget_exceeds_plan, domain_limit_reached, webhook_endpoint_limit_reached.
  • 429 — A rate, quota or ramp ceiling was reached. Codes: onboarding_daily_cap_reached, trust_throttled, invite_limit_reached, rate_ceiling_exceeded, daily_quota_exceeded, monthly_quota_exceeded, rate_limit_exceeded, support_rate_limited, appsumo_lookup_limited.
  • 500 — Something failed on our side. Codes: internal_server_error.

Response headers

  • ratelimit-limit — Messages this API key may spend in one 60-second window.
  • ratelimit-remaining — Messages left in the current window.
  • ratelimit-reset — Seconds until the current window resets and the budget refills.

200 body

FieldTypeRequiredNotes
domainstringyes
recordsarray<object>yes
records[].action"add" | "edit" | "none" | "check"yes
records[].currentstring | nullyes
records[].linesarray<object>yes
records[].namestringyes
records[].notestring | nullyes
records[].priorityinteger | nullyes
records[].record"SPF" | "DKIM" | "DMARC" | "RETURN_PATH"yes
records[].requiredbooleanyes
records[].ttlintegeryes
records[].type"TXT" | "MX"yes
records[].valuestring | nullyes

Response example

200
{
  "domain": "example",
  "records": []
}

Errors

The codes this operation can answer with, and what to do about each. Every one arrives with its code, message, fix and docs_url.

  • internal_server_error (500, internal_server_error) — Unexpected error. Fix: Retry ONCE after a short pause, with the same Idempotency-Key so the retry cannot double-send. If it fails again, stop retrying and report the x-request-id from the response — that id is what identifies this exact failure in support.
  • invalid_parameter (422) — A parameter has an invalid value. Fix: Correct the named parameter and retry.
  • mailbox_provider_domain (422) — You cannot send as a mailbox provider’s domain. Fix: Add a domain you own with POST /domains, such as acme.com or mail.acme.com, and send from an address on it.
  • rate_limit_exceeded (429, rate_ceiling_exceeded, rate_limit_exceeded) — Too many requests. Fix: Back off and retry honoring the Retry-After header.
  • validation_error (400, domain_not_verified, invalid_parameter, validation_error) — Error in one or more fields. Fix: Correct the fields listed in the error details and retry the request.