API Keys Endpoints
Manage API keys for programmatic access to the VotePipe API. API keys allow you to authenticate and interact with the API programmatically, enabling automation, integrations, and custom tools. Use these endpoints to create, list, and revoke API keys with different scopes based on your needs.
Available Endpoints
Key Scopes
API keys support two scopes that control what operations can be performed. The scope is set when creating the key and cannot be changed afterward. If you need different permissions, create a new key with the appropriate scope.
| Scope | Description | Allowed Methods |
|---|---|---|
| read | Read-only access to retrieve data | GET only |
| full | Full access for all operations | GET, POST, PATCH, DELETE |
Best Practice: Use read-only keys for monitoring, analytics, and reporting tools. Reserve full-scope keys for administrative operations and automation scripts that need to modify resources. This follows the principle of least privilege and improves security.