Skip to main content
Skip table of contents


Services make APIs accessible to users. A service, through its assigned Access Control Policy, determines which users are allowed access. Furthermore, a service can limit which server TCP/IP ports will be used for the service. A service may be comprised of a single APIs.

Services are managed through the LightWave Server Console. After you have defined an API and created an Access Control Policy, you can deploy them as a Service.

When a service is deployed, a snapshot is taken of the API definition and any dictionaries associated with the API. This allows the origin API definition and dictionaries to be modified without affecting the deployed service.

To deploy a new service:

  1. Select "Services" from the console menu.
  2. Click the '+' icon to add (deploy) a new service.
  3. Enter a name and description for the service.
  4. Supply a version identifier for the service.
  5. Select the API to be exposed by the service.
  6. Select the appropriate Access Control Policy from the list.
  7. If desired, restrict the TCP/IP ports at which API requests will be accepted.
  8. Enable the service and save. The API associated with the service is immediately available.

To redeploy a service:

Redeploying a service refreshed the service from the origin API definition and dictionaries.

  1. Select "Services" from the console menu.
  2. Select the Service you wish to redeploy.
  3. Click the 
     icon to open refresh confirmation dialog.
  4. Click OK to complete the refresh or Cancel to exit without refreshing.

To export a service:

Exporting a service creates a service package file that contains the API and all related dictionaries for a service. The service package can then be imported into another server instance for deployment.

  1. Select "Services" from the console menu.
  2. Select the Service you wish to export.
  3. Click the 
     icon to open the system file browser.
  4. Select a download location for the file and click Save to download the Service package file.

To import a Service:

  1. Click the 
     icon to open the upload dialog.
  2. Click the 
     to open a file browser and select the Service package file.
  3. Enter the name of the Service.
  4. If appropriate, select the checkbox to replace an existing Service with the same name.
  5. Click Upload.
  6. Complete the service configuration by selecting an Access Control Policy and optionally enabling the Service.


JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.