Keygate icon

Keygate

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

Release → Yank

AI-generated

Summary

Deactivate a published release for a specified product in a given channel by yanking it via the Keygate API.

Inputs

  • Product Name or ID (required) — Select the product to which the release belongs, either by choosing from a list of products or providing the product ID via expression.
  • ID (required) — Specify the unique identifier of the release to be yanked.
  • Name — Optionally provide the release name.
  • Channel — Choose the release channel (alpha, beta, dev, stable); default is 'stable'.
  • Platform — Select the platform associated with the release; defaults to 'darwin-arm64'.
  • Version — Specify the version string of the release.
  • JSON Input — Provide additional JSON fields merged into the request body for the yank operation.
  • Response Mode — Select 'simplified' to receive a compact output better suited for AI tools or 'raw' to return the full raw response from the API.

Output shape

a single record

Returns the response object from the API indicating the result of the yank operation. The output may be simplified to include only key fields or raw depending on the 'Response Mode' selected.

Examples

Example 1: Yank a Stable Release by ID

Product ID provided, Release ID specified, defaults used for channel and platform, simplified response mode.

Links

Discussion