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>
GEThttps://hermeticor.com/v1/senders/{id}

Parameters

idstringpathrequired

Code samples

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

Responses

200 Default Response
Example
{
  "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": {}
}
Schema
idstringrequired
connectionIdstringrequired
connectionNamestringrequired
connectionKindstringrequired
connectionStatusstringrequired
channelstringrequired
fromEmailstringrequired
fromNamestringrequired
replyTostringrequired
phoneNumberstringrequired
senderIdAlphastringrequired
domainstringrequired
verifiedAtstringrequired
createdAtstringrequired
dnsChecks
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/senders/{id}

GEThttps://hermeticor.com/v1/senders/{id}/stats

Parameters

limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page
idstringpathrequired

Code samples

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "period": "string",
      "sent": 0,
      "delivered": 0,
      "bounced": 0,
      "complained": 0,
      "blocked": 0,
      "opens": 0,
      "clicks": 0
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem50[]required
Show child parameters
periodstringrequired
sentintegerrequired
deliveredintegerrequired
bouncedintegerrequired
complainedintegerrequired
blockedintegerrequired
opensintegerrequired
clicksintegerrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/senders/{id}

5XX Default Response

Same as 4XX · GET /v1/senders/{id}

GEThttps://hermeticor.com/v1/senders/{id}/signing

S/MIME certificate and PGP signing key of an email sender (metadata only; private parts never leave the vault)

Parameters

idstringpathrequired

Code samples

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

Responses

200 Default Response
Example
{
  "smime": {
    "subject": "string",
    "issuer": "string",
    "notAfter": "2024-01-01T00:00:00Z",
    "fingerprint": "string"
  },
  "pgp": {
    "fingerprint": "string",
    "userIds": [
      "string"
    ]
  }
}
Schema
smimeobjectrequired
Show child parameters
subjectstringrequired
issuerstringrequired
notAfterstringrequired
fingerprintstringrequired
pgpobjectrequired
Show child parameters
fingerprintstringrequired
userIdsstring[]required
4XX Default Response

Same as 4XX · GET /v1/senders/{id}

5XX Default Response

Same as 4XX · GET /v1/senders/{id}

PUThttps://hermeticor.com/v1/senders/{id}/signing/smime

Sign this sender's email with S/MIME: PEM certificate issued for its address, its unencrypted private key, optional chain

Parameters

idstringpathrequired

Request body

application/json
certificatePemstringrequired
privateKeyPemstringrequired
chainPemstring
{
  "certificatePem": "string",
  "privateKeyPem": "string",
  "chainPem": "string"
}

Code samples

cURL
curl -X PUT "https://hermeticor.com/v1/senders/{id}/signing/smime" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"certificatePem":"string","privateKeyPem":"string","chainPem":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/senders/{id}/signing

4XX Default Response

Same as 4XX · GET /v1/senders/{id}

5XX Default Response

Same as 4XX · GET /v1/senders/{id}

PUThttps://hermeticor.com/v1/senders/{id}/signing/pgp

Sign this sender's email with PGP/MIME: an armored private key with a user id for its address, and its passphrase

Parameters

idstringpathrequired

Request body

application/json
privateKeyArmoredstringrequired
passphrasestring
{
  "privateKeyArmored": "string",
  "passphrase": "string"
}

Code samples

cURL
curl -X PUT "https://hermeticor.com/v1/senders/{id}/signing/pgp" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"privateKeyArmored":"string","passphrase":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/senders/{id}/signing

4XX Default Response

Same as 4XX · GET /v1/senders/{id}

5XX Default Response

Same as 4XX · GET /v1/senders/{id}

DELETEhttps://hermeticor.com/v1/senders/{id}/signing/{kind}

Parameters

idstringpathrequired
kindstringpathrequired
smime | pgp

Code samples

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

Responses

200 Default Response

Same as 200 · GET /v1/senders/{id}/signing

4XX Default Response

Same as 4XX · GET /v1/senders/{id}

5XX Default Response

Same as 4XX · GET /v1/senders/{id}

Updated