Salesforce

Server Settings (Magic xpi 4.12)

« Go Back

Information

 
Created BySalesforce Service User
Approval Process StatusPublished
Objective
Description

Server Settings (Magic xpi 4.12)

The API Management server provides the API Gateway as well as the API Management Dashboard.

The Server Settings dialog box lets the user add settings for the API Management server. The following settings can be added. Magic xpi will connect to the API Management server based on the settings provided. (The parameters in bold are mandatory.)

Name

Description

Dashboard Host

The Dashboard Host URL to connect to the API Dashboard.

e.g. http://<ip_address> or http://<hostname>

Dashboard Port

The Dashboard Port number to connect to the API Dashboard. Required if the value is other than 80.

e.g. 8080.

Gateway Host

The Gateway Host URL to connect to the API Gateway.

e.g. http://<ip_address> or http://<hostname>

Gateway Port

The Gateway Port number to connect to the API Gateway. Required if the value is other than 80.

e.g. 8080.

Organization ID

The Organization ID of the API Management server. This ID can be accessed by the user from the Edit User page of the Tyk Dashboard.

Dashboard Auth ID

The Authentication ID of the Dashboard. This ID can be accessed by the user from the Edit User page of the Tyk Dashboard.

Admin Auth ID

The Authentication ID for the Admin of the API Manager. This can be provided only by the Tyk Dashboard administrator and not available on the Dashboard itself.

The Server Settings dialog box also gives you the following buttons:

Button

Description

Validate

The Validate button verifies the connection to the API Management server.

If the connection is successful, the Success message will be shown and in case of failure, an Error message will be shown.

OK

Click the OK button to save the Server Settings.

Cancel

Click the Cancel button to cancel the Server Settings configuration.

Since version: 4.12

Reference
Attachment 
Attachment