Skip to main content
API docs by Redocly

Lynkr API (1.0.0)

Download OpenAPI specification:Download

Account

Account informations

Retrieve authenticated account informations

Responses

Response samples

Content type
{
  • "id": "string",
  • "email": "string",
  • "apiKey": "string",
  • "totalDomainCount": 0,
  • "totalLinkCount": 0,
  • "monthlyLinkCount": 0,
  • "totalDomainLimit": 0,
  • "totalLinkLimit": 0,
  • "monthlyLinkLimit": 0
}

Generate a subscribe link

Use the generated link to subscribe a plan.

Responses

Response samples

Content type
application/ld+json
{}

Domain

List domains

Return collection of domains, paginated by cursor (50 domains by call).

query Parameters
cursor[id]
string
Example: cursor[id]=018b9a8d-055d-7072-b7b1-b1f5021ee896

Last retrieved domain id

Responses

Response samples

Content type
[
  • {
    }
]

Create a domain

Create a new custom domain. Return DNS nameservers configuration to configure.

Request Body schema: application/ld+json
required

New domain informations

name
string

Domain name

Responses

Request samples

Content type
application/ld+json
{}

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "active": true,
  • "dnsConfigurationState": "pending_validation",
  • "nameservers": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z"
}

Domain informations

Return domain informations

path Parameters
id
required
string

DomainResource identifier

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "active": true,
  • "dnsConfigurationState": "pending_validation",
  • "nameservers": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z"
}

Delete a domain

Delete the domain.

path Parameters
id
required
string

DomainResource identifier

Responses

Validate DNS configuration

Validate DNS configuration in order to finalize domain configuration on Lynkr.

path Parameters
id
required
string

DomainResource identifier

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": "string",
  • "name": "string",
  • "active": true,
  • "dnsConfigurationState": "pending_validation",
  • "nameservers": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z"
}

Shorten link

Shorten a link. Could specify a custom path or/and a custom domain.

Request Body schema:
required

The new Link resource

url
required
domainName
string or null
path
string or null

Responses

Request samples

Content type
{}

Response samples

Content type
{
  • "id": "string",
  • "path": "string",
  • "domainName": "string",
  • "shortUrl": "string",
  • "url": "string",
  • "createdAt": "2019-08-24T14:15:22Z"
}