mirror of
https://github.com/hanzoai/kms.git
synced 2026-10-17 11:18:16 +00:00
zeekay
0ebffbd529
- Fix 381 files where branding script corrupted variable names (e.g. isHanzo KMSTemplate -> isKmsTemplate) - Rebrand from "Hanzo KMS" to just "KMS" for white-label support (allows Lux KMS, Hanzo KMS, etc. via configuration) - 856 files, purely string replacements, no logic changes
50 lines
1.8 KiB
Plaintext
50 lines
1.8 KiB
Plaintext
---
|
|
title: "API Reference"
|
|
sidebarTitle: "Introduction"
|
|
---
|
|
|
|
KMS's Public (REST) API provides users an alternative way to programmatically access and manage
|
|
secrets via HTTPS requests. This can be useful for automating tasks, such as
|
|
rotating credentials, or for integrating secret management into a larger system.
|
|
|
|
With the Public API, you can create, read, update, and delete secrets, as well as manage access control, query audit logs, and more.
|
|
|
|
## API Versioning
|
|
|
|
The API is versioned on a per-resource basis. A resource's version is only incremented for breaking changes, so different endpoints may have different version numbers (e.g., `/api/v4/secrets` vs. `/api/v1/secret-syncs`).
|
|
|
|
As a best practice, always use the latest available version for each endpoint to ensure access to the most recent features and improvements.
|
|
|
|
## Rate Limits
|
|
|
|
KMS enforces several different types of rate limits:
|
|
|
|
- **Read**: For GET and LIST operations.
|
|
- **Write**: For CREATE, UPDATE, and DELETE operations.
|
|
- **Secret**: Specifically for secret management operations such as getting and creating secrets.
|
|
- **Identity Creation**: For creating new identities within an organization.
|
|
- **Project Creation**: For creating new projects within an organization.
|
|
|
|
**Self-hosted** instances have no limits, these limits apply only to **KMS Cloud**.
|
|
|
|
<Tabs>
|
|
<Tab title="Free Plan">
|
|
- **Read**: 200/minute
|
|
- **Write**: 90/minute
|
|
- **Secret**: 120/minute
|
|
- **Identity Creation**: 30/minute
|
|
- **Project Creation**: 30/minute
|
|
</Tab>
|
|
<Tab title="Pro Plan">
|
|
- **Read**: 350/minute
|
|
- **Write**: 200/minute
|
|
- **Secret**: 300/minute
|
|
- **Identity Creation**: 30/minute
|
|
- **Project Creation**: 30/minute
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
<Note>
|
|
Custom rate limits are available for Enterprise customers. If you need higher rate limits, please contact [email protected].
|
|
</Note>
|