Endpoints

Embed

<a href="https://hermeticor.com/docs/ref-endpoints"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/30cd59e5-acb1-4277-a050-481f9f4dc46f/social-card.svg?v=3e7ae33eec8b" alt="Endpoints" width="600" height="315"></a>

POSThttps://hermetica.15.204.158.166.sslip.io/ingest/v1/segment

Segment/RudderStack-compatible track, identify, page

Request body

application/json

typestringrequired

track | identify | page | screen

eventstring

namestring

userIdstring

anonymousIdstring

messageIdstring

timestampstring

propertiesobject

traitsobject

contextobject

Show child parameters

traitsobject

userAgentstring

ipstring

pageobject

consentobject

Show child parameters

analyticsboolean

marketingboolean

{
  "type": "track",
  "event": "string",
  "name": "string",
  "userId": "string",
  "anonymousId": "string",
  "messageId": "string",
  "timestamp": "string",
  "properties": {},
  "traits": {},
  "context": {
    "traits": {},
    "userAgent": "string",
    "ip": "string",
    "page": {}
  },
  "consent": {
    "analytics": true,
    "marketing": true
  }
}

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/ingest/v1/segment" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":"track","event":"string","name":"string","userId":"string","anonymousId":"string","messageId":"string","timestamp":"string","properties":{},"traits":{},"context":{"traits":{},"userAgent":"string","ip":"string","page":{}},"consent":{"analytics":true,"marketing":true}}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "accepted": 0,
  "duplicates": 0,
  "rejected": [
    {
      "index": 0,
      "reason": "string"
    }
  ],
  "profileId": "string"
}

Schema

acceptedintegerrequired

duplicatesintegerrequired

rejectedobject[]required

Show child parameters

indexintegerrequired

reasonstringrequired

profileIdstring

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 /ingest/v1/segment

GEThttps://hermetica.15.204.158.166.sslip.io/v1/roles

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/roles" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

[
  {
    "name": "string",
    "baseRole": "admin",
    "grant": [],
    "deny": [],
    "restrictions": {},
    "id": "string",
    "scopes": [
      "string"
    ]
  }
]

Schema

namestringrequired

baseRolestringrequired

admin | marketer | sales | analyst | viewer

grantstring[]required

= []

denystring[]required

= []

restrictionsobjectrequired

= {}

idstringrequired

scopesstring[]required

4XX Default Response

Same as 4XX · POST /ingest/v1/segment

5XX Default Response

Same as 4XX · POST /ingest/v1/segment

POSThttps://hermetica.15.204.158.166.sslip.io/v1/roles

Request body

application/json

namestringrequired

baseRolestringrequired

admin | marketer | sales | analyst | viewer

grantstring[]

= []

denystring[]

= []

restrictionsobject

= {}

{
  "name": "string",
  "baseRole": "admin",
  "grant": [],
  "deny": [],
  "restrictions": {}
}

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/roles" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","baseRole":"admin","grant":[],"deny":[],"restrictions":{}}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "name": "string",
  "baseRole": "admin",
  "grant": [],
  "deny": [],
  "restrictions": {},
  "id": "string",
  "scopes": [
    "string"
  ]
}

Schema

namestringrequired

baseRolestringrequired

admin | marketer | sales | analyst | viewer

grantstring[]required

= []

denystring[]required

= []

restrictionsobjectrequired

= {}

idstringrequired

scopesstring[]required

4XX Default Response

Same as 4XX · POST /ingest/v1/segment

5XX Default Response

Same as 4XX · POST /ingest/v1/segment

PUThttps://hermetica.15.204.158.166.sslip.io/v1/roles/{id}

Parameters

idstringpathrequired

Request body

application/json

namestringrequired

baseRolestringrequired

admin | marketer | sales | analyst | viewer

grantstring[]

= []

denystring[]

= []

restrictionsobject

= {}

{
  "name": "string",
  "baseRole": "admin",
  "grant": [],
  "deny": [],
  "restrictions": {}
}

Code samples

cURL

curl -X PUT "https://hermetica.15.204.158.166.sslip.io/v1/roles/{id}" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","baseRole":"admin","grant":[],"deny":[],"restrictions":{}}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/roles

4XX Default Response

Same as 4XX · POST /ingest/v1/segment

5XX Default Response

Same as 4XX · POST /ingest/v1/segment

DELETEhttps://hermetica.15.204.158.166.sslip.io/v1/roles/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermetica.15.204.158.166.sslip.io/v1/roles/{id}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · POST /ingest/v1/segment

5XX Default Response

Same as 4XX · POST /ingest/v1/segment

PUThttps://hermetica.15.204.158.166.sslip.io/v1/members/{userId}/custom-role

Parameters

userIdstringpathrequired

Request body

application/json

roleIdstringrequired

{
  "roleId": "string"
}

Code samples

cURL

curl -X PUT "https://hermetica.15.204.158.166.sslip.io/v1/members/{userId}/custom-role" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"roleId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/roles/{id}

4XX Default Response

Same as 4XX · POST /ingest/v1/segment

5XX Default Response

Same as 4XX · POST /ingest/v1/segment

GEThttps://hermetica.15.204.158.166.sslip.io/v1/compliance/gpc

Whether a browser Global Privacy Control / Do Not Track signal counts as a tracking opt-out (default on)

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/compliance/gpc" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "honour": true
}

Schema

honourbooleanrequired

4XX Default Response

Same as 4XX · POST /ingest/v1/segment

5XX Default Response

Same as 4XX · POST /ingest/v1/segment

PUThttps://hermetica.15.204.158.166.sslip.io/v1/compliance/gpc

Request body

application/json

honourbooleanrequired

{
  "honour": true
}

Code samples

cURL

curl -X PUT "https://hermetica.15.204.158.166.sslip.io/v1/compliance/gpc" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"honour":true}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/compliance/gpc

4XX Default Response

Same as 4XX · POST /ingest/v1/segment

5XX Default Response

Same as 4XX · POST /ingest/v1/segment

GEThttps://hermetica.15.204.158.166.sslip.io/v1/compliance/trash-retention

Days deleted campaigns, lists and archived templates stay restorable (0 = forever)

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/compliance/trash-retention" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "days": 0
}

Schema

daysintegerrequired

4XX Default Response

Same as 4XX · POST /ingest/v1/segment

5XX Default Response

Same as 4XX · POST /ingest/v1/segment

PUThttps://hermetica.15.204.158.166.sslip.io/v1/compliance/trash-retention

Request body

application/json

daysintegerrequired

{
  "days": 0
}

Code samples

cURL

curl -X PUT "https://hermetica.15.204.158.166.sslip.io/v1/compliance/trash-retention" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"days":0}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/compliance/trash-retention

4XX Default Response

Same as 4XX · POST /ingest/v1/segment

5XX Default Response

Same as 4XX · POST /ingest/v1/segment

GEThttps://hermetica.15.204.158.166.sslip.io/v1/compliance/retention

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/compliance/retention" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

[
  {
    "dataClass": "string",
    "retainDays": 0,
    "isDefault": true
  }
]

Schema

dataClassstringrequired

retainDaysnumberrequired

isDefaultbooleanrequired

4XX Default Response

Same as 4XX · POST /ingest/v1/segment

5XX Default Response

Same as 4XX · POST /ingest/v1/segment

Next part

Updated Nov 2, 2026

Was this page helpful?