Sign in
Vercel Resources

Provision a Vercel Marketplace resource

Changed on

Create a resource (a Xata project and its branches) and return it with the connection secrets. Vercel calls this when a customer creates a resource. Idempotent when an Idempotency-Key header is sent: a retry with the same key returns the existing resource unchanged, and reusing the key with a different body is a conflict (409). Without the header there is no stable key, so each call provisions a new resource.

post/v1/installations/{installationId}/resources

Request

  • Base URL: https://api.xata.tech
  • URL: https://api.xata.tech/v1/installations/{installationId}/resources
  • Auth: none declared

Path parameters

installationIdstring required

Vercel installation id (icfg_...).

Headers

Idempotency-Keystring

A stable key Vercel sends to make retries safe. A repeat with the same key returns the existing resource; reusing it with a different body is a conflict (409). Optional — without it each call provisions a new resource.

Request body

productIdstring required

The partner-specific product id/slug.

namestring required

User-inputted resource name.

metadataobject required

User-inputted metadata based on the registered metadata schema.

billingPlanIdstring required

Selected Vercel billing plan id.

externalIdstring

Partner-provided identifier indicating the source of provisioning.

Response

The provisioned resource, with connection secrets.

idstring required

The partner-specific resource id.

productIdstring required

The partner-specific product id/slug.

namestring required

User-inputted resource name.

metadataobject required

User-inputted metadata based on the registered metadata schema.

statusstring required

Resource lifecycle status. One of Vercel's values: ready, pending, onboarding, suspended, resumed, uninstalled, error.

Changes