Table of Contents
...
By default, the SOS controller’s REST API runs at the controller’s IP on TCP port 8080. An HTTP client can be used to leverage the API. The popular utility curl is used throughout this document as an example HTTP client. For more information on curl, please refer to curl’s documentation. The following is a general example on how to use curl:
| Code Block | ||
|---|---|---|
| ||
curl http://<controller-ip>:<tcp-port>/<uri-path> -X <http-command> -d ‘<data'<data-string>’string>' |
where
- <controller-ip> is the IP address of the SOS controller
- <tcp-port> is the TCP port on which the REST server is running (default of 8080)
- <uri-path> is the URI of the API
- <http-command> is the HTTP command to use
- <data-string> is the (optional) data to send to the API
...