Actions52
- ApiKeys Actions
- Auth Actions
- Identities Actions
- Members Actions
- Messages Actions
- Platform Logs Actions
- Platforms Actions
- Projects Actions
- Webhooks Actions
Overview
This node provides an interface to manage API keys within a project on the MsgCore platform. Specifically, the "Roll" operation allows users to roll an existing API key, which means generating a new key and scheduling the revocation of the old key after 24 hours. This is useful for maintaining security by regularly rotating API keys without immediate disruption.
Common scenarios include:
- Automatically rotating API keys to comply with security policies.
- Minimizing downtime by allowing a grace period before the old key is revoked.
- Managing API keys programmatically as part of CI/CD pipelines or automated workflows.
Example use case:
- A developer wants to rotate an API key used in production every month. They can configure this node to roll the key, ensuring a new key is generated and the old one remains valid for 24 hours to allow smooth transition.
Properties
| Name | Meaning |
|---|---|
| keyId | The identifier of the API key to roll (i.e., generate a new key and revoke the old one). |
| project | The project identifier where the API key exists and will be rolled. |
Output
The output JSON contains the response from the MsgCore API after rolling the API key. This typically includes details about the newly generated API key and possibly metadata about the old key's scheduled revocation.
The node does not output binary data.
Dependencies
- Requires an active connection to the MsgCore API service.
- Requires an API authentication token credential configured in n8n to authorize requests.
- The node uses the base URL and credentials provided by the user to make HTTP POST requests to the MsgCore API endpoint for rolling API keys.
Troubleshooting
- Invalid keyId or project: If the specified API key ID or project does not exist, the API will return an error. Verify that the
keyIdandprojectvalues are correct. - Authentication errors: Ensure that the API authentication token credential is correctly set up and has sufficient permissions to roll API keys.
- Network issues: Connectivity problems to the MsgCore API endpoint may cause request failures. Check network access and API availability.
- API rate limits: Excessive rolling requests might trigger rate limiting; handle such errors by implementing retries with backoff.
Links and References
- MsgCore API Documentation (general reference for API key management)
- Best Practices for API Key Rotation