Use access settings to mark a flow service as private.
Before you begin
-
You must have the webMethods API Gateway's manage APIs or activate/deactivate APIs functional privilege that is assigned to
complete this task.
-
You must have the webMethods API Gateway’s manage aliases functional privilege that is assigned to complete this task.
About this task
You can mark a service invocation as private so that only components within your tenant’s network
can access it, while external clients are restricted. This feature enforces policy-based access
through webMethods API Gateway.
Procedure
- Click Projects.
- Select a project and click Flow services.
- Select a flow service, click the ellipsis icon on the flow service card, and choose
Overview.
- On the Overview page, select the checkbox for Enable Flow
service invocation over HTTP.
The Public and Internal URLs
appears.
Public URL. A public endpoint is accessible externally using the
internet.
Internal URL. An internal endpoint is accessible only from
the webMethods network.
Note: To start a flow service within a webMethods network,
use the internal URL.
- Enable the Private Invocation option and copy the
Private URL. Use this URL to start a flow service within a Virtual Private
Cloud (VPC) instead of using the public domain.
Note: In an existing API, when you toggle from Public to Private or Private to Public, the changes
takes a while to propagate for the ongoing API executions.