VercelVercel
Menu

Provision Resource

POST/v1/installations/{installationId}/resources
Provisions a Resource. This is a synchronous operation but the provisioning can be asynchronous as the Resource does not need to be immediately available however the secrets must be known ahead of time.
/v1/installations/{installationId}/resources
const response = await fetch('/v1/installations/string/resources', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "productId": "string",
    "name": "string",
    "metadata": "value",
    "billingPlanId": "string",
    "externalId": "string",
    "protocolSettings": {
      "experimentation": {
        "edgeConfigId": "string"
      }
    }
  }),
});


const data = await response.json();
console.log(data);
Response
{
  "id": "string",
  "productId": "string",
  "protocolSettings": {
    "experimentation": {
      "edgeConfigSyncingEnabled": "true",
      "edgeConfigId": "string",
      "edgeConfigTokenId": "string"
    }
  },
  "billingPlan": {
    "id": "string",
    "type": "prepayment",
    "name": "string",
    "scope": "installation",
    "description": "string",
    "paymentMethodRequired": "true",
    "preauthorizationAmount": "123",
    "initialCharge": "string",
    "minimumAmount": "string",
    "maximumAmount": "string",
    "maximumAmountAutoPurchasePerPeriod": "string",
    "cost": "string",
    "details": [],
    "highlightedDetails": [],
    "quote": [],
    "effectiveDate": "string",
    "disabled": "true"
  },
  "name": "string",
  "metadata": "value",
  "status": "ready",
  "notification": {
    "level": "info",
    "title": "string",
    "message": "string",
    "href": "string"
  },
  "secrets": []
}

Authentication

AuthorizationUser Authentication

Default authentication mechanism

Path parameters

installationIdstringRequired

Header parameters

X-Vercel-AuthstringOptional
The auth style used in the request (system, user, etc)
Idempotency-KeystringOptional
A unique key to identify a request across multiple retries

Request

This endpoint expects an object.

productIdstringRequired
The partner-specific ID/slug of the product. Example: "redis"
namestringRequired
User-inputted name for the resource.
metadataobjectRequired
User-inputted metadata based on the registered metadata schema.
billingPlanIdstringRequired
Partner-provided billing plan. Example: "pro200"
externalIdstringOptional
An partner-provided identifier used to indicate the source of the resource provisioning. In the Deploy Button flow, the externalId will equal the external-id query parameter.
protocolSettingsobjectOptional

Response

Return the newly provisioned resource
idstringRequired
The partner-specific ID of the resource
productIdstringRequired
The partner-specific ID/slug of the product. Example: "redis"
protocolSettingsobjectOptional
billingPlanobjectOptional
The billing plan for the resource. If not set, the resource is billed on installation level.
namestringRequired
User-inputted name for the resource.
metadataobjectRequired
User-inputted metadata based on the registered metadata schema.
statusstringRequired
notificationobjectOptional
Resource's active notification. Example: { "level": "warn", "title": "Database is nearing maximum planned size" }
secretsarrayRequired

Errors

400Input has failed validation
403Operation failed because the authentication is not allowed to perform this operation
409Operation failed because of a conflict with the current state of the resource
Provision Resource | Partner API