Configuration Service
This REST service is used for various configurations of files such as get, add, update, and delete.
Get supported files metadata
Method: HTTP GET
Endpoint: http://<host_address>:<port_number>/v1/configuration/configFilesMetadata
Parameters: No parameters
Save supported files metadata
Method: HTTP POST
Endpoint: http://<host_address>:<port_number>/v1/configuration/configFilesMetadata
Parameters: applicationId
, applicationDescription
, appProperties
, and configurationFiles
in the request body.
Delete supported files metadata
Method: HTTP DELETE
Endpoint: http://<host_address>:<port_number>/v1/configuration/configFilesMetadata/{applicationId}
Parameters: applicationid (Select the value from the drop-down list)
Get Application Properties by Application ID
Method: HTTP GET
Endpoint: http://<host_address>:<port_number>/v1/configuration/{applicationid}
Parameters: applicationid (Select the value from the drop-down list)
Update Application Properties for Application ID
Method: HTTP PUT
Endpoint: http://<host_address>:<port_number>/v1/configuration/{applicationid}
Parameters: applicationid (Select the value from the drop-down list)
Save Application Properties for Application ID
Method: HTTP POST
Endpoint: http://<host_address>:<port_number>/v1/configuration/{applicationid}
Parameters: applicationid (Select the value from the drop-down list)
Delete Application Properties for Application ID
Method: HTTP DELETE
Endpoint: http://<host_address>:<port_number>/v1/configuration/{applicationid}
Parameters: applicationid (Select value from the drop-down)
Replicate Tenant Properties
This API is used to replicate the tenant-specific properties through the REST service. Previously, properties could only be replicated through the Configurator UI.
Method: HTTP POST
Endpoint: http://<host_address>:<port_number>/v1/configuration/replicateTenantProperties/{sourceTenantId}
Parameters: sourceTenantId
Get list of applications available with Configurator
Method: HTTP GET
Endpoint: http://<host_address>:<port_number>/v1/configuration/availableApplications
Parameters: No parameters
Download Configuration File for Application ID
Method: HTTP GET
Endpoint: http://<host_address>:<port_number>/v1/configuration/configFile/{applicationId}
Parameters: applicationid (Select value from the drop-down)
Upload Configuration File for Application ID
This API is used to upload config files into the configuration table in the admin database through the REST service.
Method: HTTP POST
Endpoint: http://<host_address>:<port_number>/v1/configuration/configFile/{applicationId}
Select the applicationid
from the drop-down list, click Choose File to browse, select the file that you want to upload, and click Execute.
Configurator notification API
This API generates notification for server side events whenever there is a change (add, update, or delete) in application properties for any application.
Method: HTTP GET
Endpoint: http://<host_address>:<port_number>/v1/configurator/events
Parameters: No parameters