Spotfire Server REST APIs

These web services APIs use REST technology to manage administrative tasks programmatically.

API for executing Automation Services

This API makes it possible to run Automation Services jobs.

Library Upload API

This API makes it possible to upload SBDF files to the Spotfire library.

The Library Upload API contains the following rate limit capabilities. These configuration properties can be set by using the set-config-prop command.

To set the maximum number of ongoing upload jobs per client, use the public-api.library.upload.limit.max-concurrent-jobs-per-client parameter. Default: 10.
To set the maximum number of ongoing upload jobs allowed per server cluster, use the public-api.library.upload.limit.max-concurrent-jobs parameter. Default: 1000.
To set the maximum size (in bytes) for an item to be uploaded, use the public-api.library.upload.limit.max-upload-size parameter. Default: 2 GB.

For more information, see set-config-prop and Executing commands on the command line.

The REST API Reference is available at https://docs.tibco.com/products/tibco-spotfire-server.

Note: These APIs do not use HTTP sessions so there is no need to maintain session cookies.

Additional resources

The following resources are available if online API documentation is enabled. (This is enabled by default, but can be toggled on and off by using the config-web-service command.)

An interactive documentation page is available on a running server at this address:
https://server.example.com/spotfire/api/swagger-ui.html
An Open API (Swagger) definition of the REST APIs can be obtained on a running server at this address:
https://server.example.com/spotfire/api/v2/api-docs?group=<group-name>

where <group-name> is API-specific (see the documentation for the respective API). This can be used for creating client stubs.

Setup

Before using these APIs, you must complete this task: Register an OAuth 2.0 API client.

Optionally, you may want to configure the APIs; see Configure Spotfire Server APIs.