API Key
This file outlines the Flashback API's repository API key management functionality, including creating, listing, updating, and deleting scoped API keys for individual repositories. Each key can be assigned specific access levels—READ, WRITE, or ADMIN—to control repository usage securely.
TypeScript Client Quick Links
import { FlashbackClient } from '@flashback/client';
const client = new FlashbackClient({ accessToken: 'your-access-token' });
// List API keys for a repo
await client.apiKeys.list('repo-id');
// Create API key
await client.apiKeys.create('repo-id', { name: 'CI Bot', access: 'READ' });
// Update API key
await client.apiKeys.update('repo-id', 'apikey-id', { name: 'CI Bot v2', access: 'WRITE' });
// Delete API key
await client.apiKeys.delete('repo-id', 'apikey-id');
API Keys API Calls
Method
API Reference
Description
DELETE
/repo/{repoId}/apikey/{apikeyId}
Revoke and delete a specific API key.
GET
/repo/{repoId}/apikey
Retrieve all API keys associated with the specified repository.
POST
/repo/{repoId}/apikey
Create a new API key for the specified repository.
PUT
/repo/{repoId}/apikey/{apikeyId}
Update the name or access level of an existing API key.
Last updated
Was this helpful?