API referencePlatform APIEndpoint reference
GUIDE & REFERENCE

/api/provisioning/instances/upgrade (dashboard)

Source-derived dashboard endpoint contract, authentication, request validation, responses, and errors.

This is the dashboard service route. Its origin and authentication are described in Platform API overview and Authentication. A path shared by another service is a different endpoint.

PropertyContract
MethodsPOST
Path/api/provisioning/instances/upgrade
Path parametersNone
Query parameters read in routeNone read directly; schema validation below may define additional fields
Headers read in routeNo additional direct header reads; authentication helpers may read credentials

Authentication and access

Dashboard session cookie through @repo/auth/server. Some auth-summary routes can redirect to sign-in; inspect the status branches below.

Request and response definitions

The following named definitions are imported or declared by this route. Optional markers, defaults, bounds, and enum values are shown exactly as implemented. A response type is a source contract, not an example populated with real account data.

UpgradeBody

type UpgradeBody = {
  instanceId?: string;
  renderServiceId?: string;
  renderServiceName?: string;
  plan?: string;
  region?: string;
  hostname?: string;
  deploymentSlug?: string;
};

Source: minds-ui/apps/app/app/api/provisioning/instances/upgrade/route.ts:17.

Method behavior

The handler excerpt preserves field validation, response envelopes, cookie changes, and exception branches. Values returned by service helpers retain their named response type above; for passthrough routes, the upstream response is authoritative.

POST

export async function POST(request: NextRequest) {
  const session = await getSession();
  if (!session) {
    return jsonError('UNAUTHENTICATED', 'Sign in before upgrading a Mind.', 401, {
      redirectTo: `/sign-in?returnTo=${encodeURIComponent(RETURN_TO)}`,
    });
  }

  const cookieStore = await cookies();
  const organizationContext = await loadMindsOrganizationContext({
    accessToken: session.accessToken,
    activeTenantId: cookieStore.get(ACTIVE_TENANT_COOKIE)?.value,
    tokenOrgId: session.user.orgId,
    tokenTenantId: session.user.tenantId,
  });
  const organizationId = organizationContext.activeOrganizationId;
  if (!organizationId) {
    return jsonError(
      'NO_ORGANIZATION',
      'Create or select an organization before upgrading.',
      409,
      { redirectTo: '/organizations' }
    );
  }

  try {
    const body = (await request.json().catch(() => ({}))) as UpgradeBody;
    const instanceId = body.instanceId?.trim();
    if (!instanceId) {
      return jsonError('INVALID_UPGRADE_REQUEST', 'instanceId is required.', 400);
    }
    if (body.plan && body.plan !== 'pro') {
      return jsonError(
        'INVALID_UPGRADE_REQUEST',
        'Only Free→Pro in-place upgrades are supported.',
        400
      );
    }

    // Prefer explicit Render id; else resolve by name (instance name / slug).
    let renderServiceId = body.renderServiceId?.trim();
    let renderServiceName = body.renderServiceName?.trim();
    if (!renderServiceId) {
      for (const group of organizationContext.tenantGroups) {
        const match = group.services.find((service) => service.id === instanceId);
        if (match) {
          const metaId = match.metadata?.renderServiceId;
          if (typeof metaId === 'string' && metaId.trim()) {
            renderServiceId = metaId.trim();
          }
          if (!renderServiceName) {
            renderServiceName = match.name || match.slug;
          }
          break;
        }
      }
    }

    const result = await upgradeInstanceToPro({
      instanceId,
      organizationId,
      plan: 'pro',
      renderServiceId,
      renderServiceName: renderServiceName || undefined,
      region: body.region,
      hostname: body.hostname,
      deploymentSlug: body.deploymentSlug,
    });

    // Same instance_id — envelope + warm only.
    return NextResponse.json({ instance: result, sameInstanceId: true });
  } catch (error) {
    if (error instanceof UpgradeRequestError) {
      return jsonError('UPGRADE_FAILED', error.message, error.status);
    }
    console.error('Minds Free→Pro upgrade failed:', error);
    return jsonError(
      'UPGRADE_FAILED',
      error instanceof Error ? error.message : 'Free→Pro upgrade failed.',
      502
    );
  }
}

Source: minds-ui/apps/app/app/api/provisioning/instances/upgrade/route.ts:27.

Response and error branches

Literal HTTP statuses in the route: delegated or computed. Shared management error classes are defined in Errors and responses.

jsonError('UNAUTHENTICATED', 'Sign in before upgrading a Mind.', 401, {
      redirectTo: `/sign-in?returnTo=${encodeURIComponent(RETURN_TO)}`,
    })

Source: minds-ui/apps/app/app/api/provisioning/instances/upgrade/route.ts:30.

jsonError(
      'NO_ORGANIZATION',
      'Create or select an organization before upgrading.',
      409,
      { redirectTo: '/organizations' }
    )

Source: minds-ui/apps/app/app/api/provisioning/instances/upgrade/route.ts:44.

request.json()

Source: minds-ui/apps/app/app/api/provisioning/instances/upgrade/route.ts:53.

jsonError('INVALID_UPGRADE_REQUEST', 'instanceId is required.', 400)

Source: minds-ui/apps/app/app/api/provisioning/instances/upgrade/route.ts:56.

jsonError(
        'INVALID_UPGRADE_REQUEST',
        'Only Free→Pro in-place upgrades are supported.',
        400
      )

Source: minds-ui/apps/app/app/api/provisioning/instances/upgrade/route.ts:59.

NextResponse.json({ instance: result, sameInstanceId: true })

Source: minds-ui/apps/app/app/api/provisioning/instances/upgrade/route.ts:97.

jsonError('UPGRADE_FAILED', error.message, error.status)

Source: minds-ui/apps/app/app/api/provisioning/instances/upgrade/route.ts:100.

jsonError(
      'UPGRADE_FAILED',
      error instanceof Error ? error.message : 'Free→Pro upgrade failed.',
      502
    )

Source: minds-ui/apps/app/app/api/provisioning/instances/upgrade/route.ts:103.

NextResponse.json({ error: { code, message, ...extra } }, { status })

Source: minds-ui/apps/app/app/api/provisioning/instances/upgrade/route.ts:117.

Service dependencies

  • minds-ui/apps/app/lib/organizations.ts
  • minds-ui/apps/app/lib/provisioning/upgrade.ts

Evidence

Generated from the local source snapshot on 2026-09-12. This page documents implemented code and does not certify a deployed service, permissions configuration, or successful provider operation.

Source file: minds-ui/apps/app/app/api/provisioning/instances/upgrade/route.ts. SHA-256: 9dcea44da91cfa4703818b86e16761a6ace064237ba68edf1ac13cc9a0e1bb71.

On this page