Publishing APIs to Service Registries

Edit online

Publishing an API to a service registry enables applications to dynamically locate an webMethods API Gateway instance that can process that API.

Publishing an API to a service registry, keep the following points in mind:

  • Before you publish an API to a service registry destination, you must add the service registry to the webMethods API Gateway instance from where you want to publish.
  • You must have the Publish API to service registry functional privilege to publish APIs to a service registry.
  • You can publish only active APIs. You cannot publish APIs that are in the inactivate state.
  • An API that is published to a service registry:
    • Automatically de-registered from the service registry if the API is deactivated in webMethods API Gateway. When the API is activated again, it is automatically registered on the same service registry.
    • Is automatically de-registered from the service registry if the webMethods API Gateway instance from where it was registered goes down. When the webMethods API Gateway instance comes up again, the API is registered on the same service registry.
  • In a cluster of webMethods API Gateway nodes, only the webMethods API Gateway instance from where you publish an API is added to the service registry. Separately publish the API from each webMethods API Gateway instance that the service registry can use for an API.
    Note: Similarly, you must separately unpublish the API from each webMethods API Gateway instance from where you want to unpublish the API.
  • If a load balancer is configured for the webMethods API Gateway cluster, APIs from all instances are registered by using the load balancer URL.