This section includes the definitions for the arguments and parameters which make up the Opcodes and Commands of the REST API.
1.1. General
The table defines the General parameters that comprise the methods of the SoftNAS API.
Property
Description
Note/Data Type
username
username
eg. softnas
The user name is the Linux user name that will be used to log into SoftNAS via the API.
Alphanumeric string
password
The user's password.
The user's password for the username used to log into SoftNAS via the API.
Integer
-s (number)
Session ID for the client session with SoftNAS.
Every new login to SoftNAS via the API will receive a unique session id. The Session ID is returned from the SoftNAS server and indicates the session id which will be used for subsequent requests, and for storing information (eg. cookies).
It is also possible to specify the session id for a request using this parameter. If session id is left unspecified, SoftNAS will use the PPID (Parent Process ID) as Session ID.
Integer
--session_id (number)
Session ID for the client session with SoftNAS.
Every new login to SoftNAS via the API will receive a unique session id. The Session ID is returned from the SoftNAS server and indicates the session id which will be used for subsequent requests, and for storing information (eg. cookies).
It is also possible to specify the session id for a request using this parameter. If session id is left unspecified, SoftNAS will use the PPID (Parent Process ID) as Session ID.
Integer
-b (url)
Base URL:
Same as the location of the SoftNAS StorageCenter administrative user-interface.
i.e : “-b https://nas01.mydomain.com/softnas”
By default base url is “https://localhost/softnas”
URL string
--base_url (url)
Base URL:
Same as the location of the SoftNAS StorageCenter administrative user-interface.
i.e : “-b https://nas01.mydomain.com/softnas”
By default base url is “https://localhost/softnas”
URL string
-t
Pretty Print:
Causes the JSON return string from the API to be formatted with newlines so that it word wraps nicely on a display.
CLI Command line switch.
--pretty_print
Pretty Print:
Causes the JSON return string from the API to be formatted with newlines so that it word wraps nicely on a display.
CLI Command line switch
success
Returns true or false depending on success or failure of the API request for issued command.
boolean
start
Start position for the query results. This property can be used when results must be returned using multiple pages. The start position instructs the server to begin returning additional results from a specific item number.
Default: 0
integer
limit
For paged query results, this parameter is used to limit request results to a specific number of items. For example, when obtaining list of storage pools, it is possible to limit the amount of results that are returned. Default:999
