Configuring HTTPS Port

Edit online

About this task

This section provides information about configuring HTTPS ports available in API Gateway.

To configure the HTTPS port

Procedure

  1. In Command Central, navigate to Environments > Instances > All > API Gateway > Configuration.
  2. Select Ports from the drop-down menu.
  3. Click HTTPS Port Configuration.
  4. Select Yes in the Enable field in the Basic configuration section.
  5. Provide valid port numbers in the Port and Alias field of the HTTPS listener configuration section.
  6. Select the required Keystore and Truststore from the available list of options.
  7. Optionally, click Test to verify your configuration.
  8. Save your changes.
  9. Restart the API Gateway instance.
    The port is created and enabled.

Configuring HTTPS Port using Template

Edit online

About this task

You can configure port by using the following Command Central template: 

sagcc exec templates composite import -i httpPort.yaml

sagcc exec templates composite apply httpPortAlias

Sample ports configuration template 

alias: httpsPortAlias
description: API Gateway https port creation

layers:
  runtime:   
    templates: httpsPort-Template

templates:
  httpsPort-Template:
    products:
      integrationServer:
        apigateway:
          configuration:
            OSGI-IS_apigateway-WmAPIGateway:
              COMMON-PORTS:
                COMMON_PORTS_HTTPS:
                  Port:
                    '@primary': 'false'
                    '@alias': HTTPS
                    Enabled: 'true'
                    CustomType: HTTPSListener@5558
                    Number: '5558'
                    Protocol: HTTPS
                    Backlog: '200'
                    KeepAliveTimeout: '20000'
                    ThreadPool:
                    SSL:
                      KeystoreAlias: pgkey
                      KeyAlias: partner2
                      TruststoreAlias: trust
                    ExtendedProperties:
                      Property:
                      - '@name': DIS_PORT
                        $: '5558'
                      - '@name': DIS_PORT_ALIAS
                        $: HTTPS
                      - '@name': DIS_PROTOCOL
                        $: HTTPS
                      - '@name': DIS_ENABLE
                        $: 'true'
                      - '@name': DIS_PRIMARY
                        $: 'false'
                      - '@name': UseJSSE
                        $: 'true'
                      - '@name': listenerType
                        $: Regular
                      - '@name': Type
                        $: Regular
                      - '@name': DIS_TYPE
                        $: Regular
                      - '@name': PortType
                        $: HTTPS
                      - '@name': PortDescription
                        $: https ports
                      - '@name': ClientAuth
                        $: require
                      - '@name': IdleTimeout
                      - '@name': MaxConnections
                      - '@name': ProxyHost
                      - '@name': Username
                      - '@name': Password
provision:
  default:
    runtime: ${nodes}