# /api/v1/instances/[instanceId] (management)

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

Source: https://docs.minds.sh/docs/api/platform/reference/management--api-v1-instances-instanceId



This is the **management** service route. Its origin and authentication are described in [Platform API overview](/docs/api/platform) and [Authentication](/docs/api/platform/authentication). A path shared by another service is a different endpoint.

| Property                       | Contract                                                                       |
| ------------------------------ | ------------------------------------------------------------------------------ |
| Methods                        | GET, DELETE                                                                    |
| Path                           | `/api/v1/instances/[instanceId]`                                               |
| Path parameters                | `instanceId`                                                                   |
| Query parameters read in route | None read directly; schema validation below may define additional fields       |
| Headers read in route          | No additional direct header reads; authentication helpers may read credentials |

## Authentication and access [#authentication-and-access]

Management auth context: validated x-api-key or configured session authentication; trusted gateway integration may select its auth pipeline. Organization/tenant checks are separate.

## Method behavior [#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.

### GET [#get]

```typescript
export async function GET(
  request: NextRequest,
  { params }: { params: Promise<{ instanceId: string }> }
) {
  try {
    const authContext = await resolveAuthContext(request, {
      allowApiKey: true,
      allowSession: true,
    });

    const { instanceId } = await params;

    // Get instance with tenant info
    const instance = await prisma.serviceInstance.findUnique({
      where: { id: instanceId },
      include: { tenant: true },
    });

    if (!instance || !instance.tenant) {
      return NextResponse.json({ error: 'Instance not found' }, { status: 404 });
    }

    // Ensure tenant access
    await ensureTenantAccess(
      authContext,
      instance.tenant.orgId,
      instance.tenant.ownerId,
      {
        action: 'instance:read',
        tenantId: instance.tenantId ?? undefined,
        resourceId: instance.id,
      }
    );

    return NextResponse.json(instance);
  } catch (error) {
    if (error instanceof ApiError) {
      return NextResponse.json(
        { error: error.message },
        { status: error.statusCode }
      );
    }

    console.error('[API] Error getting instance:', error);
    return NextResponse.json({ error: 'Internal server error' }, { status: 500 });
  }
}
```

Source: `minds-ui/apps/api-service/app/api/v1/instances/[instanceId]/route.ts:13`.

### DELETE [#delete]

```typescript
export async function DELETE(
  request: NextRequest,
  { params }: { params: Promise<{ instanceId: string }> }
) {
  try {
    const authContext = await resolveAuthContext(request, {
      allowApiKey: true,
      allowSession: true,
    });

    const { instanceId } = await params;

    // Get instance with tenant info
    const instance = await prisma.serviceInstance.findUnique({
      where: { id: instanceId },
      include: { tenant: true },
    });

    if (!instance || !instance.tenant) {
      return NextResponse.json({ error: 'Instance not found' }, { status: 404 });
    }

    // Ensure tenant access
    await ensureTenantAccess(
      authContext,
      instance.tenant.orgId,
      instance.tenant.ownerId,
      {
        action: 'instance:delete',
        tenantId: instance.tenantId ?? undefined,
        resourceId: instance.id,
      }
    );

    // Delete instance
    await instanceProvisioningService.deleteInstance(instanceId);

    return NextResponse.json({ message: 'Instance deleted successfully' });
  } catch (error) {
    if (error instanceof ApiError) {
      return NextResponse.json(
        { error: error.message },
        { status: error.statusCode }
      );
    }

    console.error('[API] Error deleting instance:', error);
    return NextResponse.json({ error: 'Internal server error' }, { status: 500 });
  }
}
```

Source: `minds-ui/apps/api-service/app/api/v1/instances/[instanceId]/route.ts:67`.

## Response and error branches [#response-and-error-branches]

Literal HTTP statuses in the route: 404, 500. Shared management error classes are defined in [Errors and responses](/docs/api/platform/errors).

```typescript
NextResponse.json({ error: 'Instance not found' }, { status: 404 })
```

Source: `minds-ui/apps/api-service/app/api/v1/instances/[instanceId]/route.ts:32`.

```typescript
NextResponse.json(instance)
```

Source: `minds-ui/apps/api-service/app/api/v1/instances/[instanceId]/route.ts:47`.

```typescript
NextResponse.json(
        { error: error.message },
        { status: error.statusCode }
      )
```

Source: `minds-ui/apps/api-service/app/api/v1/instances/[instanceId]/route.ts:50`.

```typescript
NextResponse.json({ error: 'Internal server error' }, { status: 500 })
```

Source: `minds-ui/apps/api-service/app/api/v1/instances/[instanceId]/route.ts:57`.

```typescript
NextResponse.json({ error: 'Instance not found' }, { status: 404 })
```

Source: `minds-ui/apps/api-service/app/api/v1/instances/[instanceId]/route.ts:86`.

```typescript
NextResponse.json({ message: 'Instance deleted successfully' })
```

Source: `minds-ui/apps/api-service/app/api/v1/instances/[instanceId]/route.ts:104`.

```typescript
NextResponse.json(
        { error: error.message },
        { status: error.statusCode }
      )
```

Source: `minds-ui/apps/api-service/app/api/v1/instances/[instanceId]/route.ts:107`.

```typescript
NextResponse.json({ error: 'Internal server error' }, { status: 500 })
```

Source: `minds-ui/apps/api-service/app/api/v1/instances/[instanceId]/route.ts:114`.

## Service dependencies [#service-dependencies]

* `minds-ui/apps/api-service/lib/services/auth-context.ts`
* `minds-ui/apps/api-service/lib/services/instance-provisioning-service.ts`
* `minds-ui/apps/api-service/types/errors.ts`
* `minds-ui/apps/api-service/lib/db.ts`

## Evidence [#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/api-service/app/api/v1/instances/[instanceId]/route.ts`. SHA-256: `dcbe789903adc0de5e951b4f09c3f27f593410cd5a59cfdffae8df80eaaa405d`.