Keygate icon

Keygate

Work with Keygate admin, portal, public license, and release APIs

API Key → Rotate

AI-generated

Summary

Rotate an existing API Key identified by its ID to generate a new key for the specified product.

Inputs

  • Product Name or ID — Optionally specify the product to which the API Key belongs by selecting from a list or providing an expression.
  • ID (required) — The unique identifier of the API Key to rotate.
  • Name — Provide a name for the API Key (not typically used for rotation).
  • JSON Input — Additional request body fields merged into the request, allowing custom parameters beyond the guided inputs.
  • Response Mode — Choose whether the operation returns a simplified (compact) output or the full raw response from the API.

Output shape

a single record representing the rotated API Key details

By default, returns a simplified output including key properties like ID and name; choosing 'Raw' returns the full API response. Errors in rotation will cause node failure unless 'Continue on Fail' is enabled.

Examples

Example 1: Rotate an API Key by its ID for a specific product assigning default fields

Set 'Resource' to 'API Key', 'Operation' to 'Rotate', specify the 'ID' of the API Key, select or specify the 'Product Name or ID', optionally add extra JSON fields in 'JSON Input', and choose a response mode.

Links

Discussion