workspace

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-workspace"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/a0ad69ab-5e0e-47f8-9717-de2a13b4ca3d/social-card.svg?v=3e7ae33eec8b" alt="workspace" width="600" height="315"></a>
PUThttps://hermeticor.com/v1/workspace/dashboard-domain

Set the hostname the dashboard is served on; point its CNAME at cnameTarget, then verify

Request body

application/json
hoststringrequired
{
  "host": "string"
}

Code samples

cURL
curl -X PUT "https://hermeticor.com/v1/workspace/dashboard-domain" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"host":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "host": "string",
  "status": "pending",
  "cnameTarget": "string",
  "verifiedAt": "2024-01-01T00:00:00Z",
  "lastCheckedAt": "2024-01-01T00:00:00Z",
  "lastError": "string"
}
Schema
hoststringrequired
statusstringrequired
pending | verified | failed
cnameTargetstringrequired
verifiedAtstringrequired
lastCheckedAtstringrequired
lastErrorstringrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · PUT /v1/workspace/dashboard-domain

DELETEhttps://hermeticor.com/v1/workspace/dashboard-domain

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/workspace/dashboard-domain" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response

Same as 4XX · PUT /v1/workspace/dashboard-domain

5XX Default Response

Same as 4XX · PUT /v1/workspace/dashboard-domain

POSThttps://hermeticor.com/v1/workspace/dashboard-domain/verify

Check the CNAME now

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/workspace/dashboard-domain/verify" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · PUT /v1/workspace/dashboard-domain

4XX Default Response

Same as 4XX · PUT /v1/workspace/dashboard-domain

5XX Default Response

Same as 4XX · PUT /v1/workspace/dashboard-domain

GEThttps://hermeticor.com/v1/public/brand

Name, logo and colours for a verified dashboard host (null otherwise)

Parameters

hoststringqueryrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/public/brand?host=<host>"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "workspaceId": "string",
  "productName": "string",
  "logoUrl": "string",
  "primaryColor": "string",
  "accentColor": "string",
  "loginMessage": "string"
}
Schema
workspaceIdstringrequired
productNamestringrequired
logoUrlstringrequired
primaryColorstringrequired
accentColorstringrequired
loginMessagestring
4XX Default Response

Same as 4XX · PUT /v1/workspace/dashboard-domain

5XX Default Response

Same as 4XX · PUT /v1/workspace/dashboard-domain

Updated