Using the Web Services

By default, web services are turned off. Use the StorNext GUI to enable or disable the web service, set the protocol (HTTP or HTTPS), and control authentication. By default, version 2 web services are turned off (see Enable Web Services).

The table below describes the allowed web service options.

Table 1: Allowed web service options

Option

Protocol

Description

Protocol

HTTP

Allow web services over HTTP.

HTTPS

Allow web services over HTTPS.

HTTP or HTTPS

Allow web services over HTTP or HTTPS.

Authentication

Off

No authentication is required to use web services.

User

A username and password must be provided. The user is setup in the StorNext GUI.

Below is an example of a URL using the HTTP protocol and user authentication.

Note: URL examples include multiple lines for clarity; your URLs will be a single line.

https://<<SERVER>>/sws/v2/report/fsqueue/media
?username=wsuser
&password=<<password>>
&request=1928784996
&format=xml

All examples are based on a protocol of HTTPS and no authentication.

Description for Num in the Parameters Tables

The Num field in the parameters table displays if the parameter is a single value or a list of values can be passed.

If the parameter only accepts one value, 1 is used for Num. If a list of values is allowed, N is used for Num.

An example of a web service which accepts a list of values is illustrated below.

https://<<SERVER>>/sws/v2/file/fsfileinfo

?file=/stornext/snfx1/smp2data/foobar0

&file=/stornext/snfx1/smp2data/foobar1