/api/v1/regions (management)

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

Property	Contract
Methods	GET, POST
Path	`/api/v1/regions`
Path parameters	None
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

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

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.

RegionResponse

RegionResponse = z.object({
  id: z.string(),
  slug: z.string(),
  name: z.string(),
  displayName: z.string(),
  description: z.string().nullable(),
  provider: RegionProvider,
  status: RegionStatus,
  isPrimary: z.boolean(),
  ingressDomain: z.string().nullable(),
  latitude: z.number().nullable(),
  longitude: z.number().nullable(),
  capacity: RegionCapacity,
  lastHealthCheck: z.string().nullable(),
  healthMessage: z.string().nullable(),
})

Source: minds-ui/apps/api-service/types/region.ts:44.

RegionResponse

export type RegionResponse = z.infer<typeof RegionResponse>

Source: minds-ui/apps/api-service/types/region.ts:60.

ListRegionsQuery

ListRegionsQuery = z.object({
  status: RegionStatus.optional(),
  provider: RegionProvider.optional(),
  accepting_tenants: z.coerce.boolean().optional(),
})

Source: minds-ui/apps/api-service/types/region.ts:66.

ListRegionsQuery

export type ListRegionsQuery = z.infer<typeof ListRegionsQuery>

Source: minds-ui/apps/api-service/types/region.ts:71.

ListRegionsResponse

ListRegionsResponse = z.object({
  regions: z.array(RegionResponse),
  defaultRegion: z.string().nullable(),
})

Source: minds-ui/apps/api-service/types/region.ts:73.

ListRegionsResponse

export type ListRegionsResponse = z.infer<typeof ListRegionsResponse>

Source: minds-ui/apps/api-service/types/region.ts:77.

CreateRegionRequest

CreateRegionRequest = z.object({
  slug: z.string().min(2).max(50).regex(/^[a-z0-9-]+$/),
  name: z.string().min(1).max(100),
  displayName: z.string().min(1).max(200),
  description: z.string().max(500).optional(),
  provider: RegionProvider,
  isPrimary: z.boolean().optional().default(false),
  controlPlaneEndpoint: z.string().url().optional(),
  ingressDomain: z.string().optional(),
  kkpProjectId: z.string().optional(),
  kkpClusterId: z.string().optional(),
  kubeconfigSecretPath: z.string(),
  tlsBundleSecretPath: z.string().optional(),
  autoScales: z.boolean().optional().default(false),
  maxTenants: z.number().positive().optional(),
  latitude: z.number().min(-90).max(90).optional(),
  longitude: z.number().min(-180).max(180).optional(),
})

Source: minds-ui/apps/api-service/types/region.ts:83.

CreateRegionRequest

export type CreateRegionRequest = z.infer<typeof CreateRegionRequest>

Source: minds-ui/apps/api-service/types/region.ts:101.

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

export async function GET(request: NextRequest) {
  const requestId = generateRequestId()
  let rateLimitInfo: RateLimitMetadata | undefined

  try {
    const authContext = await resolveAuthContext(request)

    const query = validateQuery(request.nextUrl.searchParams, ListRegionsQuery)

    const evaluation = await enforceRateLimit({
      context: authContext,
    })

    rateLimitInfo = {
      ...evaluation.metadata,
      retryAfter: evaluation.retryAfter,
    }

    if (evaluation.blocked) {
      throw new RateLimitExceededError(evaluation.retryAfter ?? 60)
    }

    const result = await listRegions(authContext, {
      status: query.status,
      provider: query.provider,
      acceptingTenants: query.accepting_tenants,
    })

    const response = apiSuccess<ListRegionsResponse>(result)
    return withRequestMetadata(response, requestId, rateLimitInfo)
  } catch (error) {
    if (error instanceof ApiError) {
      const response = apiError(error, requestId)
      return withRequestMetadata(response, requestId, rateLimitInfo)
    }
    console.error('Failed to list regions:', error)
    const response = apiError(
      new ApiError(500, 'INTERNAL_ERROR', 'Failed to list regions'),
      requestId
    )
    return withRequestMetadata(response, requestId, rateLimitInfo)
  }
}

