--- title: create-integration-store-free-and-paid-plans product: vercel url: /docs/rest-api/integrations/create-integration-store-free-and-paid-plans type: reference prerequisites: [] related: - /docs/rest-api summary: Learn about create-integration-store-free-and-paid-plans on Vercel. install_vercel_plugin: npx plugins add vercel/vercel-plugin --- # Create integration store (free and paid plans) ```http POST /v1/storage/stores/integration/direct ``` Creates an integration store with automatic billing plan handling. For free resources, omit `billingPlanId` to auto-discover free plans. For paid resources, provide a `billingPlanId` from the billing plans endpoint. ## Authentication **bearerToken**: HTTP bearer ## Query parameters | Name | Type | Required | Description | |---|---|---|---| | `teamId` | string | No | The Team identifier to perform the request on behalf of. | | `slug` | string | No | The Team slug to perform the request on behalf of. | ## Request body Required: No Content-Type: `application/json` ```json { "type": "object", "required": [ "name", "integrationConfigurationId", "integrationProductIdOrSlug" ], "properties": { "name": { "type": "string", "description": "Human-readable name for the storage resource", "maxLength": 128 }, "integrationConfigurationId": { "type": "string", "description": "ID of your integration configuration. Get this from GET /v1/integrations/configurations", "pattern": "^icfg_[a-zA-Z0-9]+$" }, "integrationProductIdOrSlug": { "type": "string", "description": "ID or slug of the integration product. Get available products from GET /v1/integrations/configuration/{id}/products", "oneOf": [ { "description": "Product ID format", "pattern": "^iap_[a-zA-Z0-9_]+$" }, { "description": "Product slug format", "pattern": "^[a-z0-9-]+$" } ] }, "metadata": { "type": "object", "description": "Optional key-value pairs for resource metadata", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "type": "number" } } ] } }, "externalId": { "type": "string", "description": "Optional external identifier for tracking purposes" }, "protocolSettings": { "type": "object", "description": "Protocol-specific configuration settings", "additionalProperties": true }, "source": { "type": "string", "description": "Source of the store creation request", "enum": [ "marketplace", "deploy-button", "external", "v0", "resource-claims", "cli", "oauth", "backoffice" ], "default": "marketplace" }, "billingPlanId": { "type": "string", "description": "ID of the billing plan for paid resources. Get available plans from GET /integrations/integration/{id}/products/{productId}/plans. If not provided, automatically discovers free billing plans." }, "paymentMethodId": { "type": "string", "description": "Payment method ID for paid resources. Optional - uses default payment method if not provided." }, "prepaymentAmountCents": { "type": "number", "description": "Amount in cents for prepayment billing plans. Required only for prepayment plans with variable amounts.", "minimum": 50 } } } ``` ## Responses ### 200: No description Content-Type: `application/json` ```json { "type": "object", "required": [ "store" ], "properties": { "store": { "type": "object", "nullable": true, "required": [ "externalResourceId", "product", "projectsMetadata", "secrets", "status", "usageQuotaExceeded" ], "properties": { "projectsMetadata": { "type": "array", "items": { "type": "object", "required": [ "envVarPrefix", "environmentVariables", "environments", "id", "name", "projectId" ], "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "framework": { "type": "string", "enum": [ "blitzjs", "nextjs", "gatsby", "remix", "react-router", "astro", "hexo", "eleventy", "docusaurus-2", "docusaurus", "preact", "solidstart-1", "solidstart", "dojo", "ember", "vue", "scully", "ionic-angular", "angular", "polymer", "svelte", "sveltekit", "sveltekit-1", "ionic-react", "create-react-app", "gridsome", "umijs", "sapper", "saber", "stencil", "nuxtjs", "redwoodjs", "hugo", "jekyll", "brunch", "middleman", "zola", "hydrogen", "vite", "tanstack-start", "vitepress", "vuepress", "parcel", "fastapi", "flask", "fasthtml", "django", "sanity-v3", "sanity", "storybook", "nitro", "hono", "express", "h3", "koa", "nestjs", "elysia", "fastify", "xmcp", "python", "ruby", "rust", "node", "go", "services" ], "nullable": true }, "latestDeployment": { "type": "string" }, "environments": { "type": "array", "items": { "type": "string", "enum": [ "production", "preview", "development" ] } }, "envVarPrefix": { "type": "string", "nullable": true }, "environmentVariables": { "type": "array", "items": { "type": "string" } }, "deployments": { "type": "object", "required": [ "actions", "required" ], "properties": { "required": { "type": "boolean", "enum": [ false, true ] }, "actions": { "type": "array", "items": { "type": "object", "required": [ "environments", "slug" ], "properties": { "slug": { "type": "string" }, "environments": { "type": "array", "items": { "type": "string", "enum": [ "production", "preview", "development" ] } } } } } } } } } }, "projectFilter": { "type": "object", "properties": { "git": { "type": "object", "required": [ "providers" ], "properties": { "providers": { "oneOf": [ { "type": "array", "items": { "type": "string", "enum": [ "github", "gitlab", "bitbucket" ] } }, { "type": "string", "enum": [ "*" ] } ] }, "owners": { "type": "array", "items": { "type": "string" } }, "repos": { "type": "array", "items": { "type": "string" } } } } } }, "totalConnectedProjects": { "type": "number" }, "usageQuotaExceeded": { "type": "boolean", "enum": [ false, true ] }, "status": { "type": "string", "enum": [ "available", "error", "suspended", "limits-exceeded-suspended", "limits-exceeded-suspended-store-count", "initializing", "onboarding", "uninstalled" ], "nullable": true }, "ownership": { "type": "string", "enum": [ "owned", "linked", "sandbox" ] }, "capabilities": { "type": "object", "properties": { "mcp": { "type": "boolean", "enum": [ false, true ] }, "mcpReadonly": { "type": "boolean", "enum": [ false, true ] }, "sso": { "type": "boolean", "enum": [ false, true ] }, "billable": { "type": "boolean", "enum": [ false, true ] }, "transferable": { "type": "boolean", "enum": [ false, true ] }, "secretsSync": { "type": "boolean", "enum": [ false, true ] }, "secretRotation": { "oneOf": [ { "type": "object", "required": [ "maxDelayHours" ], "properties": { "maxDelayHours": { "type": "number" } } }, { "type": "boolean", "enum": [ false ] } ] }, "projects": { "type": "boolean", "enum": [ false, true ] }, "v0": { "type": "boolean", "enum": [ false, true ] } } }, "metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "type": "number" } }, { "type": "boolean", "enum": [ false, true ] } ] } }, "externalResourceId": { "type": "string" }, "externalResourceStatus": { "type": "string", "enum": [ "error", "suspended", "onboarding", "uninstalled", "ready", "pending", "resumed" ], "nullable": true }, "directPartnerConsoleUrl": { "type": "string" }, "product": { "type": "object", "required": [ "integration", "integrationConfigurationId", "supportedProtocols" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "iconUrl": { "type": "string" }, "capabilities": { "type": "object", "properties": { "mcp": { "type": "boolean", "enum": [ false, true ] }, "mcpReadonly": { "type": "boolean", "enum": [ false, true ] }, "sso": { "type": "boolean", "enum": [ false, true ] }, "billable": { "type": "boolean", "enum": [ false, true ] }, "transferable": { "type": "boolean", "enum": [ false, true ] }, "secretsSync": { "type": "boolean", "enum": [ false, true ] }, "secretRotation": { "oneOf": [ { "type": "object", "required": [ "maxDelayHours" ], "properties": { "maxDelayHours": { "type": "number" } } }, { "type": "boolean", "enum": [ false ] } ] }, "sandbox": { "type": "boolean", "enum": [ false, true ] }, "linking": { "type": "boolean", "enum": [ false, true ] }, "projects": { "type": "boolean", "enum": [ false, true ] }, "v0": { "type": "boolean", "enum": [ false, true ] }, "importResource": { "type": "boolean", "enum": [ false, true ] }, "connectedImportResource": { "type": "boolean", "enum": [ false, true ] }, "nativeImportResource": { "type": "boolean", "enum": [ false, true ] }, "databaseUI": { "type": "boolean", "enum": [ false, true ] } } }, "shortDescription": { "type": "string" }, "metadataSchema": { "type": "object", "required": [ "properties", "type" ], "properties": { "type": { "type": "string", "enum": [ "object" ] }, "properties": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "object", "required": [ "type", "ui:control" ], "properties": { "type": { "type": "string", "enum": [ "string" ] }, "ui:control": { "type": "string", "enum": [ "input" ] }, "enum": { "type": "array", "items": { "type": "string" } }, "maxLength": { "type": "number" }, "minLength": { "type": "number" }, "pattern": { "type": "string" }, "description": { "type": "string" }, "default": { "type": "string" }, "ui:label": { "type": "string" }, "ui:read-only": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:hidden": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:disabled": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:description": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } } ] }, "ui:formatted-value": { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, "ui:placeholder": { "type": "string" } } }, { "type": "object", "required": [ "type", "ui:control" ], "properties": { "type": { "type": "string", "enum": [ "number" ] }, "ui:control": { "type": "string", "enum": [ "input" ] }, "maximum": { "type": "number" }, "exclusiveMaximum": { "type": "number" }, "minimum": { "type": "number" }, "exclusiveMinimum": { "type": "number" }, "description": { "type": "string" }, "default": { "type": "number" }, "ui:label": { "type": "string" }, "ui:read-only": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:hidden": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:disabled": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:description": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } } ] }, "ui:formatted-value": { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, "ui:placeholder": { "type": "string" } } }, { "type": "object", "required": [ "type", "ui:control" ], "properties": { "type": { "type": "string", "enum": [ "boolean" ] }, "ui:control": { "type": "string", "enum": [ "toggle" ] }, "description": { "type": "string" }, "default": { "type": "boolean", "enum": [ false, true ] }, "ui:label": { "type": "string" }, "ui:read-only": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:hidden": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:disabled": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:description": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } } ] }, "ui:formatted-value": { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } } } }, { "type": "object", "required": [ "items", "type", "ui:control", "ui:steps" ], "properties": { "type": { "type": "string", "enum": [ "array" ] }, "items": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "number" ] }, "description": { "type": "string" }, "minimum": { "type": "number" }, "exclusiveMinimum": { "type": "number" }, "maximum": { "type": "number" }, "exclusiveMaximum": { "type": "number" }, "default": { "type": "number" } } }, "ui:control": { "type": "string", "enum": [ "slider" ] }, "ui:steps": { "type": "array", "items": { "type": "number" } }, "maxItems": { "type": "number" }, "minItems": { "type": "number" }, "description": { "type": "string" }, "ui:label": { "type": "string" }, "ui:read-only": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:hidden": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:disabled": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:description": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } } ] }, "ui:formatted-value": { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, "default": { "type": "array", "items": { "type": "number" } } } }, { "type": "object", "required": [ "type", "ui:control", "ui:options" ], "properties": { "type": { "type": "string", "enum": [ "string" ] }, "ui:control": { "type": "string", "enum": [ "select" ] }, "ui:options": { "type": "array", "items": { "type": "object", "required": [ "label", "value" ], "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "disabled": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "hidden": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] } } } }, "enum": { "type": "array", "items": { "type": "string" } }, "maxLength": { "type": "number" }, "minLength": { "type": "number" }, "pattern": { "type": "string" }, "description": { "type": "string" }, "default": { "type": "string" }, "ui:label": { "type": "string" }, "ui:read-only": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:hidden": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:disabled": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:description": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } } ] }, "ui:formatted-value": { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, "ui:placeholder": { "type": "string" } } }, { "type": "object", "required": [ "type", "ui:control", "ui:options" ], "properties": { "type": { "type": "string", "enum": [ "string" ] }, "ui:control": { "type": "string", "enum": [ "radio-button" ] }, "ui:options": { "type": "array", "items": { "type": "object", "required": [ "label", "value" ], "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "disabled": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "hidden": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] } } } }, "enum": { "type": "array", "items": { "type": "string" } }, "maxLength": { "type": "number" }, "minLength": { "type": "number" }, "pattern": { "type": "string" }, "description": { "type": "string" }, "default": { "type": "string" }, "ui:label": { "type": "string" }, "ui:read-only": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:hidden": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:disabled": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:description": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } } ] }, "ui:formatted-value": { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, "ui:placeholder": { "type": "string" } } }, { "type": "object", "required": [ "items", "type", "ui:control", "ui:options" ], "properties": { "type": { "type": "string", "enum": [ "array" ] }, "items": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "string" ] }, "description": { "type": "string" }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "pattern": { "type": "string" }, "default": { "type": "string" }, "enum": { "type": "array", "items": { "type": "string" } } } }, "ui:control": { "type": "string", "enum": [ "multi-select" ] }, "ui:options": { "type": "array", "items": { "type": "object", "required": [ "label", "value" ], "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "disabled": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "hidden": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] } } } }, "maxItems": { "type": "number" }, "minItems": { "type": "number" }, "description": { "type": "string" }, "ui:label": { "type": "string" }, "ui:read-only": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:hidden": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:disabled": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:description": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } } ] }, "ui:formatted-value": { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, "ui:placeholder": { "type": "string" }, "default": { "type": "array", "items": { "type": "string" } }, "example": { "type": "array", "items": { "type": "string" } } } }, { "type": "object", "required": [ "type", "ui:control", "ui:options" ], "properties": { "type": { "type": "string", "enum": [ "string" ] }, "ui:control": { "type": "string", "enum": [ "vercel-region" ] }, "ui:options": { "type": "array", "items": { "oneOf": [ { "type": "object", "required": [ "label", "value" ], "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "disabled": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "hidden": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] } } }, { "type": "string" }, { "type": "object", "required": [ "value" ], "properties": { "value": { "type": "string" }, "description": { "type": "string" }, "disabled": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "hidden": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] } } } ] } }, "enum": { "type": "array", "items": { "type": "string" } }, "maxLength": { "type": "number" }, "minLength": { "type": "number" }, "pattern": { "type": "string" }, "description": { "type": "string" }, "default": { "type": "string" }, "ui:label": { "type": "string" }, "ui:read-only": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:hidden": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:disabled": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:description": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } } ] }, "ui:formatted-value": { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, "ui:placeholder": { "type": "string" } } }, { "type": "object", "required": [ "items", "type", "ui:control", "ui:options" ], "properties": { "type": { "type": "string", "enum": [ "array" ] }, "items": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "string" ] }, "description": { "type": "string" }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "pattern": { "type": "string" }, "default": { "type": "string" }, "enum": { "type": "array", "items": { "type": "string" } } } }, "ui:control": { "type": "string", "enum": [ "multi-vercel-region" ] }, "ui:options": { "type": "array", "items": { "oneOf": [ { "type": "object", "required": [ "label", "value" ], "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "disabled": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "hidden": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] } } }, { "type": "string" }, { "type": "object", "required": [ "value" ], "properties": { "value": { "type": "string" }, "description": { "type": "string" }, "disabled": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "hidden": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] } } } ] } }, "maxItems": { "type": "number" }, "minItems": { "type": "number" }, "description": { "type": "string" }, "ui:label": { "type": "string" }, "ui:read-only": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:hidden": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:disabled": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:description": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } } ] }, "ui:formatted-value": { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, "ui:placeholder": { "type": "string" }, "default": { "type": "array", "items": { "type": "string" } }, "example": { "type": "array", "items": { "type": "string" } } } }, { "type": "object", "required": [ "type", "ui:control" ], "properties": { "type": { "type": "string", "enum": [ "string" ] }, "ui:control": { "type": "string", "enum": [ "domain" ] }, "enum": { "type": "array", "items": { "type": "string" } }, "maxLength": { "type": "number" }, "minLength": { "type": "number" }, "pattern": { "type": "string" }, "description": { "type": "string" }, "default": { "type": "string" }, "ui:label": { "type": "string" }, "ui:read-only": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:hidden": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:disabled": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:description": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } } ] }, "ui:formatted-value": { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, "ui:placeholder": { "type": "string" } } }, { "type": "object", "required": [ "type", "ui:control" ], "properties": { "type": { "type": "string", "enum": [ "string" ] }, "ui:control": { "type": "string", "enum": [ "git-namespace" ] }, "description": { "type": "string" }, "ui:label": { "type": "string" }, "ui:read-only": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:hidden": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:disabled": { "oneOf": [ { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, { "type": "boolean", "enum": [ false, true ] }, { "type": "string", "enum": [ "update", "create" ] } ] }, "ui:description": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } } ] }, "ui:formatted-value": { "type": "object", "required": [ "expr" ], "properties": { "expr": { "type": "string" } } }, "ui:placeholder": { "type": "string" }, "git:providers": { "type": "array", "items": { "type": "string", "enum": [ "github", "gitlab", "bitbucket" ] } } } } ] } }, "required": { "type": "array", "items": { "type": "string" } } } }, "resourceLinks": { "type": "array", "items": { "type": "object", "required": [ "href", "title" ], "properties": { "href": { "type": "string" }, "title": { "type": "string" } } } }, "tags": { "type": "array", "items": { "type": "string", "enum": [ "edge-config", "redis", "postgres", "blob", "experimentation", "checks", "storage", "ai", "observability", "video", "authentication", "workflow", "logDrain", "traceDrain", "messaging", "other", "mysql", "kv", "vector", "libsql", "sqlite", "rds", "drains", "mcp", "tag_agents", "tag_ai", "tag_analytics", "tag_authentication", "tag_cms", "tag_code_repository", "tag_code_review", "tag_code_security", "tag_code_testing", "tag_commerce", "tag_databases", "tag_dev_tools", "tag_experimentation", "tag_flags", "tag_logging", "tag_messaging", "tag_monitoring", "tag_observability", "tag_payments", "tag_performance", "tag_productivity", "tag_searching", "tag_security", "tag_support_agent", "tag_testing", "tag_video", "tag_web_automation", "tag_workflow", "tag_checks", "tag_storage", "tag_logDrain", "tag_traceDrain", "tag_other" ] } }, "projectConnectionScopes": { "type": "array", "items": { "type": "string", "enum": [ "read:deployment", "read:domain", "read:project", "read-write:deployment", "read-write:deployment-check", "read-write:domain", "read-write:global-project-env-vars", "read-write:integration-deployment-action", "read-write:log-drain", "read-write:drains", "read-write:project-env-vars", "read-write:project-protection-bypass" ] } }, "showSSOLinkOnProjectConnection": { "type": "boolean", "enum": [ false, true ] }, "disableResourceRenaming": { "type": "boolean", "enum": [ false, true ] }, "resourceTitle": { "type": "string", "description": "Custom resource title to display during installation and configuration. If not provided, defaults to protocol-based defaults." }, "agentSkillUrl": { "type": "string", "description": "URL to a skill/guide for how AI agents should use this product. Providers can specify this to help agents understand how to interact with their integration." }, "repl": { "type": "object", "required": [ "enabled", "supportsReadOnlyMode" ], "properties": { "enabled": { "type": "boolean", "enum": [ false, true ] }, "supportsReadOnlyMode": { "type": "boolean", "enum": [ false, true ] }, "welcomeMessage": { "type": "string" } } }, "guides": { "type": "array", "items": { "type": "object", "required": [ "framework", "steps", "title" ], "properties": { "framework": { "type": "string" }, "title": { "type": "string" }, "steps": { "type": "array", "items": { "type": "object", "required": [ "content", "title" ], "properties": { "title": { "type": "string" }, "content": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "connect_to_project", "configure_project_connections", "add_drain" ] } } } } } } } } } }, "integration": { "type": "object", "required": [ "icon", "id", "name", "slug" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "supportsInstallationBillingPlans": { "type": "boolean", "enum": [ false, true ] }, "icon": { "type": "string" }, "flags": { "type": "array", "items": { "type": "string" } } } }, "integrationConfigurationId": { "type": "string" }, "supportedProtocols": { "type": "array", "items": { "type": "string", "enum": [ "experimentation", "checks", "storage", "ai", "observability", "video", "authentication", "workflow", "logDrain", "traceDrain", "messaging", "other" ] } }, "primaryProtocol": { "type": "string", "enum": [ "experimentation", "checks", "storage", "ai", "observability", "video", "authentication", "workflow", "logDrain", "traceDrain", "messaging", "other" ] }, "logDrainStatus": { "type": "string", "enum": [ "disabled", "enabled" ] } } }, "protocolSettings": { "type": "object", "properties": { "experimentation": { "type": "object", "properties": { "edgeConfigSyncingEnabled": { "type": "boolean", "enum": [ false, true ] }, "edgeConfigId": { "type": "string" }, "edgeConfigTokenId": { "type": "string" } } } } }, "notification": { "type": "object", "required": [ "level", "title" ], "properties": { "title": { "type": "string" }, "level": { "type": "string", "enum": [ "error", "info", "warn" ] }, "message": { "type": "string" }, "href": { "type": "string" } } }, "secrets": { "type": "array", "items": { "type": "object", "required": [ "length", "name" ], "properties": { "name": { "type": "string" }, "length": { "type": "number" }, "frameworkPublishable": { "type": "boolean", "enum": [ false, true ] } } } }, "billingPlan": { "type": "object", "required": [ "description", "id", "name", "paymentMethodRequired", "scope", "type" ], "properties": { "type": { "type": "string", "enum": [ "prepayment", "subscription" ] }, "description": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "scope": { "type": "string", "enum": [ "installation", "resource" ] }, "paymentMethodRequired": { "type": "boolean", "enum": [ false, true ] }, "preauthorizationAmount": { "type": "number" }, "initialCharge": { "type": "string" }, "minimumAmount": { "type": "string" }, "maximumAmount": { "type": "string" }, "maximumAmountAutoPurchasePerPeriod": { "type": "string" }, "cost": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "required": [ "label" ], "properties": { "label": { "type": "string" }, "value": { "type": "string" } } } }, "highlightedDetails": { "type": "array", "items": { "type": "object", "required": [ "label" ], "properties": { "label": { "type": "string" }, "value": { "type": "string" } } } }, "quote": { "type": "array", "items": { "type": "object", "required": [ "amount", "line" ], "properties": { "line": { "type": "string" }, "amount": { "type": "string" } } } }, "effectiveDate": { "type": "string" }, "disabled": { "type": "boolean", "enum": [ false, true ] } } }, "secretRotationRequestedAt": { "type": "number", "description": "The timestamp when secret rotation was requested." }, "secretRotationRequestedReason": { "type": "string", "description": "The reason for the secret rotation request." }, "secretRotationRequestedBy": { "type": "string", "description": "The ID of the user/team who requested the secret rotation." }, "secretRotationCompletedAt": { "type": "number", "description": "The timestamp when secret rotation was completed." }, "parentId": { "type": "string", "description": "The ID of the parent resource. Used to establish a parent-child relationship between resources, such as sandbox resources linking to their owner account resource." }, "targets": { "type": "array", "description": "The deployment targets that this resource is available for.", "items": { "type": "string", "description": "The deployment targets that this resource is available for.", "enum": [ "production", "preview", "development" ] } } } } } } ``` ### 400: One of the provided values in the request body is invalid. ### 401: The request is not authorized. ### 402: The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated ### 403: You do not have permission to access this resource. ### 404: No description ### 409: No description ### 429: No description ### 500: No description --- ## Related - [integrations endpoints](/docs/rest-api#integrations) - [REST API overview](/docs/rest-api) - [OpenAPI spec](https://openapi.vercel.sh/) (machine-readable, all endpoints) --- [View full sitemap](/docs/sitemap)