Send api key in REST consumer

Product/components used and version/fix level are you on:

webMethods 10.7 (Latest fixes)

Detailed explanation of the problem:

I have created a REST API descriptor (consumer) based on openapi 3.x spec. The REST service expect an x-API-key as an http header (See snippet of openapi spec below)

"securitySchemes": {
     "ApiKey": {
       "type": "apiKey",
       "name": "X-API-KEY",
       "in": "header"

The connector created by webMethods does have a place holder to add the apiKey. However that is never getting sent. When running in verbose mode I can see that (x-API-key) not present in the http header. Moreover the “auth” document in the service wm.server.openapi:invoke service (which is called by the connector ) does not match to what’s in the connector. So how are we supposed to pass the API key?. Secondly, how can we add custom http headers to a REST connector?

Error messages / full error message screenshot / log fileL

Is your question related to the free trial, or to a production (customer) instance?

Have you installed all the latest fixes for the products and systems you are using?

Is there a header defined in the operation for the API key in the OAS document?
Can you pass the complete openapi document or at least the operation in question?

You cannot pass custom header if not defined in the OAS document.

This topic was automatically closed 180 days after the last reply. New replies are no longer allowed.