Skip to content

Document key last-used tracking feature #5445

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document key last-used tracking feature #5445

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion docs/product/apis/introduction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,31 @@ When you verify a key, Unkey returns:
| `identity` | `object?` | Identity info if `externalId` was set when creating the key |
| `ratelimits` | `object[]?` | Rate limit states (if rate limiting configured) |

<Note>
The `lastUsedAt` field described below is not returned by `keys.verifyKey`. It is available on `keys.getKey`, `keys.whoami`, and `apis.listKeys`.
</Note>

## Key last-used tracking

The `keys.getKey`, `keys.whoami`, and `apis.listKeys` endpoints return a `lastUsedAt` field: a Unix timestamp in milliseconds indicating when the key was last used for verification. If the key has never been used, the field is omitted from the response.

This value is approximate, accurate to within five minutes. Use it to identify stale keys and clean up unused credentials.

```ts TypeScript
import { Unkey } from "@unkey/api";

const unkey = new Unkey({ rootKey: process.env.UNKEY_ROOT_KEY! });

const { data } = await unkey.keys.getKey({ keyId: "key_123" });

if (data.lastUsedAt) {
const daysSinceUse = (Date.now() - data.lastUsedAt) / (1000 * 60 * 60 * 24);
console.log(`Key last used ${Math.floor(daysSinceUse)} days ago`);
} else {
console.log("Key has never been used");
}
```

## Features

Unkey keys support much more than basic authentication:
Expand All @@ -170,7 +195,7 @@ Unkey keys support much more than basic authentication:
<Card title="Permissions" icon="user-shield" href="/apis/features/authorization/introduction">
Attach roles and permissions for fine-grained access control.
</Card>
<Card title="Analytics" icon="chart-line" href="/apis/features/analytics">
<Card title="Analytics" icon="chart-line" href="/analytics/overview">
See usage patterns, top consumers, and verification trends.
</Card>
</CardGroup>
Expand Down
1 change: 0 additions & 1 deletion docs/product/docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,6 @@
"apis/features/remaining",
"apis/features/refill",
"apis/features/temp-keys",
"apis/features/analytics",
{
"group": "Authorization",
"pages": [
Expand Down
Loading