# API Key Management Help ## Overview API Key Management allows you to create and manage API keys for external developers. Using API keys, external applications can access the UnlockOS API. ## Key Features - Create API keys - View API key list - Enable/disable API keys - Delete API keys --- ## API Key List ### Display Fields | Field | Description | |-------|-------------| | Name | API key identifier name | | Key | Key prefix (masked display) | | Scopes | Permissions granted to the API key | | Status | Active/Inactive | | Last Used | Date and time of last use | | Actions | Edit and delete buttons | ### Status | Status | Description | |--------|-------------| | Active | API key is usable | | Inactive | API key is temporarily disabled | --- ## Creating API Keys ### Input Fields | Field | Description | Required | |-------|-------------|----------| | Name | API key identifier name | Yes | | Description | Description of API key purpose | No | | Test Mode | Whether this is a test environment key | No | | Scopes | Permissions to grant to the API key | Yes | ### Scopes (Permission Ranges) Scopes are grouped by category. Select only the permissions you need. Examples: - Check-in related (read, create, update) - Plan related (read, create, update) - Facility related (read) --- ## Buttons | Button | Description | |--------|-------------| | Create New | Creates a new API key | | Copy | Copies API key to clipboard | | Enable/Disable | Toggles API key status | | Delete | Deletes the API key | --- ## Security Notes ### Handling API Keys - **API keys are only displayed at creation time**. They cannot be displayed again after creation, so be sure to copy them immediately. - Treat API keys as confidential information and do not commit them to public repositories. - Delete API keys promptly when they are no longer needed. ### Test Mode - Test mode API keys should only be used in test environments. - They do not affect production data. --- ## FAQ ### Q: What should I do if I lose an API key? A: Create a new API key and delete the old one. ### Q: Are there usage limits on API keys? A: Yes, there are rate limits. The limits are displayed when the key is created. ### Q: Can I create multiple API keys? A: Yes, it is recommended to create separate API keys for different purposes. ### Q: Can I change the scopes of an API key later? A: No, you need to create a new API key to change scopes. --- ## Related Pages - Unlock Lab - Audit Log