Gate Object
Object representing settings of main, session or management gate
Field
|
Type
|
Description
|
Default value
|
url
|
string
|
Gate URL, REQUIRED for Main gate
Unified resource location which will be used to listen incoming requests.
Format (one of):
- http://<host_name>[:port]
- https://<host_name>[:port]
- file://<IFS file>
i2Rest can listen http://, https:// and file:// urls.
With http(s)://, i2Rest server will not distinguish the host name, the value of the port number is only taken into account, i.e. http://api.i2rest.com and http://www.i2rest.com are equal in terms of listener. With such addresses, i2Rest server will start listening on port :80 of current IBM i server.
With file://, i2Rest server will listen incoming connections using stream sockets at specified path
Unix stream sockets are available only for clients of the same IBM i server with this i2Rest server instance.
If gate URL is not specified, this gate of i2Rest server will open unix stream socket based on temporary file at /tmp directory
|