PUT /v1/installations/{integrationConfigurationId}/resources/{resourceId}
This endpoint imports (upserts) a resource to Vercel's installation. This may be needed if resources can be independently created on the partner's side and need to be synchronized to Vercel. When importing as part of the user-initiated import flow, call this endpoint before redirecting the user back to Vercel. See the Import existing resources flow for the full contract.
Servers
- https://api.vercel.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
integrationConfigurationId |
String | Yes | |
resourceId |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
productId |
String | Yes | |
extras |
Object | No | |
name |
String | Yes | |
secrets[] |
Array | No | |
secrets[].environmentOverrides |
Object | No |
A map of environments to override values for the secret, used for setting different values across deployments in production, preview, and development environments. Note: the same value will be used for all deployments in the given environment. |
secrets[].environmentOverrides.production |
String | No |
Value used for production environment. |
secrets[].environmentOverrides.preview |
String | No |
Value used for preview environment. |
secrets[].environmentOverrides.development |
String | No |
Value used for development environment. |
secrets[].name |
String | Yes | |
secrets[].prefix |
String | No | |
secrets[].value |
String | Yes | |
billingPlan |
Object | No | |
billingPlan.id |
String | Yes | |
billingPlan.effectiveDate |
String | No | |
billingPlan.name |
String | Yes | |
billingPlan.description |
String | No | |
billingPlan.paymentMethodRequired |
Boolean | No | |
billingPlan.highlightedDetails[] |
Array | No | |
billingPlan.highlightedDetails[].label |
String | Yes | |
billingPlan.highlightedDetails[].value |
String | No | |
billingPlan.type |
String | Yes |
Valid values:
|
billingPlan.cost |
String | No | |
billingPlan.details[] |
Array | No | |
billingPlan.details[].label |
String | Yes | |
billingPlan.details[].value |
String | No | |
metadata |
Object | No | |
status |
String | Yes |
Valid values:
|
notification |
Object | No | |
notification.href |
String | No | |
notification.message |
String | No | |
notification.level |
String | Yes |
Valid values:
|
notification.title |
String | Yes | |
ownership |
String | No |
Valid values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.