Update a registry component version

Deprecates (status: deprecated), restores (ready) or yanks (yanked) a version, with an optional statusMessage for installers.

Deprecated and yanked versions cannot be newly installed, inserted or published; paywalls already published with them keep working. Only people who may publish paywalls in the owner project, and organization admins, can.

Guide: Publishing

Errors

Status	`type`	`code`	When
404	`not_found`	`registry_component_version_not_found`	—
409	`conflict`	`version_yanked`	When restoring or deprecating a yanked version: a yank is final.

It can also fail with the errors every operation shares, such as unauthenticated; see Errors.

Request body

application/json

TypeScript definitions

Use the request body type in TypeScript.

status*PublishedComponentVersionStatus

The status of a registry component version: ready versions can be installed; deprecated and yanked ones cannot. A deprecation can be lifted; a yank is final.

Value in

"ready"
"deprecated"
"yanked"

statusMessage?|

Why the version is deprecated or yanked, for installers; restoring a version to ready clears it.

Examples

curl -X PATCH "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/registry-components/cmp_pkg_h2j7k4l9z1x6c3v8b5n0m4q7/versions/cmp_pkg_ver_w8e3r6t1y4u9i2o7p5a0s3d6" \  -H "Authorization: Bearer vh_sk_..." \  -H "Content-Type: application/json" \  -d '{    "status": "deprecated",    "statusMessage": "Update to 1.3.0, which reports the plan people pick."  }'

{  "id": "cmp_pkg_ver_w8e3r6t1y4u9i2o7p5a0s3d6",  "registryComponentId": "cmp_pkg_h2j7k4l9z1x6c3v8b5n0m4q7",  "version": "1.2.0",  "number": 4,  "status": "deprecated",  "statusMessage": "Update to 1.3.0, which reports the plan people pick.",  "bundleHash": "0b6d3f8a2c7e1d9b5a4f6e0c8d2b7a3f1e9c5d0a6b4f8e2d7c1a3b9f5e0d6c4a",  "contentHash": "c2e7a9f4b1d6083e5f7a2c9b4d1e8f0a3c6b9d2e5f8a1b4c7d0e3f6a9b2c5d8e",  "byteSize": 60488,  "capabilities": [    "commerce"  ],  "definition": {    "id": "acme/plan-picker",    "version": "1.2.0",    "title": "Plan picker",    "description": "Selectable plans.",    "icon": {      "kind": "builtin",      "name": "component"    },    "category": "",    "keywords": [      "plans",      "pricing"    ],    "implementation": {      "kind": "wasm",      "abi": 2    },    "traits": {      "frame": {        "resize": "width"      },      "appearance": {},      "effects": {}    },    "children": {      "kind": "none"    },    "props": [      {        "name": "plans",        "type": {          "kind": "list",          "of": {            "kind": "product"          }        },        "default": []      },      {        "name": "accent",        "type": {          "kind": "color"        },        "default": "#7c3aed"      }    ],    "events": [      {        "name": "selected",        "payload": [          {            "name": "productId",            "type": {              "kind": "string"            }          }        ]      }    ],    "previewStates": [      "default"    ],    "capabilities": [      "commerce"    ],    "panel": false,    "fallback": "placeholder",    "defaultSize": {      "width": "fill",      "height": "hug"    }  },  "manifest": {    "id": "acme/plan-picker",    "version": "1.2.0",    "title": "Plan picker",    "description": "Selectable plans.",    "icon": {      "kind": "builtin",      "name": "component"    },    "category": "",    "keywords": [      "plans",      "pricing"    ],    "implementation": {      "kind": "wasm",      "abi": 2    },    "traits": {      "frame": {        "resize": "width"      },      "appearance": {},      "effects": {}    },    "children": {      "kind": "none"    },    "props": [      {        "name": "plans",        "type": {          "kind": "list",          "of": {            "kind": "product"          }        },        "default": []      },      {        "name": "accent",        "type": {          "kind": "color"        },        "default": "#7c3aed"      }    ],    "events": [      {        "name": "selected",        "payload": [          {            "name": "productId",            "type": {              "kind": "string"            }          }        ]      }    ],    "previewStates": [      "default"    ],    "capabilities": [      "commerce"    ],    "panel": false,    "fallback": "placeholder",    "defaultSize": {      "width": "fill",      "height": "hug"    }  },  "hasPanel": false,  "hasIcon": true,  "hasReadme": true,  "hasAgentGuide": false,  "thumbnailStates": [    "default"  ],  "warnings": [],  "conformance": {    "hasPassed": true,    "checks": [      {        "name": "module",        "status": "pass",        "errors": [],        "warnings": []      },      {        "name": "manifest",        "status": "pass",        "errors": [],        "warnings": []      },      {        "name": "imports",        "status": "pass",        "errors": [],        "warnings": []      },      {        "name": "exports",        "status": "pass",        "errors": [],        "warnings": []      },      {        "name": "lifecycle",        "status": "pass",        "errors": [],        "warnings": []      },      {        "name": "values",        "status": "pass",        "errors": [],        "warnings": []      },      {        "name": "tree",        "status": "pass",        "errors": [],        "warnings": []      },      {        "name": "determinism",        "status": "pass",        "errors": [],        "warnings": []      },      {        "name": "events",        "status": "pass",        "errors": [],        "warnings": []      },      {        "name": "timers",        "status": "pass",        "errors": [],        "warnings": []      },      {        "name": "layout",        "status": "pass",        "errors": [],        "warnings": []      },      {        "name": "actions",        "status": "pass",        "errors": [],        "warnings": []      },      {        "name": "frames",        "status": "pass",        "errors": [],        "warnings": []      },      {        "name": "memory",        "status": "pass",        "errors": [],        "warnings": []      },      {        "name": "golden",        "status": "skip",        "errors": [],        "warnings": []      }    ]  },  "installCount": 1,  "publishedPaywallCount": 2,  "createdBy": "user_k3m8q1z6v9c2x5b7n4w0e8r1",  "publishedAt": "2026-03-11T15:40:00.000Z"}

{  "error": {    "type": "invalid_request",    "code": "invalid_body",    "message": "The request body is invalid: Missing key\n  at [\"status\"]"  }}

{  "error": {    "type": "unauthenticated",    "code": "invalid_api_key",    "message": "This secret key is not valid."  }}

{  "error": {    "type": "permission_denied",    "code": "permission_denied",    "message": "Insufficient permissions."  }}

{  "error": {    "type": "not_found",    "code": "registry_component_version_not_found",    "message": "This registry component has no version cmp_pkg_ver_e5r8t2y6u0i3o7p1a4s9d2f6.",    "param": "versionId"  }}

{  "error": {    "type": "conflict",    "code": "version_yanked",    "message": "The version cannot be restored. acme/plan-picker 1.2.0 was yanked; a yank is final.",    "param": "status"  }}

{  "error": {    "type": "internal",    "code": "internal_error",    "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing."  }}

Update a registry component version

Errors

More in Component registry

Update a registry component version

Errors

More in Component registry

Authorization

Path parameters

Request body

Examples

Response body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Update a registry component version

Update a registry component version

registry_component_version_not_found

project_not_found

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`