Retrieving a specific service within your environment

Roles: system programmer, system administrator

Output a routed instance header

The API Gateway can output a special header that contains the value of the instance ID of the API service that the request has been routed to. This is useful for understanding which service instance is being called.

The header name is X-InstanceId, and the sample value is discoverable-client:discoverableclient:10012. This is identical to instanceId property in the registration of the Discovery service.

Use the following procedure to output a special header that contains the value of the instance ID of the API service.

1. Open the file zowe.yaml.
2. Find or add the property with value components.gateway.apiml.routing.instanceIdHeader:true.
3. Restart Zowe.