VoidhashDocs
DevelopersHelp centerGuidesAPI reference
Dashboard
Essentials
API overview
Authentication
Event capture
Push device API
Webhooks
Webhook delivery
Webhook events
Projects & keys
Projects
API keys
Audit log
Customers & access
Persons
Products
Perks
Sandbox
Paywalls
Paywalls
Paywall locations
Components
Component registry
Assets
Experiments & flags
Experiments
Feature flags
Analytics & events
Analytics
Analytics alerts
Events
Ingest policy
VoidQL
Tracking domains
Ads
Ads
Ad accounts
Meta measurement
Payments & stores
Payment providers
Payment provider products
Purchase history imports
Payment sources
Webhooks & notifications
Webhooks
Push notifications
Push configurations
Automations
Organization & team
Organizations
Members
Invitations
Billing
Your account
Profile
Session
Notices
Connected apps
Terms of Service
Developer tools
Schema
SDK
Retrieve the registry publisher
Claim a registry namespace
List registry components
Publish a component bundle
Publish a project component
Retrieve a registry component
Update a registry component
List a registry component's versions
Retrieve a registry component version
Update a registry component version
Retrieve a version's file
Review an install
List installed components
Install a registry component
Retrieve an install
Update an install
Uninstall a registry component

Uninstall a registry component

Uninstalls a registry component from the project.

Published paywalls keep working; paywalls that still place it cannot be published again until it is installed again.

Guide: Publishing

DELETE
/api/v1/projects/{projectId}/component-installs/{installId}

Authorization

AuthorizationBearer <token>

A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.

In: header

Path parameters

projectId*string

The project's id, proj_.... A secret key works only in the project it belongs to.

installId*string

The install's id, cmp_inst_....

Examples

curl -X DELETE "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/component-installs/cmp_inst_b9n4m7q2w5e8r1t6y3u0i5o8" \  -H "Authorization: Bearer vh_sk_..."
Empty
{  "error": {    "type": "invalid_request",    "code": "string",    "message": "string",    "param": "string"  }}
{  "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": "component_install_not_found",    "message": "This project has no component install cmp_inst_b9n4m7q2w5e8r1t6y3u0i5o8.",    "param": "installId"  }}

{  "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."  }}

Response body

application/json

application/json

application/json

application/json

application/json

Errors

StatustypecodeWhen
404not_foundcomponent_install_not_found—

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

More in Component registry

  • Retrieve the registry publisher GET
  • Claim a registry namespace PUT
  • List registry components GET
  • Publish a component bundle POST
  • Publish a project component POST
  • Retrieve a registry component GET
  • Update a registry component PATCH
  • List a registry component's versions GET
  • Retrieve a registry component version GET
  • Update a registry component version PATCH
  • Retrieve a version's file GET
  • Review an install GET
  • List installed components GET
  • Install a registry component POST
  • Retrieve an install GET
  • Update an install PATCH

Something wrong or missing on this page? Tell us by email or on Discord.

PreviousUpdate an installNextList assets

On this page

AuthorizationPath parametersExamplesResponse bodyErrorsMore in Component registry