deliverability

Embed

<a href="https://hermeticor.com/docs/ref-deliverability"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/cdde641f-86e7-4af2-8e6d-630d445560be/social-card.svg?v=3e7ae33eec8b" alt="deliverability" width="600" height="315"></a>

GEThttps://hermeticor.com/v1/deliverability/overview

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/deliverability/overview" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "domains": [
    {
      "domain": "string",
      "dnsbl": {
        "id": "string",
        "target": "string",
        "listed": true,
        "listings": [
          {
            "zone": "string",
            "code": "string"
          }
        ],
        "errors": [
          "string"
        ],
        "checkedAt": "2024-01-01T00:00:00Z"
      },
      "reputation": [
        {
          "id": "string",
          "source": "string",
          "domain": "string",
          "day": "string",
          "metrics": {
            "spamRate": 0,
            "domainReputation": "HIGH",
            "ipReputation": "HIGH",
            "authPassRate": 0
          }
        }
      ],
      "openAlerts": 0
    }
  ]
}

Schema

domainsobject[]required

Show child parameters

domainstringrequired

dnsblobjectrequired

Show child parameters

idstringrequired

targetstringrequired

listedbooleanrequired

listingsobject[]required

errorsstring[]required

checkedAtstringrequired

reputationReputationItem[]required

Show child parameters

idstringrequired

sourcestringrequired

domainstringrequired

daystringrequired

metricsobjectrequired

openAlertsintegerrequired

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · GET /v1/deliverability/overview

GEThttps://hermeticor.com/v1/deliverability/reputation

Parameters

domainstringqueryrequired

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/deliverability/reputation?domain=<domain>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "source": "string",
      "domain": "string",
      "day": "string",
      "metrics": {
        "spamRate": 0,
        "domainReputation": "HIGH",
        "ipReputation": "HIGH",
        "authPassRate": 0
      }
    }
  ],
  "nextCursor": "string"
}

Schema

itemsReputationItem[]required

Show child parameters

idstringrequired

sourcestringrequired

domainstringrequired

daystringrequired

metricsobjectrequired

Show child parameters

spamRatenumber

domainReputationstring

HIGH | MEDIUM | LOW | BAD

ipReputationstring

HIGH | MEDIUM | LOW | BAD

authPassRatenumber

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/deliverability/overview

5XX Default Response

Same as 4XX · GET /v1/deliverability/overview

POSThttps://hermeticor.com/v1/deliverability/dnsbl-checks

Request body

application/json

targetstringrequired

{
  "target": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/deliverability/dnsbl-checks" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"target":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "target": "string",
  "listed": true,
  "listings": [
    {
      "zone": "string",
      "code": "string"
    }
  ],
  "errors": [
    "string"
  ],
  "checkedAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

targetstringrequired

listedbooleanrequired

listingsobject[]required

Show child parameters

zonestringrequired

codestringrequired

errorsstring[]required

checkedAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/deliverability/overview

5XX Default Response

Same as 4XX · GET /v1/deliverability/overview

GEThttps://hermeticor.com/v1/deliverability/sources

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/deliverability/sources" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "kind": "google_postmaster",
      "name": "string",
      "domains": [
        "string"
      ],
      "lastSyncAt": "2024-01-01T00:00:00Z",
      "lastError": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem107[]required

Show child parameters

idstringrequired

kindstringrequired

google_postmaster | microsoft_snds

namestringrequired

domainsstring[]required

lastSyncAtstringrequired

lastErrorstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/deliverability/overview

5XX Default Response

Same as 4XX · GET /v1/deliverability/overview

POSThttps://hermeticor.com/v1/deliverability/sources

Request body

application/json

kindstringrequired

google_postmaster | microsoft_snds

namestringrequired

credentialsobjectrequired

domainsstring[]

= []

{
  "kind": "google_postmaster",
  "name": "string",
  "credentials": {},
  "domains": []
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/deliverability/sources" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"google_postmaster","name":"string","credentials":{},"domains":[]}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "kind": "google_postmaster",
  "name": "string",
  "domains": [
    "string"
  ],
  "lastSyncAt": "2024-01-01T00:00:00Z",
  "lastError": "string"
}

Schema

idstringrequired

kindstringrequired

google_postmaster | microsoft_snds

namestringrequired

domainsstring[]required

lastSyncAtstringrequired

lastErrorstringrequired

4XX Default Response

Same as 4XX · GET /v1/deliverability/overview

5XX Default Response

Same as 4XX · GET /v1/deliverability/overview

DELETEhttps://hermeticor.com/v1/deliverability/sources/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/deliverability/sources/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/deliverability/overview

5XX Default Response

Same as 4XX · GET /v1/deliverability/overview

GEThttps://hermeticor.com/v1/deliverability/rules

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/deliverability/rules" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "name": "string",
      "metric": "dnsbl_listed",
      "threshold": 0,
      "action": "notify",
      "id": "string",
      "enabled": true
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem108[]required

Show child parameters

namestringrequired

metricstringrequired

dnsbl_listed | spam_rate | bounce_rate | domain_reputation

thresholdnumberrequired

A fraction, not a percent: spam_rate and bounce_rate fire at or above it (0.003 = 0.3%, the Gmail line; 0.05 = 5% bounces); domain_reputation fires at or below 0 BAD, 1 LOW, 2 MEDIUM; dnsbl_listed ignores it

= 0

actionstringrequired

notify | pause | throttle = notify

idstringrequired

enabledbooleanrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/deliverability/overview

5XX Default Response

Same as 4XX · GET /v1/deliverability/overview

POSThttps://hermeticor.com/v1/deliverability/rules

Request body

application/json

namestringrequired

metricstringrequired

dnsbl_listed | spam_rate | bounce_rate | domain_reputation

thresholdnumber

= 0

actionstring

notify | pause | throttle = notify

{
  "name": "string",
  "metric": "dnsbl_listed",
  "threshold": 0,
  "action": "notify"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/deliverability/rules" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","metric":"dnsbl_listed","threshold":0,"action":"notify"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "name": "string",
  "metric": "dnsbl_listed",
  "threshold": 0,
  "action": "notify",
  "id": "string",
  "enabled": true
}

Schema

namestringrequired

metricstringrequired

dnsbl_listed | spam_rate | bounce_rate | domain_reputation

thresholdnumberrequired

= 0

actionstringrequired

notify | pause | throttle = notify

idstringrequired

enabledbooleanrequired

4XX Default Response

Same as 4XX · GET /v1/deliverability/overview

5XX Default Response

Same as 4XX · GET /v1/deliverability/overview

Next part

Updated Nov 8, 2026

Was this page helpful?