Table of Contents

Search

  1. Preface
  2. Introducing Administrator
  3. Organizations
  4. Licenses
  5. Ecosystem single sign-on
  6. SAML single sign-on
  7. Metering
  8. Source control and service upgrade settings
  9. Users and user groups
  10. User roles
  11. Permissions
  12. Runtime environments
  13. Serverless runtime environments
  14. Secure Agent services
  15. Secure Agent installation
  16. Schedules
  17. Bundle management
  18. Event monitoring
  19. File transfer
  20. Troubleshooting

Administrator

Administrator

Configuring API Microgateway Service

Configuring API Microgateway Service

Configure the API Microgateway Service properties when you edit a Secure Agent in Administrator.
The following image shows the API Microgateway Service properties in the
System Configuration Details
area:
The System Configuration Details area lists the API Microgateway Service properties you can configure. For each property, the list shows type, name, and value.
The following table describes the API Microgateway Service configurations:
Type
Name
Description
AGENT_RUNTIME_SETTINGS
project-name
Name of the project that stores the API configurations. You can change the name as per requirement, for example when you create a new project.
Project name must not contain the characters
/
or
/0
. If a project name includes restricted characters, the project creation fails.
AGENT_RUNTIME_SETTINGS
docker-registry-name
Name of the local Docker registry that contains all the named and tagged API Microgateway Docker images on the Secure Agent machine.
Docker image and tag names must not contain the following characters:
-
_
,
.
If a Docker image or tag name includes restricted characters, the image build fails.
DOCKER_CONTAINER_SETTINGS
blue
First Docker image container that deploys on the Secure Agent machine, alternates with green.
You can change the following ports of the blue container:
  • http-port. The default value is: 16090
  • https-port. The default value is: 16095
DOCKER_CONTAINER_SETTINGS
green
Second Docker image container that deploys on the Secure Agent machine, alternates with blue.
You can change the following ports of the green container:
  • http-port. The default value is: 17090
  • https-port. The default value is: 17095
DOCKER_CONTAINER_SETTINGS
haproxy
Router of the Docker image containers on the Secure Agent machine. Switches traffic between blue and green containers.
You can change the following ports of the haproxy container:
  • http-port. The default value is: 6090
  • https-port. The default value is: 6095
To stop the API Microgateway, stop all three Docker image containers.


Updated January 11, 2021