Endpoints

Embed
Preview of the card
<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>
DELETEhttps://hermetica.15.204.158.166.sslip.io/v1/me/sessions/{id}

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermetica.15.204.158.166.sslip.io/v1/me/sessions/{id}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · DELETE /v1/me/sessions/{id}

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

Redeem a single-use agency hand-off token: opens the client workspace in a session bound to it

Request body

application/json
tokenstringrequired
{
  "token": "string"
}

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/auth/handoff" \
  -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"
}
Schema
workspaceIdstringrequired
4XX Default Response

Same as 4XX · DELETE /v1/me/sessions/{id}

5XX Default Response

Same as 4XX · DELETE /v1/me/sessions/{id}

GEThttps://hermetica.15.204.158.166.sslip.io/v1/workspaces/current/schedule-for-removal

When this workspace will be erased, if its removal is scheduled

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/workspaces/current/schedule-for-removal" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "deleteAfter": "string"
}
Schema
deleteAfterstringrequired
4XX Default Response

Same as 4XX · DELETE /v1/me/sessions/{id}

5XX Default Response

Same as 4XX · DELETE /v1/me/sessions/{id}

POSThttps://hermetica.15.204.158.166.sslip.io/v1/workspaces/current/schedule-for-removal

Owner only: stop sending now and erase the workspace after the grace period

Request body

application/json
graceDaysinteger
= 30
{
  "graceDays": 30
}

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/workspaces/current/schedule-for-removal" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"graceDays":30}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

4XX Default Response

Same as 4XX · DELETE /v1/me/sessions/{id}

5XX Default Response

Same as 4XX · DELETE /v1/me/sessions/{id}

DELETEhttps://hermetica.15.204.158.166.sslip.io/v1/workspaces/current/schedule-for-removal

Owner only: cancel a scheduled removal and resume sending

Code samples

cURL
curl -X DELETE "https://hermetica.15.204.158.166.sslip.io/v1/workspaces/current/schedule-for-removal" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · DELETE /v1/me/sessions/{id}

4XX Default Response

Same as 4XX · DELETE /v1/me/sessions/{id}

5XX Default Response

Same as 4XX · DELETE /v1/me/sessions/{id}

GEThttps://hermetica.15.204.158.166.sslip.io/v1/api-keys

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/api-keys" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
[
  {
    "id": "string",
    "name": "string",
    "kind": "secret",
    "prefix": "string",
    "scopes": [
      "string"
    ],
    "allowedOrigins": [
      "string"
    ],
    "allowedDomains": [
      "string"
    ],
    "allowedConnectionIds": [
      "string"
    ],
    "allowedSequenceIds": [
      "string"
    ],
    "rateLimitPerMin": 0,
    "lastUsedAt": "2024-01-01T00:00:00Z",
    "revokedAt": "2024-01-01T00:00:00Z",
    "createdAt": "2024-01-01T00:00:00Z"
  }
]
Schema
idstringrequired
namestringrequired
kindstringrequired
secret | site
prefixstringrequired
scopesstring[]required
allowedOriginsstring[]required
allowedDomainsstring[]
allowedConnectionIdsstring[]
allowedSequenceIdsstring[]
rateLimitPerMininteger
lastUsedAtstringrequired
revokedAtstringrequired
createdAtstringrequired
4XX Default Response

Same as 4XX · DELETE /v1/me/sessions/{id}

5XX Default Response

Same as 4XX · DELETE /v1/me/sessions/{id}

POSThttps://hermetica.15.204.158.166.sslip.io/v1/api-keys

Request body

application/json
namestringrequired
kindstringrequired
secret | site
scopesstring[]
= []
allowedOriginsstring[]
allowedDomainsstring[]
allowedConnectionIdsstring[]
allowedSequenceIdsstring[]
rateLimitPerMininteger
{
  "name": "string",
  "kind": "secret",
  "scopes": [],
  "allowedOrigins": [
    "string"
  ],
  "allowedDomains": [
    "string"
  ],
  "allowedConnectionIds": [
    "string"
  ],
  "allowedSequenceIds": [
    "string"
  ],
  "rateLimitPerMin": 0
}

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/api-keys" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","kind":"secret","scopes":[],"allowedOrigins":["string"],"allowedDomains":["string"],"allowedConnectionIds":["string"],"allowedSequenceIds":["string"],"rateLimitPerMin":0}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "name": "string",
  "kind": "secret",
  "prefix": "string",
  "scopes": [
    "string"
  ],
  "allowedOrigins": [
    "string"
  ],
  "allowedDomains": [
    "string"
  ],
  "allowedConnectionIds": [
    "string"
  ],
  "allowedSequenceIds": [
    "string"
  ],
  "rateLimitPerMin": 0,
  "lastUsedAt": "2024-01-01T00:00:00Z",
  "revokedAt": "2024-01-01T00:00:00Z",
  "createdAt": "2024-01-01T00:00:00Z",
  "plaintext": "string"
}
Schema
idstringrequired
namestringrequired
kindstringrequired
secret | site
prefixstringrequired
scopesstring[]required
allowedOriginsstring[]required
allowedDomainsstring[]
allowedConnectionIdsstring[]
allowedSequenceIdsstring[]
rateLimitPerMininteger
lastUsedAtstringrequired
revokedAtstringrequired
createdAtstringrequired
plaintextstringrequired
4XX Default Response

Same as 4XX · DELETE /v1/me/sessions/{id}

5XX Default Response

Same as 4XX · DELETE /v1/me/sessions/{id}

DELETEhttps://hermetica.15.204.158.166.sslip.io/v1/api-keys/{id}

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermetica.15.204.158.166.sslip.io/v1/api-keys/{id}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · DELETE /v1/me/sessions/{id}

4XX Default Response

Same as 4XX · DELETE /v1/me/sessions/{id}

5XX Default Response

Same as 4XX · DELETE /v1/me/sessions/{id}

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

Members of this workspace; ?email= or ?username= (display name or the part of the email before @) narrows to exact matches

Parameters

emailstringquery
usernamestringquery

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/members" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
[
  {
    "userId": "string",
    "email": "string",
    "name": "string",
    "role": "owner",
    "listIds": [
      "string"
    ]
  }
]
Schema
userIdstringrequired
emailstringrequired
namestringrequired
rolestringrequired
owner | admin | marketer | sales | analyst | viewer
listIdsstring[]
4XX Default Response

Same as 4XX · DELETE /v1/me/sessions/{id}

5XX Default Response

Same as 4XX · DELETE /v1/me/sessions/{id}

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

Request body

application/json
emailstringrequired
rolestringrequired
owner | admin | marketer | sales | analyst | viewer
{
  "email": "string",
  "role": "owner"
}

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/members" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"string","role":"owner"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "email": "string",
  "role": "owner",
  "token": "string",
  "expiresAt": "2024-01-01T00:00:00Z",
  "emailed": true
}
Schema
idstringrequired
emailstringrequired
rolestringrequired
owner | admin | marketer | sales | analyst | viewer
tokenstringrequired
expiresAtstringrequired
emailedboolean
4XX Default Response

Same as 4XX · DELETE /v1/me/sessions/{id}

5XX Default Response

Same as 4XX · DELETE /v1/me/sessions/{id}

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

Parameters

userIdstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermetica.15.204.158.166.sslip.io/v1/members/{userId}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · DELETE /v1/me/sessions/{id}

4XX Default Response

Same as 4XX · DELETE /v1/me/sessions/{id}

5XX Default Response

Same as 4XX · DELETE /v1/me/sessions/{id}

Updated