Obtaining Your API Key

Your API key is generated from the LinkShark Dashboard. Follow these steps to create and securely store your key.

Prerequisites

• You must have an active LinkShark account with the Owner role.
• You must be logged in to the LinkShark Dashboard .

Step-by-Step Guide

Step 1 — Navigate to the API Key Page

From the dashboard sidebar, locate the “General” section and click “Api Key” (identified by the key icon).

Step 2 — Generate a New Key

On the API Key page, you will see:

• A “Generate Key” button on the left panel.
• A “How to use your API key” instructions card on the right.

Click the “Generate Key” button.

Step 3 — Confirm Key Generation

A confirmation dialog will appear:

“Are you sure you want to create a new API key?”

Click “Yes” to proceed.

⚠️ Warning: When a new key is generated, the old one will cease to function immediately. Make sure you replace all old keys in your services before generating a new one.

Step 4 — Copy & Store Your API Key

After successful generation, your new API key will appear in a read-only text field labeled “Generated key (visible once)”.

1. Click the copy button (clipboard icon) next to the key to copy it.
2. The button will briefly change to a checkmark with “Copied” to confirm.
3. Store the key securely — in a password manager or environment variable.

🔒 The key is visible only until you refresh or leave the page. There is no way to retrieve it again. If you lose it, you must generate a new one.

API Key Best Practices

1. Store the key securely — treat it like a password.
2. Include the key in every request using the X-API-KEY header.
3. Rotate keys periodically by generating a new one and updating your services immediately.
4. Never commit keys to source control or share them publicly.
5. If you suspect a leak, generate a new key right away — the old one is instantly revoked.