Endpoints
PATCH
https://hermetica.15.204.158.166.sslip.io /v1/members/{userId} Parameters
userIdstringpathrequiredRequest body
application/json
rolestringrequired{
"role": "owner"
}Code samples
cURL
curl -X PATCH "https://hermetica.15.204.158.166.sslip.io/v1/members/{userId}" \
-H "Authorization: Bearer $SSLIP_API_KEY" \
-H "Content-Type: application/json" \
-d '{"role":"owner"}'TypeScript
Python
Go
PHP
Ruby
Java
Responses
200 Default Response
Example
{
"ok": true
}Schema
okbooleanrequired4XX Default Response
Example
{
"error": {
"code": "string",
"message": "string",
"details": {}
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsobjectPUT
https://hermetica.15.204.158.166.sslip.io /v1/members/{userId}/lists Limit a member to specific lists (null = all lists)
Parameters
userIdstringpathrequiredRequest body
application/json
listIdsstring[]required{
"listIds": [
"string"
]
}Code samples
cURL
curl -X PUT "https://hermetica.15.204.158.166.sslip.io/v1/members/{userId}/lists" \
-H "Authorization: Bearer $SSLIP_API_KEY" \
-H "Content-Type: application/json" \
-d '{"listIds":["string"]}'TypeScript
Python
Go
PHP
Ruby
Java
Responses
GET
https://hermetica.15.204.158.166.sslip.io /v1/signup-domains Code samples
cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/signup-domains" \
-H "Authorization: Bearer $SSLIP_API_KEY"TypeScript
Python
Go
PHP
Ruby
Java
Responses
200 Default Response
Example
{
"allow": [
"string"
],
"block": [
"string"
]
}Schema
allowstring[]requiredblockstring[]requiredPUT
https://hermetica.15.204.158.166.sslip.io /v1/signup-domains Request body
application/json
allowstring[]requiredblockstring[]required{
"allow": [
"string"
],
"block": [
"string"
]
}Code samples
cURL
curl -X PUT "https://hermetica.15.204.158.166.sslip.io/v1/signup-domains" \
-H "Authorization: Bearer $SSLIP_API_KEY" \
-H "Content-Type: application/json" \
-d '{"allow":["string"],"block":["string"]}'TypeScript
Python
Go
PHP
Ruby
Java
Responses
POST
https://hermetica.15.204.158.166.sslip.io /v1/invitations/accept Request body
application/json
tokenstringrequired{
"token": "string"
}Code samples
cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/invitations/accept" \
-H "Authorization: Bearer $SSLIP_API_KEY" \
-H "Content-Type: application/json" \
-d '{"token":"string"}'TypeScript
Python
Go
PHP
Ruby
Java
Responses
200 Default Response
Example
{
"workspaceId": "string",
"role": "string"
}Schema
workspaceIdstringrequiredrolestringrequiredPOST
https://hermetica.15.204.158.166.sslip.io /v1/invitations/decline Decline an invitation (the link stops working)
Request body
application/json
tokenstringrequired{
"token": "string"
}Code samples
cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/invitations/decline" \
-H "Authorization: Bearer $SSLIP_API_KEY" \
-H "Content-Type: application/json" \
-d '{"token":"string"}'TypeScript
Python
Go
PHP
Ruby
Java
Responses
GET
https://hermetica.15.204.158.166.sslip.io /v1/workspace Code samples
cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/workspace" \
-H "Authorization: Bearer $SSLIP_API_KEY"TypeScript
Python
Go
PHP
Ruby
Java
Responses
200 Default Response
Example
{
"id": "string",
"organizationId": "string",
"name": "string",
"timezone": "string",
"locale": "string",
"postalAddress": "string",
"adminEmail": "string",
"unsubscribeRedirectUrl": "string",
"quietHours": {
"start": "string",
"end": "string"
},
"displayCurrency": "string",
"fxRates": {},
"sessionDays": 0,
"campaignNotifyEmails": [
"string"
],
"websiteUrl": "string",
"industry": "string"
}Schema
idstringrequiredorganizationIdstringrequirednamestringrequiredtimezonestringrequiredlocalestringrequiredpostalAddressstringrequiredadminEmailstringrequiredunsubscribeRedirectUrlstringrequiredquietHoursobjectrequiredShow child parameters
startstringrequiredendstringrequireddisplayCurrencystringrequiredfxRatesobjectrequiredsessionDaysintegerrequiredcampaignNotifyEmailsstring[]requiredwebsiteUrlstringindustrystringPATCH
https://hermetica.15.204.158.166.sslip.io /v1/workspace Request body
application/json
namestringtimezonestringlocalestringpostalAddressstringadminEmailstringunsubscribeRedirectUrlstringquietHoursobjectShow child parameters
startstringrequiredendstringrequireddisplayCurrencystringfxRatesobjectsessionDaysintegercampaignNotifyEmailsstring[]websiteUrlstringindustrystring{
"name": "string",
"timezone": "string",
"locale": "string",
"postalAddress": "string",
"adminEmail": "string",
"unsubscribeRedirectUrl": "string",
"quietHours": {
"start": "string",
"end": "string"
},
"displayCurrency": "string",
"fxRates": {},
"sessionDays": 0,
"campaignNotifyEmails": [
"string"
],
"websiteUrl": "string",
"industry": "ecommerce"
}Code samples
cURL
curl -X PATCH "https://hermetica.15.204.158.166.sslip.io/v1/workspace" \
-H "Authorization: Bearer $SSLIP_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"string","timezone":"string","locale":"string","postalAddress":"string","adminEmail":"string","unsubscribeRedirectUrl":"string","quietHours":{"start":"string","end":"string"},"displayCurrency":"string","fxRates":{},"sessionDays":0,"campaignNotifyEmails":["string"],"websiteUrl":"string","industry":"ecommerce"}'TypeScript
Python
Go
PHP
Ruby
Java
Responses
GET
https://hermetica.15.204.158.166.sslip.io /v1/audit Parameters
limitintegerquerycursorstringqueryactionstringquerytargetTypestringqueryfromstringquerytostringqueryCode samples
cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/audit" \
-H "Authorization: Bearer $SSLIP_API_KEY"TypeScript
Python
Go
PHP
Ruby
Java
Responses
200 Default Response
Example
{
"items": [
{
"id": "string",
"actorType": "string",
"actorId": "string",
"impersonatedBy": "string",
"action": "string",
"targetType": "string",
"targetId": "string",
"before": {},
"after": {},
"at": "2024-01-01T00:00:00Z"
}
],
"nextCursor": "string"
}Schema
itemsobject[]requiredShow child parameters
idstringrequiredactorTypestringrequiredactorIdstringrequiredimpersonatedBystringactionstringrequiredtargetTypestringrequiredtargetIdstringrequiredbeforerequiredafterrequiredatstringrequirednextCursorstringrequiredGET
https://hermetica.15.204.158.166.sslip.io /v1/audit/export Audit log as CSV or NDJSON (max 10,000 rows). A SIEM can poll with order=asc and from=<last timestamp>.
Parameters
actionstringquerytargetTypestringqueryfromstringquerytostringqueryformatstringqueryorderstringqueryCode samples
cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/audit/export" \
-H "Authorization: Bearer $SSLIP_API_KEY"TypeScript
Python
Go
PHP
Ruby
Java
Responses
200 Default Response
Example
{
"filename": "string",
"format": "csv",
"rowCount": 0,
"truncated": true,
"content": "string"
}Schema
filenamestringrequiredformatstringrequiredrowCountintegerrequiredtruncatedbooleanrequiredcontentstringrequiredUpdated