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/agent/history

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/agent/history" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "ruleId": "string",
      "domain": "string",
      "metric": "dnsbl_listed",
      "value": "string",
      "action": "notify",
      "status": "open",
      "pausedConnections": [
        "string"
      ],
      "openedAt": "2024-01-01T00:00:00Z",
      "resolvedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem109[]required

Show child parameters

idstringrequired

ruleIdstringrequired

domainstringrequired

metricstringrequired

dnsbl_listed | spam_rate | bounce_rate | domain_reputation

valuestringrequired

actionstringrequired

notify | pause | throttle

statusstringrequired

open | resolved

pausedConnectionsstring[]required

openedAtstringrequired

resolvedAtstringrequired

nextCursorstringrequired

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/agent/history

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

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/warmup" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "connectionId": "string",
      "address": "string",
      "status": "off",
      "pausedReason": "string",
      "fix": "string",
      "startedOn": "string",
      "quotaToday": 0,
      "lastError": "string",
      "lastErrorAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

connectionIdstringrequired

addressstringrequired

statusstringrequired

off | active | paused

pausedReasonstringrequired

fixstringrequired

startedOnstringrequired

quotaTodayintegerrequired

lastErrorstringrequired

lastErrorAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/deliverability/agent/history

5XX Default Response

Same as 4XX · GET /v1/deliverability/agent/history

GEThttps://hermeticor.com/v1/deliverability/alerts/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "ruleId": "string",
  "domain": "string",
  "metric": "dnsbl_listed",
  "value": "string",
  "action": "notify",
  "status": "open",
  "pausedConnections": [
    "string"
  ],
  "openedAt": "2024-01-01T00:00:00Z",
  "resolvedAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

ruleIdstringrequired

domainstringrequired

metricstringrequired

dnsbl_listed | spam_rate | bounce_rate | domain_reputation

valuestringrequired

actionstringrequired

notify | pause | throttle

statusstringrequired

open | resolved

pausedConnectionsstring[]required

openedAtstringrequired

resolvedAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/deliverability/agent/history

5XX Default Response

Same as 4XX · GET /v1/deliverability/agent/history

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

Parameters

statusstringquery

open | actioned | completed | dismissed

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/recommendations" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "alertId": "string",
      "domain": "string",
      "metric": "string",
      "value": "string",
      "title": "string",
      "detail": "string",
      "status": "open",
      "action": "pause_mailboxes",
      "connectionIds": [
        "string"
      ],
      "actioned": [
        "string"
      ],
      "problemOpen": true,
      "createdAt": "2024-01-01T00:00:00Z",
      "actionedAt": "2024-01-01T00:00:00Z",
      "resumeAt": "2024-01-01T00:00:00Z",
      "resumedAt": "2024-01-01T00:00:00Z",
      "completedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem113[]required

Show child parameters

idstringrequired

alertIdstringrequired

domainstringrequired

metricstringrequired

valuestringrequired

titlestringrequired

detailstringrequired

statusstringrequired

open | actioned | completed | dismissed

actionstringrequired

pause_mailboxes | pause_14d

connectionIdsstring[]required

actionedstring[]required

problemOpenbooleanrequired

createdAtstringrequired

actionedAtstringrequired

resumeAtstringrequired

resumedAtstringrequired

completedAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/deliverability/agent/history

5XX Default Response

Same as 4XX · GET /v1/deliverability/agent/history

POSThttps://hermeticor.com/v1/deliverability/recommendations/{id}/pause-mailboxes

Pause the mailboxes on the affected domain until you resume them. Repeating it changes nothing

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/deliverability/recommendations/{id}/pause-mailboxes" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "alertId": "string",
  "domain": "string",
  "metric": "string",
  "value": "string",
  "title": "string",
  "detail": "string",
  "status": "open",
  "action": "pause_mailboxes",
  "connectionIds": [
    "string"
  ],
  "actioned": [
    "string"
  ],
  "problemOpen": true,
  "createdAt": "2024-01-01T00:00:00Z",
  "actionedAt": "2024-01-01T00:00:00Z",
  "resumeAt": "2024-01-01T00:00:00Z",
  "resumedAt": "2024-01-01T00:00:00Z",
  "completedAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

alertIdstringrequired

domainstringrequired

metricstringrequired

valuestringrequired

titlestringrequired

detailstringrequired

statusstringrequired

open | actioned | completed | dismissed

actionstringrequired

pause_mailboxes | pause_14d

connectionIdsstring[]required

actionedstring[]required

problemOpenbooleanrequired

createdAtstringrequired

actionedAtstringrequired

resumeAtstringrequired

resumedAtstringrequired

completedAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/deliverability/agent/history

5XX Default Response

Same as 4XX · GET /v1/deliverability/agent/history

POSThttps://hermeticor.com/v1/deliverability/recommendations/{id}/pause-14-days

Pause sending from the affected mailboxes for 14 days; they resume on their own. Repeating it keeps the first resume date

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/deliverability/recommendations/{id}/pause-14-days" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/deliverability/recommendations/{id}/pause-mailboxes

4XX Default Response

Same as 4XX · GET /v1/deliverability/agent/history

5XX Default Response

Same as 4XX · GET /v1/deliverability/agent/history

POSThttps://hermeticor.com/v1/deliverability/recommendations/{id}/complete

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/deliverability/recommendations/{id}/pause-mailboxes

4XX Default Response

Same as 4XX · GET /v1/deliverability/agent/history

5XX Default Response

Same as 4XX · GET /v1/deliverability/agent/history

POSThttps://hermeticor.com/v1/deliverability/recommendations/{id}/dismiss

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/deliverability/recommendations/{id}/pause-mailboxes

4XX Default Response

Same as 4XX · GET /v1/deliverability/agent/history

5XX Default Response

Same as 4XX · GET /v1/deliverability/agent/history

Next part

Updated Nov 8, 2026

Was this page helpful?