Endpoints

Embed

<a href="https://hermetica.15.204.158.166.sslip.io/docs/ref-endpoints"><img src="https://hermetica.15.204.158.166.sslip.io/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>

GEThttps://hermetica.15.204.158.166.sslip.io/healthz

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true,
  "version": "string",
  "commit": "string"
}

Schema

okbooleanrequired

true

versionstringrequired

commitstringrequired

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 /healthz

GEThttps://hermetica.15.204.158.166.sslip.io/readyz

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "db": true,
  "redis": true
}

Schema

dbbooleanrequired

redisbooleanrequired

4XX Default Response

Same as 4XX · GET /healthz

5XX Default Response

Same as 4XX · GET /healthz

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

Running version, whether a newer release exists, and the operator banner

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "version": "string",
  "latest": "string",
  "updateAvailable": true,
  "releaseUrl": "string",
  "banner": "string"
}

Schema

versionstringrequired

lateststringrequired

updateAvailablebooleanrequired

releaseUrlstringrequired

bannerstringrequired

4XX Default Response

Same as 4XX · GET /healthz

5XX Default Response

Same as 4XX · GET /healthz

POSThttps://hermetica.15.204.158.166.sslip.io/v1/auth/dev-login

Dev only (AUTH_DEV_LOGIN): sign in by email, creating the account if new

Request body

application/json

emailstringrequired

namestring

{
  "email": "string",
  "name": "string"
}

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/auth/dev-login" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"string","name":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "user": {
    "id": "string",
    "email": "string",
    "name": "string",
    "avatarUrl": "string",
    "emailVerified": true
  },
  "workspace": {
    "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"
  },
  "expiresAt": "2024-01-01T00:00:00Z"
}

Schema

userobjectrequired

Show child parameters

idstringrequired

emailstringrequired

namestringrequired

avatarUrlstring

emailVerifiedboolean

workspaceobjectrequired

Show child parameters

idstringrequired

organizationIdstringrequired

namestringrequired

timezonestringrequired

localestringrequired

postalAddressstringrequired

adminEmailstringrequired

unsubscribeRedirectUrlstringrequired

quietHoursobjectrequired

Show child parameters

startstringrequired

endstringrequired

displayCurrencystringrequired

fxRatesobjectrequired

sessionDaysintegerrequired

campaignNotifyEmailsstring[]required

websiteUrlstring

industrystring

expiresAtstringrequired

4XX Default Response

Same as 4XX · GET /healthz

5XX Default Response

Same as 4XX · GET /healthz

POSThttps://hermetica.15.204.158.166.sslip.io/v1/auth/logout

Sign out here and at Atlas; the browser then visits redirectTo (Atlas end-session) when set

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/auth/logout" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true,
  "redirectTo": "string"
}

Schema

okbooleanrequired

true

redirectTostringrequired

4XX Default Response

Same as 4XX · GET /healthz

5XX Default Response

Same as 4XX · GET /healthz

POSThttps://hermetica.15.204.158.166.sslip.io/v1/members/{userId}/impersonate

Owner only: open a one-hour session as another member (audited). The owner's own session is kept and comes back with /v1/impersonation/stop

Parameters

userIdstringpathrequired

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/members/{userId}/impersonate" \
  -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 · GET /healthz

5XX Default Response

Same as 4XX · GET /healthz

POSThttps://hermetica.15.204.158.166.sslip.io/v1/impersonation/stop

End the impersonation session and return to the owner's own session

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/impersonation/stop" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/members/{userId}/impersonate

4XX Default Response

Same as 4XX · GET /healthz

5XX Default Response

Same as 4XX · GET /healthz

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

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "actor": {
    "type": "string",
    "id": "string",
    "workspaceId": "string",
    "role": "owner",
    "scopes": [
      "string"
    ]
  },
  "user": {
    "id": "string",
    "email": "string",
    "name": "string",
    "avatarUrl": "string",
    "emailVerified": true
  },
  "workspaces": [
    {
      "id": "string",
      "name": "string",
      "role": "owner"
    }
  ],
  "impersonatedBy": {
    "id": "string",
    "name": "string"
  },
  "operator": true
}

Schema

actorobjectrequired

Show child parameters

typestringrequired

idstringrequired

workspaceIdstringrequired

rolestring

scopesstring[]required

userobjectrequired

Show child parameters

idstringrequired

emailstringrequired

namestringrequired

avatarUrlstring

emailVerifiedboolean

workspacesobject[]required

Show child parameters

idstringrequired

namestringrequired

rolestringrequired

impersonatedByobject

Show child parameters

idstringrequired

namestringrequired

operatorboolean

4XX Default Response

Same as 4XX · GET /healthz

5XX Default Response

Same as 4XX · GET /healthz

PATCHhttps://hermetica.15.204.158.166.sslip.io/v1/me

Change your own display name and avatar

Request body

application/json

namestring

avatarUrlstring

{
  "name": "string",
  "avatarUrl": "string"
}

Code samples

cURL

curl -X PATCH "https://hermetica.15.204.158.166.sslip.io/v1/me" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","avatarUrl":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "email": "string",
  "name": "string",
  "avatarUrl": "string",
  "emailVerified": true
}

Schema

idstringrequired

emailstringrequired

namestringrequired

avatarUrlstring

emailVerifiedboolean

4XX Default Response

Same as 4XX · GET /healthz

5XX Default Response

Same as 4XX · GET /healthz

GEThttps://hermetica.15.204.158.166.sslip.io/v1/me/sessions

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

[
  {
    "id": "string",
    "ip": "string",
    "userAgent": "string",
    "createdAt": "2024-01-01T00:00:00Z",
    "expiresAt": "2024-01-01T00:00:00Z"
  }
]

Schema

idstringrequired

ipstringrequired

userAgentstringrequired

createdAtstringrequired

expiresAtstringrequired

4XX Default Response

Same as 4XX · GET /healthz

5XX Default Response

Same as 4XX · GET /healthz

Next part

Updated Nov 2, 2026

Was this page helpful?