API Endpoints Reference

GET /api/v1/dns-check

Performs a comprehensive DNS lookup for a domain, returning A, AAAA, MX, TXT, CNAME, and NS records.

Parameters

Parameter	Type	Required	Description
domain	string	✅	Domain to check (e.g. example.com)

Example Request

curl -H "Authorization: Bearer pt_..." \
  "https://provider.tools/api/v1/dns-check?domain=example.com"

Example Response

{
  "success": true,
  "data": {
    "domain": "example.com",
    "a": ["93.184.216.34"],
    "aaaa": ["2606:2800:220:1:248:1893:25c8:1946"],
    "mx": [{"exchange": "mail.example.com", "priority": 10}],
    "txt": ["v=spf1 include:_spf.google.com ~all"],
    "cname": [],
    "ns": ["ns1.example.com", "ns2.example.com"]
  }
}

GET /api/v1/ssl-check

Retrieves and analyzes the SSL/TLS certificate for a domain, including validity, expiration, issuer, and cipher details.

Parameters

Parameter	Type	Required	Description
domain	string	✅	Domain to check (e.g. example.com)

Example Request

curl -H "Authorization: Bearer pt_..." \
  "https://provider.tools/api/v1/ssl-check?domain=example.com"

Example Response

{
  "success": true,
  "data": {
    "domain": "example.com",
    "subject": {"CN": "example.com"},
    "issuer": {"O": "Let's Encrypt", "CN": "R3"},
    "validFrom": "2024-01-01T00:00:00.000Z",
    "validTo": "2024-04-01T00:00:00.000Z",
    "daysRemaining": 42,
    "isExpired": false,
    "serialNumber": "03:AB:CD:EF:...",
    "subjectAltNames": ["example.com", "www.example.com"],
    "protocol": "TLSv1.3",
    "cipher": {"name": "TLS_AES_256_GCM_SHA384", "version": "TLSv1.3"}
  }
}

GET /api/v1/blacklist-check

Checks an IPv4 address against 80+ DNS-based blacklists (DNSBLs) to identify listing status.

Parameters

Parameter	Type	Required	Description
ip	string	✅	IPv4 address to check (e.g. 1.2.3.4)

Example Request

curl -H "Authorization: Bearer pt_..." \
  "https://provider.tools/api/v1/blacklist-check?ip=1.2.3.4"

Example Response

{
  "success": true,
  "data": {
    "ip": "1.2.3.4",
    "totalChecked": 84,
    "listedCount": 2,
    "cleanCount": 82,
    "blacklists": [
      {"name": "Spamhaus SBL", "dnsbl": "sbl.spamhaus.org", "listed": true, "category": "critical"},
      {"name": "Barracuda", "dnsbl": "b.barracudacentral.org", "listed": true, "category": "major"},
      {"name": "SpamCop", "dnsbl": "bl.spamcop.net", "listed": false, "category": "critical"},
      ...
    ]
  }
}

GET /api/v1/dmarc-check

Validates the DMARC, SPF, and DKIM DNS records for a domain. Checks common DKIM selectors automatically.

Parameters

Parameter	Type	Required	Description
domain	string	✅	Domain to check (e.g. example.com)

Example Request

curl -H "Authorization: Bearer pt_..." \
  "https://provider.tools/api/v1/dmarc-check?domain=example.com"

Example Response

{
  "success": true,
  "data": {
    "domain": "example.com",
    "dmarc": {
      "found": true,
      "record": "v=DMARC1; p=quarantine; rua=mailto:dmarc@example.com; pct=100",
      "tags": {"v": "DMARC1", "p": "quarantine", "rua": "mailto:dmarc@example.com", "pct": "100"}
    },
    "spf": {
      "found": true,
      "record": "v=spf1 include:_spf.google.com ~all"
    },
    "dkim": [
      {"selector": "google", "found": true, "record": "v=DKIM1; k=rsa; p=MIIBIj..."}
    ]
  }
}

GET /api/v1/dmarc/domains

Lists all DMARC domains configured in your account.

Example Response

{
  "success": true,
  "data": [
    {
      "id": "abc-123",
      "domain": "example.com",
      "verified": true,
      "reportEmail": "dmarc-rua@provider.tools",
      "totalReports": 42,
      "lastReportAt": "2025-01-15T10:30:00.000Z",
      "createdAt": "2024-06-01T00:00:00.000Z"
    }
  ]
}

GET /api/v1/dmarc/domains/:domainId/reports

Retrieves paginated DMARC aggregate reports for a specific domain.

Parameters

Parameter	Type	Required	Description
:domainId	path	✅	Domain ID from the domains list
page	query	❌	Page number (default: 1)
limit	query	❌	Items per page (default: 20, max: 100)

GET /api/v1/monitoring/hosts

Lists all monitored hosts/IPs from your Blacklist Monitoring.

Example Response

{
  "success": true,
  "data": [
    {
      "id": "def-456",
      "host": "mail.example.com",
      "label": "Primary MX",
      "status": "clean",
      "listedCount": 0,
      "totalChecked": 84,
      "lastCheckAt": "2025-01-15T12:00:00.000Z"
    }
  ]
}

GET /api/v1/delisting/status

Lists your active and completed delisting processes with detailed step information per blacklist.

Parameters

Parameter	Type	Required	Description
ip	query	No	Filter by IP address
status	query	No	Filter: pending, in-progress, completed, failed
page	query	No	Page number (default: 1)
limit	query	No	Items per page (default: 20, max: 100)

Example Request

curl -H "Authorization: Bearer pt_..." \
  "https://provider.tools/api/v1/delisting/status?ip=1.2.3.4"

Example Response

{
  "success": true,
  "data": {
    "processes": [{
      "id": "abc-123",
      "ip": "1.2.3.4",
      "status": "in-progress",
      "totalListings": 3,
      "stepsCompleted": 1,
      "stepsRunning": 2,
      "steps": [
        {"blacklistName": "Spamhaus SBL", "dnsbl": "sbl.spamhaus.org", "method": "automatic", "status": "completed"},
        {"blacklistName": "Barracuda", "dnsbl": "b.barracudacentral.org", "method": "email", "status": "waiting"}
      ]
    }],
    "pagination": {"page": 1, "total": 1, "totalPages": 1}
  }
}

Step Status Values

Status	Description
pending	Not yet started
running	AI agent actively working
email-sent	Delisting email sent
waiting	Awaiting blacklist response
completed	Successfully delisted
failed	Delisting failed