Name | Type | Description |
---|---|---|
accountLockout | AccountLockoutOptions | The account lockout policy for failed login attempts. |
allowClientClassCreation | Boolean | Enable (or disable) client class creation, defaults to false |
allowCustomObjectId | Boolean | Enable (or disable) custom objectId |
allowExpiredAuthDataToken | Boolean | Allow a user to log in even if the 3rd party authentication token that was used to sign in to their account has expired. If this is set to |
allowHeaders | Array.<String> | Add headers to Access-Control-Allow-Headers |
allowOrigin | String | | Sets origins for Access-Control-Allow-Origin. This can be a string for a single origin or an array of strings for multiple origins. |
analyticsAdapter | Adapter.<AnalyticsAdapter> | Adapter module for the analytics |
appId | String | Your Parse Application ID |
appName | String | Sets the app name |
auth | Object | Configuration for your authentication providers, as stringified JSON. See http://docs.parseplatform.org/parse-server/guide/#oauth-and-3rd-party-authentication |
cacheAdapter | Adapter.<CacheAdapter> | Adapter module for the cache |
cacheMaxSize | Number | Sets the maximum size for the in memory cache, defaults to 10000 |
cacheTTL | Number | Sets the TTL for the in memory cache (in ms), defaults to 5000 (5 seconds) |
clientKey | String | Key for iOS, MacOS, tvOS clients |
cloud | String | Full path to your cloud code main.js |
cluster | Number | | Run with cluster, optionally set the number of processes default to os.cpus().length |
collectionPrefix | String | A collection prefix for the classes |
convertEmailToLowercase | Boolean | Optional. If set to |
convertUsernameToLowercase | Boolean | Optional. If set to |
customPages | CustomPagesOptions | custom pages for password validation and reset |
databaseAdapter | Adapter.<StorageAdapter> | Adapter module for the database; any options that are not explicitly described here are passed directly to the database client. |
databaseOptions | DatabaseOptions | Options to pass to the database client |
databaseURI | String | The full URI to your database. Supported databases are mongodb or postgres. |
defaultLimit | Number | Default value for limit option on queries, defaults to |
directAccess | Boolean | Set to |
dotNetKey | String | Key for Unity and .Net SDK |
emailAdapter | Adapter.<MailAdapter> | Adapter module for email sending |
emailVerifyTokenReuseIfValid | Boolean | Set to |
emailVerifyTokenValidityDuration | Number | Set the validity duration of the email verification token in seconds after which the token expires. The token is used in the link that is set in the email. After the token expires, the link becomes invalid and a new link has to be sent. If the option is not set or set to |
enableAnonymousUsers | Boolean | Enable (or disable) anonymous users, defaults to true |
enableCollationCaseComparison | Boolean | Optional. If set to |
enableExpressErrorHandler | Boolean | Enables the default express error handler for all errors |
encodeParseObjectInCloudFunction | Boolean | If set to |
encryptionKey | String | Key for encrypting your files |
enforcePrivateUsers | Boolean | Set to true if new users should be created without public read and write access. |
expireInactiveSessions | Boolean | Sets whether we should expire the inactive sessions, defaults to true. If false, all new sessions are created with no expiration date. |
extendSessionOnUse | Boolean | Whether Parse Server should automatically extend a valid session by the sessionLength |
fileKey | String | Key for your files |
filesAdapter | Adapter.<FilesAdapter> | Adapter module for the files sub-system |
fileUpload | FileUploadOptions | Options for file uploads |
graphQLPath | String | Mount path for the GraphQL endpoint, defaults to /graphql |
graphQLSchema | String | Full path to your GraphQL custom schema.graphql file |
host | String | The host to serve ParseServer on, defaults to 0.0.0.0 |
idempotencyOptions | IdempotencyOptions | Options for request idempotency to deduplicate identical requests that may be caused by network issues. Caution, this is an experimental feature that may not be appropriate for production. |
javascriptKey | String | Key for the Javascript SDK |
jsonLogs | Boolean | Log as structured JSON objects |
liveQuery | LiveQueryOptions | parse-server's LiveQuery configuration object |
liveQueryServerOptions | LiveQueryServerOptions | Live query server configuration options (will start the liveQuery server) |
loggerAdapter | Adapter.<LoggerAdapter> | Adapter module for the logging sub-system |
logLevel | String | Sets the level for logs |
logLevels | LogLevels | (Optional) Overrides the log levels used internally by Parse Server to log events. |
logsFolder | String | Folder for the logs (defaults to './logs'); set to null to disable file based logging |
maintenanceKey | String | (Optional) The maintenance key is used for modifying internal and read-only fields of Parse Server. |
maintenanceKeyIps | Array.<String> | (Optional) Restricts the use of maintenance key permissions to a list of IP addresses or ranges. |
masterKey | String | Your Parse Master Key |
masterKeyIps | Array.<String> | (Optional) Restricts the use of master key permissions to a list of IP addresses or ranges. |
maxLimit | Number | Max value for limit option on queries, defaults to unlimited |
maxLogFiles | Number | | Maximum number of logs to keep. If not set, no logs will be removed. This can be a number of files or number of days. If using days, add 'd' as the suffix. (default: null) |
maxUploadSize | String | Max file size for uploads, defaults to 20mb |
middleware | Union | middleware for express server, can be string or function |
mountGraphQL | Boolean | Mounts the GraphQL endpoint |
mountPath | String | Mount path for the server, defaults to /parse |
mountPlayground | Boolean | Mounts the GraphQL Playground - never use this option in production |
objectIdSize | Number | Sets the number of characters in generated object id's, default 10 |
pages | PagesOptions | The options for pages such as password reset and email verification. Caution, this is an experimental feature that may not be appropriate for production. |
passwordPolicy | PasswordPolicyOptions | The password policy for enforcing password related rules. |
playgroundPath | String | Mount path for the GraphQL Playground, defaults to /playground |
port | Number | The port to run the ParseServer, defaults to 1337. |
preserveFileName | Boolean | Enable (or disable) the addition of a unique hash to the file names |
preventLoginWithUnverifiedEmail | Boolean | Set to |
preventSignupWithUnverifiedEmail | Boolean | If set to |
protectedFields | ProtectedFields | Protected fields that should be treated with extra security when fetching details. |
publicServerURL | String | Public URL to your parse server with http:// or https://. |
push | Any | Configuration for push, as stringified JSON. See http://docs.parseplatform.org/parse-server/guide/#push-notifications |
rateLimit | Array.<RateLimitOptions> | Options to limit repeated requests to Parse Server APIs. This can be used to protect sensitive endpoints such as |
readOnlyMasterKey | String | Read-only key, which has the same capabilities as MasterKey without writes |
requestKeywordDenylist | Array.<RequestKeywordDenylist> | An array of keys and values that are prohibited in database read and write requests to prevent potential security vulnerabilities. It is possible to specify only a key ( |
restAPIKey | String | Key for REST calls |
revokeSessionOnPasswordReset | Boolean | When a user changes their password, either through the reset password email or while logged in, all sessions are revoked if this is true. Set to false if you don't want to revoke sessions. |
scheduledPush | Boolean | Configuration for push scheduling, defaults to false. |
schema | SchemaOptions | Defined schema |
security | SecurityOptions | The security options to identify and report weak security settings. |
sendUserEmailVerification | Boolean | Set to |
serverCloseComplete | function | Callback when server has closed |
serverURL | String | URL to your parse server with http:// or https://. |
sessionLength | Number | Session duration, in seconds, defaults to 1 year |
silent | Boolean | Disables console output |
startLiveQueryServer | Boolean | Starts the liveQuery server |
trustProxy | Any | The trust proxy settings. It is important to understand the exact setup of the reverse proxy, since this setting will trust values provided in the Parse Server API request. See the express trust proxy settings documentation. Defaults to |
userSensitiveFields | Array.<String> | Personally identifiable information fields in the user table the should be removed for non-authorized users. Deprecated @see protectedFields |
verbose | Boolean | Set the logging to verbose |
verifyUserEmails | Boolean | Set to |
webhookKey | String | Key sent with outgoing webhook calls |
ParseServerOptions
Properties