Function: createManagementApi()

@roomful/relay

---

@roomful/relay / createManagementApi

Function: createManagementApi()

createManagementApi(options): (request, response) => Promise<void>

Defined in: packages/relay/src/management/api.ts:610

Creates an HTTP request handler for the management REST API.

The returned handler can be mounted into the relay’s existing HTTP server or used standalone. It handles CORS preflight, route matching, JSON parsing/validation, and sends JSON responses.

Endpoints:

GET    /prefix/projects                    List projects
POST   /prefix/projects                    Create project
GET    /prefix/projects/:projectId         Get project
PUT    /prefix/projects/:projectId         Update project
DELETE /prefix/projects/:projectId         Delete project
GET    /prefix/projects/:projectId/rooms              List rooms
POST   /prefix/projects/:projectId/rooms              Create room
GET    /prefix/projects/:projectId/rooms/:roomId      Get room
DELETE /prefix/projects/:projectId/rooms/:roomId      Delete room
GET    /prefix/projects/:projectId/quota              Get quota
PUT    /prefix/projects/:projectId/quota              Set quota
GET    /prefix/projects/:projectId/usage              Get usage

Parameters

options

ManagementApiOptions

The management API configuration.

Returns

A function that handles an incoming HTTP request.

(request, response): Promise<void>

Parameters

request

IncomingMessage

response

ServerResponse

Returns

Promise<void>