Domains

Add a custom domain

Add a new custom domain to your workspace. You must configure a CNAME DNS record pointing to domains.linklyhq.com before adding the domain.

post/api/v1/domains

Request

Base URL
https://api.linklyhq.com
Auth
API key in query parameter api_key
TypeScript
https://skmtc.dev/linklyhq/apis/linkly-url-shortener-api/docs/api/v1/domains/post.ts
A function with typed inputs. Its response is checked against the schema.

namestring

name

workspace_idinteger required

Workspace ID

{
  "name": "link.mydomain.com",
  "workspace_id": 33
}

Domain

namestring nullable

workspace_idinteger nullable

{
  "name": null,
  "workspace_id": 42
}

No recorded changes to this operation across all 7 revisions of this API.