You can adjust the CDP Server settings used for API Server HTTP and HTTPS connections.
Follow the instructions below to configure the API Server options in CDP.
1. Click on "Configuration" in the Main Menu to open the "Configuration" window.
|| Advanced Edition || Enterprise Edition ||
| !adva.png! | !ente.png! |
2. In the "Configuration" menu, click on "API Server Options."
!api-server-menu.png!
3. The "API Server Options" window opens.
!api-server-screen.png!
4. You can define the following options:
h6. HTTP Options
* *Enabled* \- Select the checkbox to enable HTTP for API Server.
* *Port* \- Enter the port that the API HTTP Server will listen on in the provided text box. Default port is 9080.
* *Max Connections* \- Define the largest simultaneous number of API connections via HTTP protocol. Default value is 100.
\\
h6. SSL Options
* *Enabled* \- Select the checkbox to enable the HTTPS connection for the API Server.
* *Port* \- Enter the port the API HTTPS server will listen on in the text box. Default port is 9443.
* *Max Connections* \- Define the largest simultaneous number of API connections via HTTPS protocol. Default value is 100.
* *Keystore Path* \- Contains the full path to the file with the SSL key. Example: {color:blue}/usr/sbin/r1soft/bin/../conf/keystore{color}.
4. Click on "Save."
!244.png!
5. The "Restart Web Server" window opens.
!api-qw.png!
Changing the API server options requires the Web Server to be restarted.
{note:title=Notice}Restarting will not interrupt any running tasks.
{note}
6. Click "Yes" to restart the Web Server.
!api-y.png!
{info:title=Notes}
* If you change your port number, browse to the new URL manually.
* If you disabled a protocol, you will need to switch to the other protocol manually. Otherwise, the page automatically redirects you when the server resumes.
* If the Web Server does not restart in about 30 seconds, check server logs for errors.
{info}
{excerpt:hidden=true}Instructions on how to configure API Server Options in CDP.{excerpt}
Follow the instructions below to configure the API Server options in CDP.
1. Click on "Configuration" in the Main Menu to open the "Configuration" window.
|| Advanced Edition || Enterprise Edition ||
| !adva.png! | !ente.png! |
2. In the "Configuration" menu, click on "API Server Options."
!api-server-menu.png!
3. The "API Server Options" window opens.
!api-server-screen.png!
4. You can define the following options:
h6. HTTP Options
* *Enabled* \- Select the checkbox to enable HTTP for API Server.
* *Port* \- Enter the port that the API HTTP Server will listen on in the provided text box. Default port is 9080.
* *Max Connections* \- Define the largest simultaneous number of API connections via HTTP protocol. Default value is 100.
\\
h6. SSL Options
* *Enabled* \- Select the checkbox to enable the HTTPS connection for the API Server.
* *Port* \- Enter the port the API HTTPS server will listen on in the text box. Default port is 9443.
* *Max Connections* \- Define the largest simultaneous number of API connections via HTTPS protocol. Default value is 100.
* *Keystore Path* \- Contains the full path to the file with the SSL key. Example: {color:blue}/usr/sbin/r1soft/bin/../conf/keystore{color}.
4. Click on "Save."
!244.png!
5. The "Restart Web Server" window opens.
!api-qw.png!
Changing the API server options requires the Web Server to be restarted.
{note:title=Notice}Restarting will not interrupt any running tasks.
{note}
6. Click "Yes" to restart the Web Server.
!api-y.png!
{info:title=Notes}
* If you change your port number, browse to the new URL manually.
* If you disabled a protocol, you will need to switch to the other protocol manually. Otherwise, the page automatically redirects you when the server resumes.
* If the Web Server does not restart in about 30 seconds, check server logs for errors.
{info}
{excerpt:hidden=true}Instructions on how to configure API Server Options in CDP.{excerpt}