installations
Creates, updates, deletes, gets or lists an installations resource.
Overview
| Name | installations |
| Type | Resource |
| Id | vercel.marketplace.installations |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
update | update | integration_configuration_id | This endpoint updates an integration installation. | |
rotate_credential | exec | integration_configuration_id, client_secret | Issues a replacement access token for an installation, so a partner can rotate a credential it believes is compromised without the customer having to reinstall. Authenticated by the credential being replaced plus the integration's client secret: a leaked access token on its own cannot rotate itself, which would otherwise let an attacker take over the installation and lock the partner out. The previous credential intentionally stays valid so in-flight requests keep working. Retiring it is a separate, explicit operation — a partner is never left mid-rotation without a working credential. | |
revoke_credential | exec | integration_configuration_id, token, client_secret | Retires a superseded installation credential, so a partner can complete a rotation it started with POST /credentials/rotate — the leaked credential stops working without the customer having to reinstall. Authenticated by a live installation credential plus the integration's client secret. The credential to retire is named in the body rather than being the one that authenticates, so the ordinary flow is: rotate, store the replacement, then authenticate with the replacement and revoke the old one. Refuses to retire an installation's last live credential. Rotation exists so remediation is not customer-visible; revoking the only credential would undo that and leave the install needing a reinstall. | |
finalize | exec | integration_configuration_id | This endpoint allows the partner to mark an installation as finalized. This means you will not send any more invoices for the installation. Use this after a customer has requested uninstall and you have sent any remaining invoices. This will allow the uninstall process to proceed immediately after all invoices have been paid. <br /> Use the credentials.access_token we provided in the [Upsert Installation](#upsert-installation) body to authorize this request. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
integration_configuration_id | string |
UPDATE examples
- update
This endpoint updates an integration installation.
UPDATE vercel.marketplace.installations
SET
status = '{{ status }}',
external_id = '{{ external_id }}',
billing_plan = '{{ billing_plan }}',
notification = '{{ notification }}'
WHERE
integration_configuration_id = '{{ integration_configuration_id }}' --required;
Lifecycle Methods
EXEC variables use wire (API) names.
- rotate_credential
- revoke_credential
- finalize
Issues a replacement access token for an installation, so a partner can rotate a credential it believes is compromised without the customer having to reinstall. Authenticated by the credential being replaced plus the integration's client secret: a leaked access token on its own cannot rotate itself, which would otherwise let an attacker take over the installation and lock the partner out. The previous credential intentionally stays valid so in-flight requests keep working. Retiring it is a separate, explicit operation — a partner is never left mid-rotation without a working credential.
EXEC vercel.marketplace.installations.rotate_credential
@integration_configuration_id='{{ integration_configuration_id }}' --required
@@json=
'{
"client_secret": "{{ client_secret }}",
"client_id": "{{ client_id }}"
}'
;
Retires a superseded installation credential, so a partner can complete a rotation it started with POST /credentials/rotate — the leaked credential stops working without the customer having to reinstall. Authenticated by a live installation credential plus the integration's client secret. The credential to retire is named in the body rather than being the one that authenticates, so the ordinary flow is: rotate, store the replacement, then authenticate with the replacement and revoke the old one. Refuses to retire an installation's last live credential. Rotation exists so remediation is not customer-visible; revoking the only credential would undo that and leave the install needing a reinstall.
EXEC vercel.marketplace.installations.revoke_credential
@integration_configuration_id='{{ integration_configuration_id }}' --required
@@json=
'{
"token": "{{ token }}",
"client_secret": "{{ client_secret }}",
"client_id": "{{ client_id }}"
}'
;
This endpoint allows the partner to mark an installation as finalized. This means you will not send any more invoices for the installation. Use this after a customer has requested uninstall and you have sent any remaining invoices. This will allow the uninstall process to proceed immediately after all invoices have been paid. <br /> Use the credentials.access_token we provided in the [Upsert Installation](#upsert-installation) body to authorize this request.
EXEC vercel.marketplace.installations.finalize
@integration_configuration_id='{{ integration_configuration_id }}' --required
;