📘
Lynx
GitHub
  • Welcome
  • Installation
    • Installation
      • Native
      • Docker
    • Post Installation
    • Environment Variables
  • Guides
    • Backups
  • API
    • Using the API
    • API Reference
      • Accounts
      • Users
      • Links
      • Import
      • Export
      • About
      • ShareX
  • Roadmap
Powered by GitBook
On this page
  • Get your API keys
  • Make your first request
  • Get Account
  • Explore the full API documentation

Was this helpful?

Edit on GitHub
  1. API

Using the API

Get your API keys

Your API requests are authenticated using API keys. Most endpoints support API keys, but some do not, such as account management endpoints, for security purposes.

You can generate an API key from your Settings page at any time. These do not expire unless replaced with a new one.

Make your first request

To make your first request, send an authenticated request to the /api/auth/me endpoint. This will return information about your currently logged in account.

Get Account

GET https://demo.getlynx.dev/api/auth/me

Headers

Name
Type
Description

Authorization

String

Your API key

Cookies

Name
Type
Description

token

String

Your JWT Session

{
    "success": true,
    "result":{
        "id":"be8881ce-af01-433b-a675-fe02e8a48a88",
        "username":"demo",
        "email":"demo@example.com",
        "role":"standard",
        "secret":"uihJEIwC0jjGIF0BhZnY7xI90jN664La",
        "totp": false,
    }
}

Explore the full API documentation

Last updated 1 year ago

Was this helpful?

API Reference