Skip to content
noBSredir

Custom domains

Custom domains let you use your own domain (e.g. go.yourco.com) instead of the default fnl.sh. Verification is via DNS TXT record.

POST /workspaces/:wsId/domains

Add a custom domain. Returns a TXT record you need to add to your DNS.

Role: admin+

Terminal window
curl -X POST https://nobsredir.com/api/workspaces/ws_abc123/domains \
  -H "X-API-Key: nobs_your_key" \
  -H "Content-Type: application/json" \
  -d '{"domain": "go.yourco.com"}'

Body:

FieldTypeRequiredDescription
domainstringyesThe domain to add. Lowercase, valid hostname format.

Response 201:

{
  "id": "dom_abc123",
  "domain": "go.yourco.com",
  "verified": false,
  "txt_record": "nobsredir-verify=a1b2c3d4e5f6g7h8"
}

Add a TXT record to your DNS with the value from txt_record, then call the verify endpoint.

Errors:

  • 400 - Invalid domain format
  • 402 - Domain limit reached for your plan
  • 409 - Domain already registered (globally unique)

GET /workspaces/:wsId/domains

List all domains for the workspace.

Role: viewer+

Terminal window
curl https://nobsredir.com/api/workspaces/ws_abc123/domains \
  -H "X-API-Key: nobs_your_key"

Response 200:

{
  "domains": [
    {
      "id": "dom_abc123",
      "workspace_id": "ws_abc123",
      "domain": "go.yourco.com",
      "verified": 1,
      "txt_record": "nobsredir-verify=a1b2c3d4e5f6g7h8",
      "created_at": "2025-01-15T10:00:00.000Z"
    }
  ]
}

verified is 1 (true) or 0 (false).

POST /workspaces/:wsId/domains/:id/verify

Trigger DNS verification. Checks for the expected TXT record.

Role: admin+

Terminal window
curl -X POST https://nobsredir.com/api/workspaces/ws_abc123/domains/dom_abc123/verify \
  -H "X-API-Key: nobs_your_key"

Response 200 (verified):

{"verified": true}

Response 200 (not yet verified):

{
  "verified": false,
  "expected_txt": "nobsredir-verify=a1b2c3d4e5f6g7h8"
}

Errors:

  • 404 - Domain not found
  • 502 - DNS lookup failed

DNS propagation can take up to 48 hours. If verification fails, double-check the TXT record value and try again.

DELETE /workspaces/:wsId/domains/:id

Remove a custom domain. Links using this domain will stop working.

Role: admin+

Terminal window
curl -X DELETE https://nobsredir.com/api/workspaces/ws_abc123/domains/dom_abc123 \
  -H "X-API-Key: nobs_your_key"

Response 200:

{"ok": true}

Errors: 404 - Domain not found.