Search

Installation and Configuration

Version 23.0.9145

Installation and Configuration

This section outlines the process for installing and configuring CData API Server for your platform.

System Requirements for CData API Server

This section provides the minimum system requirements that API Server requires.

Microsoft Windows

  • Windows 10/Windows Server 2016 or later: To use earlier versions of Windows, you must host the application in Microsoft IIS.

  • .NET Framework 4.5 or later

  • 1 GB RAM required (2+ GB RAM recommended)

UNIX/ Mac

  • Java version 11 or later

  • Java servlet container (for example, Apache Tomcat, JBoss, Oracle WebLogic, IBM WebSphere, or Eclipse Jetty)

  • 1 GB RAM required (2+ GB RAM recommended)

Internet Connection

If you configure the application to connect with external systems, you might need the following resources:

  • a persistent internet connection

  • an external IP address for the system that runs the application

  • firewall/proxy access for communication with the external system

Installation Steps

Download the latest version of API Server and follow the installation steps below for your operating system.

.NET Edition

Run the API Server setup.exe file and follow the installation steps. When the setup and installation completes, see .NET Edition for information about running and configuring the server.

Cross-Platform Edition

The Java setup file ships in a compressed archive that is named CDataAPI Server.zip. Extract the contents of the archive to your installation directory. Then, see Cross-Platform Edition for information about running and configuring the server.

Installing CData API Server as a Service (Optional)

You can install API Server as a service on Linux platforms. To do so, execute the service.sh script with root privilges in the application-installation directory. This file is a service installation script that enables you to start, stop, and restart the embedded Jetty server as a Linux service.