Configuration options for creating a REST API instance RestOptions

Deprecated

Use uploadDirectoryConfig instead. Directory for file uploads

Deprecated

Use staticPaths instead. Static file serving options

Properties

Property	Type	Description
adminUser?	AdminUser	Admin user configuration
authTriggers?	CmsTrigger[]	Authentication triggers
collectionDefinitions?	CollectionDefinition[]	Custom collection definitions
cors?	Options	CORS configuration options
dontListen?	boolean	Don't start the server
fileTriggers?	CmsTrigger[]	File handling triggers
functions?	object[]	Custom API functions
keypair?	KeyPair	JWT keypair for authentication
koaBodyOptions?	any	Options for koa-body middleware
modulesPath?	string	Path to custom modules directory
mongo?	MongoOptions	MongoDB connection options
onAfterInit?	(koaApp) => void	Hook called after initialization
onBeforeInit?	(koaApp) => void	Hook called before initialization
permissionGroups?	PermissionGroup[]	Custom permission groups
port?	number	Port to listen on
staticPath?	StaticPathOptions | StaticPathOptions[]	-
staticPaths?	StaticPathOptions[]	Array of static file serving configurations
uploadDirectory?	string	-
uploadDirectoryConfig?	StaticPathOptions	Upload directory configuration with static path info
verificationCodeGeneratorMethod?	() => string	Custom verification code generator