Skip to main content

Configuration Parameters

Sl#Parameter NameDescriptionAllowed Values/Examples
1.ALLOW_SAFE_DELETEAllow deletion of table rows without a filter criteria.
  • true(default)
  • false
2.DB_IDLogical Identifier of the database to be used in API URL. This is not the name of the database.
  • db(default)
3.DB_URLDatabase connection URL in JDBC format.
  • jdbc:mysql://DB_SERVER_HOST:DB_PORT/DB_NAME (MySQL)
  • jdbc:postgresql://DB_SERVER_HOST:DB_PORT/DB_NAME (PostgreSQL)
4.DB_USERDatabase user name-
5.DB_PASSWORDDatabase password-
6.SERVER_PORTWebserver PORT
  • 8080(default)
7.GZIP_ENABLEDWhether response compression is enabled
  • true
  • false (default)
8.GZIP_MIN_RESPONSE_SIZEMinimum "Content-Length" value in KB that is required for compression to be performed.
  • 1024(default)
9.ENABLE_DATETIME_FORMATTINGWhether to enable date time formatting in response.
  • false(default)
  • true
10.TIME_FORMATTime format
  • HH:mm:ss(default)
11.DATE_FORMATDate format
  • yyyy-MM-dd(default)
12.DATE_TIME_FORMATDate time format
  • yyyy-MM-dd HH:mm:ss(default)
13.ENABLE_AUTHEnable authentication and authorization
  • false(default)
  • true
14.AUTH_DATA_SOURCEProvide the absolute path of the auth data as a file.-
15.DEFAULT_FETCH_LIMITLimits the number of rows that will be retrieved for a read query.100
16.PROMETHEUS_EXPORT_ENABLEDEnable Monitoring with Prometheus and Grafana Observability Stack
  • false(default)
  • true
17.DATADOG_EXPORT_ENABLEDEnable Monitoring with Datadog
  • false(default)
  • true
18.DATADOG_API_KEYDatadog API Key-
19.DATADOG_APPLICATION_KEYDatadog Application Key-
20.DATADOG_EXPORT_URIDatadog export URI - this is where the data will be posted.-
21.DATADOG_EXPORT_INTERVALInterval after which the data will be scraped and posted.Default: 30s
22.INCLUDED_SCHEMASComma separated list of schemas from which the meta-data about tables will be loaded.-
23.CORS_ORIGIN_URLComma seperated list of allowed Cross Origin URLs from where requests will be sent to server.Default: *
24.CORS_HEADERS_ALLOWEDComma seperated list of Headers which will be allowed for the requests.Default: *
25.CORS_METHODS_ALLOWEDComma seperated list of Methods which will be allowed for the requests.Default: GET,POST
tip

If DB2Rest is connected to multiple databases do not use configurations 2-5. Follow the guide for connecting to multiple databases.

info

Date time format parameter is only applicable for output / response.

warning

In case request attributes, only ISO data-time formats are supported.