Configs
The following operations can be performed on the different configurations items:
GET /configs/verify/{item}
This API is used to verify a config item value.
Parameters
Name | Description | Parameter Type | Data Type |
item | The config item name to verify | path | string |
Example to verify email config items
curl -X GET -u admin:admin "https://localhost:9502/rest/v2/configs/verify/_server_config_email_smtpHost"
Example to verify email config items (as ldap user who has BD_ADMIN rights)
curl -X GET -u user@ldapDomain:password "https://localhost:9502/rest/v2/configs/verify/_server_config_email_smtpHost"
GET /configs/version
This API is used to get server version information.
Parameters
None
Example to get server version information
curl -X GET -u admin:admin "https://localhost:9502/rest/v2/configs/version"
GET /configs/verify/{item}
This API is used to get a config item value. Only the BD Admin can invoke this
Parameters
Name | Description | Parameter Type | Data Type |
item | the config item name to be modified | path | string |
Example to get if enable refresh sites metadata when bd server starts up
curl -X GET -u admin:admin "https://localhost:9502/rest/v2/configs/refreshSitesOnStartup"
Example to get if enable refresh sites metadata when bd server starts up (as ldap user who has BD_ADMIN rights)
curl -X GET -u user@ldapDomain:password "https://localhost:9502/rest/v2/configs/refreshSitesOnStartup"
PUT /configs/{item}
This API is used to change a config item value. Only the BD Admin can invoke this
Parameters
Name | Description | Parameter Type | Data Type |
item | the config item name. | path | string |
value | | formData | string |
Example to enable refresh sites metadata when bd server starts up
curl -X PUT -u admin:admin "https://localhost:9502/rest/v2/configs/refreshSitesOnStartup" -d "value=true"
Example to enable refresh sites metadata when bd server starts up (as ldap user who has BD_ADMIN rights)
curl -X PUT -u user@ldapDomain:password "https://localhost:9502/rest/v2/configs/refreshSitesOnStartup" -d "value=true"
Example to enable refresh sites metadata when bd server starts up (X-HTTP-Method-Override)
curl -X POST -u admin:admin "https://localhost:9502/rest/v2/configs/refreshSitesOnStartup" -H "X-HTTP-Method-Override:PUT" -d "value=true"