Changing the API Data Store HTTP Port

About this task

The default HTTP port that clients use to make calls to API Gateway Data Store is 9240. Use the following procedure to change the HTTP port number.

Note: You cannot add a new port from this section. You can only edit existing port details.

To change the API Data Store HTTP port

Procedure

In Command Central, navigate to Environments > Instances > All > API Data Store > Configuration.
Select Ports from the drop-down menu.
Click http port and specify the HTTP port number in the Port Number field.
Optionally, click Test to verify your configuration.
Save your changes.
Stop API Gateway instance, if it is running.
Update the Elasticsearch entry in the config.properties file located at SAG_Installdir/IntegrationServer/instances/tenant_name/packages/WmAPIGateway/config/resources/elasticsearch/.
Instead of changing the entries manually you can include these changes in one of the following ways:
- Through the externalization of configurations feature. For details, see Externalizing Configurations
- Through Command Central. For details, see Configuring Elasticsearch Connection Settings.
Restart the API Gateway instance.

Changing the API Data Store HTTP Port using Template

Edit online

About this task

You can change the HTTP Port details using the following Command Central template:

sagcc exec templates composite import -i ports.yaml

sagcc exec templates composite apply sag-apigw-datastore-port nodes=local port.alias=port_alias port.number=port_number

Sample ports configuration file:

alias: sag-apigw-datastore-port
description: API Gateway Data Store Port configuration

layers:
  runtime:
    templates:
     - apigw-datastore-port

templates:
  apigw-datastore-port:
    products:
      CEL:
        default:
          configuration:
            CEL:
              COMMON-PORTS:
                COMMON-PORTS-defaultHttp:
                  Port:
                    '@alias': ${port.alias}
                    Number: ${port.number}
                    Protocol: HTTP
                  
                  
provision:
  default:
    runtime: ${nodes}