FruxonDocs
ApiDomains

Claims a domain and returns the TXT record that will verify it.

The claim starts `PENDING`. Publish `verificationRecord` at the domain itself, then call `:verify`. A domain other workspaces have claimed or verified can still be claimed; each claim has its own record. Personal and disposable email providers and Fruxon's own domains can never be claimed, and a subdomain is its own claim.

POST
/v1/tenants/{tenant}/domains

Authorization

Bearer
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

tenant*string

The tenant identifier

Request Body

The domain to claim.

domain?string

The domain, e.g. acme.com. Case and a trailing dot are ignored, and an internationalised name is stored in its punycode form. A subdomain such as eng.acme.com is its own claim.

[key: string]?never

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/domains" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "00000000-0000-0000-0000-000000000000",
  "domain": "string",
  "status": "PENDING",
  "verificationRecord": {
    "type": "string",
    "name": "string",
    "value": "string"
  },
  "createdAt": 0,
  "statusChangedAt": 0,
  "verifiedAt": 0,
  "lastCheckedAt": 0,
  "lastFoundAt": 0,
  "missingSince": 0,
  "nextStatus": "PENDING",
  "nextStatusAt": 0
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}