Short links

Create a short link

Creates a dynamic short link with its own QR code (SVG returned inline). Returns 200.

post/link/create/

Request

  • Base URL: https://hovercode.com/api/v2
  • URL: https://hovercode.com/api/v2/link/create/
  • Auth: API key in header Authorization

Request body

workspacestring uuid required
linkstring required

Destination URL.

link_type'Link'
slugstring

Unique per domain; not a reserved word. Auto-generated if omitted.

domainstring
display_namestring
gpsboolean

Response

OK

idstring uuid required
linkstring required

Destination URL.

link_type'Link'
display_namestring nullable
short_urlstring uri nullable required
slugstring nullable
domainstring nullable
total_clicksinteger
unique_clicksinteger
pngstring uri nullable
createdstring date-time required
gpsboolean
svgstring

The short link's QR code as inline SVG.

Changes

No recorded changes to this operation across all 1 revision of this API.