Configuring REST services

If you have a stand-alone server environment, Representational State Transfer (REST) services are configured and enabled automatically. For other environments, use the administrative console to configure the REST services.

About this task

If you want widgets to be available in dashboards, you must configure the REST services for those widgets.

You can configure all REST services for a specific server or cluster. Or, you can select individual services to configure. You can manage individual service configuration by viewing all services for a service provider or by viewing all services for your environment.

REST services are typically exposed on the REST Gateway. Some REST services are implemented by their dedicated system application. The REST Services Gateway application enables common system REST services. The REST Services Gateway application is created when REST services are configured.

Make sure that the REST Services Gateway application is deployed for the particular scope that you are using. You configure REST services for the REST Services Gateway and other service providers by using the REST service providers configuration administrative console page. In order for some widgets to be enabled, you must do this on the scope where the widgets are running. The REST Services Gateway application is deployed to a specific scope when you add it on the REST service providers configuration administrative console page.

For clustered environments, all administration and configuration tasks for REST services are completed on the REST Services Gateway Dmgr application on the deployment manager. The REST Services Gateway Dmgr application is used with the following widgets:
  • Module Browser
  • Module Assembly
  • Module Properties
  • Proxy Gateway
  • Module Health
  • System Health
  • Configuring all REST services on the administrative console
    Configure all Representational State Transfer (REST) services for your environment by using the REST service administrative console page.
  • Configuring REST services using the command line
    All widgets required for your product are installed with the Business Space component. The Representational State Transfer (REST) services for widgets must be configured, enabled, and registered with Business Space before your team can use dashboards. If you do not use the REST Services administrative console page, use the updateRESTGatewayService command.
Parent topic: Configuring dashboards for network deployment environments