connections

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-connections"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/f97af7f7-078d-4412-8c6a-b40f548f2c71/social-card.svg?v=3e7ae33eec8b" alt="connections" width="600" height="315"></a>
POSThttps://hermeticor.com/v1/connections/{id}/ses/tenant

Create an SES tenant in your own AWS account and associate the domain identity and configuration set with it (unverified against live AWS)

Parameters

idstringpathrequired

Request body

application/json
tenantNamestringrequired
domainstringrequired
awsAccountIdstringrequired
{
  "tenantName": "string",
  "domain": "string",
  "awsAccountId": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/connections/{id}/ses/tenant" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tenantName":"string","domain":"string","awsAccountId":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "tenantName": "string",
  "associated": [
    "string"
  ]
}
Schema
tenantNamestringrequired
associatedstring[]required
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · POST /v1/connections/{id}/ses/tenant

POSThttps://hermeticor.com/v1/connections/{id}/ses/setup

Create the SES domain identity, Easy DKIM, MAIL FROM, configuration set and SNS event destination in the customer account

Parameters

idstringpathrequired

Request body

application/json
domainstringrequired
{
  "domain": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/connections/{id}/ses/setup" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domain":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "domain": "string",
  "verified": true,
  "dkimStatus": "string",
  "mailFromStatus": "string",
  "configurationSet": "string",
  "topicArn": "string",
  "records": [
    {
      "purpose": "dkim",
      "type": "CNAME",
      "name": "string",
      "value": "string",
      "priority": 0,
      "required": true
    }
  ]
}
Schema
domainstringrequired
verifiedbooleanrequired
dkimStatusstringrequired
mailFromStatusstringrequired
configurationSetstringrequired
topicArnstringrequired
recordsRecordsItem2[]required
Show child parameters
purposestringrequired
dkim | mail_from_mx | mail_from_spf | dmarc
typestringrequired
CNAME | MX | TXT
namestringrequired
valuestringrequired
priorityinteger
requiredbooleanrequired
4XX Default Response

Same as 4XX · POST /v1/connections/{id}/ses/tenant

5XX Default Response

Same as 4XX · POST /v1/connections/{id}/ses/tenant

POSThttps://hermeticor.com/v1/connections/{id}/ses/recheck

Re-read SES identity verification and DKIM status

Parameters

idstringpathrequired

Request body

application/json
domainstringrequired
{
  "domain": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/connections/{id}/ses/recheck" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domain":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · POST /v1/connections/{id}/ses/setup

4XX Default Response

Same as 4XX · POST /v1/connections/{id}/ses/tenant

5XX Default Response

Same as 4XX · POST /v1/connections/{id}/ses/tenant

POSThttps://hermeticor.com/v1/connections/{id}/ses/byodkim

Sign with your own DKIM key (pasted or generated here); the private key goes to SES and is never stored or returned

Parameters

idstringpathrequired

Request body

application/json
domainstringrequired
selectorstringrequired
privateKeystring
{
  "domain": "string",
  "selector": "string",
  "privateKey": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/connections/{id}/ses/byodkim" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domain":"string","selector":"string","privateKey":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "domain": "string",
  "verified": true,
  "dkimStatus": "string",
  "mailFromStatus": "string",
  "configurationSet": "string",
  "topicArn": "string",
  "records": [
    {
      "purpose": "dkim",
      "type": "CNAME",
      "name": "string",
      "value": "string",
      "priority": 0,
      "required": true
    }
  ],
  "generatedKey": true,
  "selector": "string"
}
Schema
domainstringrequired
verifiedbooleanrequired
dkimStatusstringrequired
mailFromStatusstringrequired
configurationSetstringrequired
topicArnstringrequired
recordsRecordsItem2[]required
Show child parameters
purposestringrequired
dkim | mail_from_mx | mail_from_spf | dmarc
typestringrequired
CNAME | MX | TXT
namestringrequired
valuestringrequired
priorityinteger
requiredbooleanrequired
generatedKeybooleanrequired
selectorstringrequired
4XX Default Response

Same as 4XX · POST /v1/connections/{id}/ses/tenant

5XX Default Response

Same as 4XX · POST /v1/connections/{id}/ses/tenant

GEThttps://hermeticor.com/v1/sending-domains/{id}

One sending domain by id or name, with its last DNS check

Parameters

idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/sending-domains/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "id": "string",
  "domain": "string"
}
Schema
idstringrequired
domainstringrequired
4XX Default Response

Same as 4XX · POST /v1/connections/{id}/ses/tenant

5XX Default Response

Same as 4XX · POST /v1/connections/{id}/ses/tenant

DELETEhttps://hermeticor.com/v1/sending-domains/{id}

Delete a sending domain (refused while senders still use it)

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/sending-domains/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response

Same as 4XX · POST /v1/connections/{id}/ses/tenant

5XX Default Response

Same as 4XX · POST /v1/connections/{id}/ses/tenant

PATCHhttps://hermeticor.com/v1/sending-domains/{id}

Set open and click tracking for mail sent from this domain (null = follow the workspace setting)

Parameters

idstringpathrequired

Request body

application/json
openTrackingboolean
clickTrackingboolean
{
  "openTracking": true,
  "clickTracking": true
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/sending-domains/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"openTracking":true,"clickTracking":true}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/sending-domains/{id}

4XX Default Response

Same as 4XX · POST /v1/connections/{id}/ses/tenant

5XX Default Response

Same as 4XX · POST /v1/connections/{id}/ses/tenant

GEThttps://hermeticor.com/v1/senders

Every sender identity in the workspace, across connections

Parameters

channelstringquery
email | sms | whatsapp | push | postcard
domainstringquery
verifiedstringquery
true | false
qstringquery
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/senders" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "connectionId": "string",
      "connectionName": "string",
      "connectionKind": "string",
      "connectionStatus": "string",
      "channel": "string",
      "fromEmail": "string",
      "fromName": "string",
      "replyTo": "string",
      "phoneNumber": "string",
      "senderIdAlpha": "string",
      "domain": "string",
      "verifiedAt": "2024-01-01T00:00:00Z",
      "createdAt": "2024-01-01T00:00:00Z",
      "dnsChecks": {}
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem46[]required
Show child parameters
idstringrequired
connectionIdstringrequired
connectionNamestringrequired
connectionKindstringrequired
connectionStatusstringrequired
channelstringrequired
fromEmailstringrequired
fromNamestringrequired
replyTostringrequired
phoneNumberstringrequired
senderIdAlphastringrequired
domainstringrequired
verifiedAtstringrequired
createdAtstringrequired
dnsChecks
nextCursorstringrequired
4XX Default Response

Same as 4XX · POST /v1/connections/{id}/ses/tenant

5XX Default Response

Same as 4XX · POST /v1/connections/{id}/ses/tenant

Updated