REST API - Instance & item setup
How to setup a REST API instance and item in SIA
If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.
The REST API SIA connector allows for performing HTTP(s) REST API calls with a remote server.
When using the REST API Connector both the instance and item have specific parameters. These parameters are required as they are needed to establish a connection and to connect to a specific endpoint.
The instance needs the following parameters to establish a connection to the remote server:
|Address (instance default)||The IP address or URL of the server to connect to.|
||The amount of time to wait for a response from the remote server, before considering it a failed connection.
| Default Headers
||The parameters to be passed to the headers of the request.
||Whether the request is a JSON type that will be added to the default headers.
The item parameters that are needed to read the connect to a remote server:
||The endpoint for a specific request.
||Additional header settings to be added to the HTTP request.
||The request type to use (POST, PUT, GET, DELETE).
Optional request data to add to the specific request as the default payload (eg. login information).