Installation and Execution

There are different ways to install the Web API service. First, the service may be installed using the Windows Installer. The service may also be installed using command line arguments. Supported command line arguments are described in the following section.

Please visit the dedicated system requirements page for a more detailed description of required minimum hardware and operating system to install and run the Web API.

Command line arguments

Action	Options	Description
help		Provides information about available actions and options.

-i		Install the Web API as a service.
	corehost	Specifies the Core’s host address, by default localhost
	coreport	Specifies a particular setting for the Core Service Port, by default 6512.
	instance	Optional, specifies the instance name for the Web API.
	profile	API User profile which is used in the communication with the Core.
	pwd	API User password which is used in the communication with the Core.
	coreencryption	Specifies the encryption mode of the connection to the Core. Options are "TLS" (default) or "none".

-e		Executes the Web API as a console application.
	auth	Contains the credentials for the Web API account. (used when installed as a service.)
	corehost	Specifies the Core’s host address, by default localhost
	coreport	Specifies a particular setting for the Core Service Port, by default 6512.
	oid	Specifies the 'Web API Server' object ID to link to.
	profile	API User profile which is used in the communication with the Core.
	pwd	API User password which is used in the communication with the Core.
	service	(Default: 0) Value 1 indicates the Web API is started as a Windows Service.
	coreencryption	Specifies the encryption mode of the connection to the Core. Options are "TLS" (default) or "none".

-r		Removes the 'Web API' Windows service.
	instance	Optional, specifies the instance name of the Windows service to remove, by default "Web API"

Action

Options

Description

help

Provides information about available actions and options.

-i

Install the Web API as a service.

corehost

Specifies the Core’s host address, by default localhost

coreport

Specifies a particular setting for the Core Service Port, by default 6512.

instance

Optional, specifies the instance name for the Web API.

profile

API User profile which is used in the communication with the Core.

pwd

API User password which is used in the communication with the Core.

coreencryption

Specifies the encryption mode of the connection to the Core. Options are "TLS" (default) or "none".

-e

Executes the Web API as a console application.

auth

Contains the credentials for the Web API account. (used when installed as a service.)

corehost

Specifies the Core’s host address, by default localhost

coreport

Specifies a particular setting for the Core Service Port, by default 6512.

oid

Specifies the 'Web API Server' object ID to link to.

profile

API User profile which is used in the communication with the Core.

pwd

API User password which is used in the communication with the Core.

service

(Default: 0) Value 1 indicates the Web API is started as a Windows Service.

coreencryption

Specifies the encryption mode of the connection to the Core. Options are "TLS" (default) or "none".

-r

Removes the 'Web API' Windows service.

instance

Optional, specifies the instance name of the Windows service to remove, by default "Web API"

Command line options have the prefix '--'.

Example command to install the Web API as a Windows service.

 inmationWebAPI.exe -i --corehost localhost --coreport 6512 --profile webapi --pwd password

After installation a Web API Server Object is automatically created in the Server Model. Only the first Web API Server object in the Server Model will automatically be enabled after creation.

Making Changes to an already installed Web API service

To change the command line of a Web API service, it is recommended to first remove the service and then reinstall it. This way it is possible to change the credentials with which Web API connects to the Core.

 inmationWebAPI.exe -r

If an instance name was specified at the time of installation then care must be taken to include the instance option in the command line with the correct instance name.

 inmationWebAPI.exe -r --instance instancename

The service can be reinstalled with new profile credentials:

 inmationWebAPI.exe -i --profile new_profile --pwd new_password

If replacing a previously installed Web API service, be sure to include the same instance name and corehost/coreport parameters used in the initially installed service.