TIBCO Spotfire® Server and Environment - Installation and Administration

config-web-service-api

Configures the public Web Service API.

config-web-service-api 
[-c value | --configuration=value] 
[-b value | --bootstrap-config=value] 
[-s <true|false> | --soap-enabled=<true|false>] 
[-r <true|false> | --rest-enabled=<true|false>] 
[-d <true|false> | --online-doc-enabled=<true|false>] 
[-w <true|false> | --wsdls-require-auth=<true|false>]

Overview

Use this command to configure the public Web Service API (both SOAP and REST services). When none of the arguments (apart from --configuration and --bootstrap-config) are provided, the command displays the current configuration. To use the API, an OAuth 2.0 client must be registered using the register-api-client command.

Options

Option Optional or Required Default Value Description
-c value
--configuration=value
Optional configuration.xml The path to the server configuration file.
-b value
--bootstrap-config=value
Optional none The path to the bootstrap configuration file. See Bootstrap.xml file for more information about this file.
-s <true|false>
--soap-enabled=<true|false>]
Optional none Specifies whether the public SOAP Web Service API should be enabled.
-r <true|false>
--rest-enabled=<true|false>]
Optional none Specifies whether the public REST Web Service API should be enabled.
-d <true|false>
--online-doc-enabled=<true|false>
Optional none Specifies whether the online API documentation should be enabled.
-w <true|false>
--wsdls-require-auth=<true|false>
Optional none Specifies whether the WSDL files for the SOAP API should be available without authentication.