Endpoints
DELETE
https://hermetica.15.204.158.166.sslip.io /v1/me/sessions/{id} Parameters
idstringpathrequiredCode 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
okbooleanrequired4XX Default Response
Example
{
"error": {
"code": "string",
"message": "string",
"details": {}
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsobjectPOST
https://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
workspaceIdstringrequiredGET
https://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
deleteAfterstringrequiredPOST
https://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{
"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
DELETE
https://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
GET
https://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
idstringrequirednamestringrequiredkindstringrequiredprefixstringrequiredscopesstring[]requiredallowedOriginsstring[]requiredallowedDomainsstring[]allowedConnectionIdsstring[]allowedSequenceIdsstring[]rateLimitPerMinintegerlastUsedAtstringrequiredrevokedAtstringrequiredcreatedAtstringrequiredPOST
https://hermetica.15.204.158.166.sslip.io /v1/api-keys Request body
application/json
namestringrequiredkindstringrequiredscopesstring[]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
idstringrequirednamestringrequiredkindstringrequiredprefixstringrequiredscopesstring[]requiredallowedOriginsstring[]requiredallowedDomainsstring[]allowedConnectionIdsstring[]allowedSequenceIdsstring[]rateLimitPerMinintegerlastUsedAtstringrequiredrevokedAtstringrequiredcreatedAtstringrequiredplaintextstringrequiredDELETE
https://hermetica.15.204.158.166.sslip.io /v1/api-keys/{id} Parameters
idstringpathrequiredCode 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
GET
https://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
emailstringqueryusernamestringqueryCode 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
userIdstringrequiredemailstringrequirednamestringrequiredrolestringrequiredlistIdsstring[]POST
https://hermetica.15.204.158.166.sslip.io /v1/members Request body
application/json
emailstringrequiredrolestringrequired{
"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
idstringrequiredemailstringrequiredrolestringrequiredtokenstringrequiredexpiresAtstringrequiredemailedbooleanDELETE
https://hermetica.15.204.158.166.sslip.io /v1/members/{userId} Parameters
userIdstringpathrequiredCode 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
Updated