Source: minds-ui/apps/api-service/app/api/v1/regions/route.ts:26.

POST

export async function POST(request: NextRequest) {
  const requestId = generateRequestId()
  let rateLimitInfo: RateLimitMetadata | undefined

  try {
    const authContext = await resolveAuthContext(request)

    // TODO: Add admin check here
    // if (!authContext.isAdmin) {
    //   throw new ApiError(403, 'FORBIDDEN', 'Only admins can create regions')
    // }

    const body = await validateBody(request, CreateRegionRequest)

    const evaluation = await enforceRateLimit({
      context: authContext,
    })

    rateLimitInfo = {
      ...evaluation.metadata,
      retryAfter: evaluation.retryAfter,
    }

    if (evaluation.blocked) {
      throw new RateLimitExceededError(evaluation.retryAfter ?? 60)
    }

    const region = await createRegion(authContext, body)

    const response = apiCreated<RegionResponse>(region)
    return withRequestMetadata(response, requestId, rateLimitInfo)
  } catch (error) {
    if (error instanceof ApiError) {
      const response = apiError(error, requestId)
      return withRequestMetadata(response, requestId, rateLimitInfo)
    }
    console.error('Failed to create region:', error)
    const response = apiError(
      new ApiError(500, 'INTERNAL_ERROR', 'Failed to create region'),
      requestId
    )
    return withRequestMetadata(response, requestId, rateLimitInfo)
  }
}

Source: minds-ui/apps/api-service/app/api/v1/regions/route.ts:74.

Response and error branches

Literal HTTP statuses in the route: 403, 500. Shared management error classes are defined in Errors and responses.

new RateLimitExceededError(evaluation.retryAfter ?? 60)

Source: minds-ui/apps/api-service/app/api/v1/regions/route.ts:45.

apiSuccess<ListRegionsResponse>(result)

Source: minds-ui/apps/api-service/app/api/v1/regions/route.ts:54.

apiError(error, requestId)

Source: minds-ui/apps/api-service/app/api/v1/regions/route.ts:58.

apiError(
      new ApiError(500, 'INTERNAL_ERROR', 'Failed to list regions'),
      requestId
    )

Source: minds-ui/apps/api-service/app/api/v1/regions/route.ts:62.

new ApiError(500, 'INTERNAL_ERROR', 'Failed to list regions')

Source: minds-ui/apps/api-service/app/api/v1/regions/route.ts:63.

new RateLimitExceededError(evaluation.retryAfter ?? 60)

Source: minds-ui/apps/api-service/app/api/v1/regions/route.ts:98.

apiCreated<RegionResponse>(region)

Source: minds-ui/apps/api-service/app/api/v1/regions/route.ts:103.

apiError(error, requestId)

Source: minds-ui/apps/api-service/app/api/v1/regions/route.ts:107.

apiError(
      new ApiError(500, 'INTERNAL_ERROR', 'Failed to create region'),
      requestId
    )

Source: minds-ui/apps/api-service/app/api/v1/regions/route.ts:111.

new ApiError(500, 'INTERNAL_ERROR', 'Failed to create region')

Source: minds-ui/apps/api-service/app/api/v1/regions/route.ts:112.

Service dependencies

minds-ui/apps/api-service/lib/api-response.ts
minds-ui/apps/api-service/lib/validation.ts
minds-ui/apps/api-service/types/region.ts
minds-ui/apps/api-service/types/errors.ts
minds-ui/apps/api-service/lib/services/auth-context.ts
minds-ui/apps/api-service/lib/services/region-service.ts
minds-ui/apps/api-service/lib/services/rate-limit.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/api-service/app/api/v1/regions/route.ts. SHA-256: 8b044bf267959b329ef6b0f631594966f8b903f5da3bef5f291b4d929c06d751.

/api/v1/regions (management)

On this page