Page tree
Skip to end of metadata
Go to start of metadata

On this Page:
In case of a problem with API Management refer to the list of tips and ticks below.

Error "Failed to register client."


After trying to register a client you see error message Failed to register client followed by a long stack trace.


This is mostly caused by the fact that a contract to an API that has been retired.

Imagine you have a contract to an API in version 1.0. After retiring the API, the contract is still active. The end user will get a message like this:

{"responseCode":410,"message":"API Test-API in Organization RD has been retired."}

Now, you create a new version 2.0 of your API and try to setup a contract with the same client:

This will lead to the mentioned error: Failed to register client.


Remove the old contract (API version 1.0). Afterwards, you will be able to re-register your client.

Best Practice

If you break the contract to API version 1.0, the end user will not be informed anymore that the API has been retired.
Instead he will get the following if accessing API version 1.0:

{"responseCode":404,"message":"No contract found between Client Test-Client and Test-API."}

Thus, we recommended to create a new version of the client and register the new client to the new version of the the API.

Accessing an xUML Service WSDL via API Management


You have imported a BRIDGE xUML service via the API Catalog.You know that the WSDL of a service is accessible on the BRIDGE via a link something like <service link>?wsdl. You try to use this method with API Management, and you add ?wsdl to the API endpoint of the service.


The service's WSDL is also imported from the catalog, namely to the API definition of the service. You can access the WSDL via the dedicated link provided by API Management (see orange box).

API-Key Error Using Swagger Try-it-out


The API requires an API-Key header. This header is not passed from Swagger UI to the API because it is replaced automatically with the X-API-Key required for API Management.


Use the API-Key-Policy to make API Management pass the API-Key to the API. Refer to API Key to read more about how to configure this policy.

Swagger Try-i-out Throws Network Error (Firefox)


The Swagger Try-it-out on an API throws a network error due to a CORS policy rejection in Firefox. This works in other browsers (Chrome), though.


Firefox is very observant concerning certificates. If you are using a self-signed certificate with your API Management installation, you need to confirm a security exception for the link that is related to the Try-it-out functionality.

Access the following URL with Firefox: <your API Management base URL>:<your API Management gateway port> and confirm the security exception.

Developer Portal Shows an Empty Page


The Developer portal shows no data. The network tab from the development tools of your browser (accessible via F12) displays:

  • GET 403
  • Access to XMLHttpRequest at '' from origin '' has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header is present on the requested resource
  • The user profile could not be loaded.


The current user is missing client role view-profile from the account group. To check this do the following:

  1. Login to Keycloak.
  2. Select Users from the menu of the Apiman realm.
  3. Click View all users.
  4. Click Edit on the affected user.
  5. Switch to tab Role Mappings.
  6. Select account from drop-down box Client Roles.
  7. If the user has no view-profile role assigned, select this role and add it to the list of Assigned Roles.

Still Need Help?

  1. First of all you can consult our complete technical documentation.
    The documentation is divided into several guides:
  2. If you can't solve your problem with help of the documentation, you can have a look into our Forum at
    Maybe, someone had a similar problem. Otherwise, you are invited to post a question there. API Management developers or fellow users will help you.
  3. Last but not least, you can file a ticket to our support team at
    All mails to our support mailbox will open a ticket in our service desk.
    Optionally, you may use our service desk portal. There, you can manage your tickets and raise new support requests. Using the portal requires you to register your email address, which will not take much time.

    To help you with your problem, our Support team needs some information on your software and environment. Please refer to Sending an API Management Support Request for more details on this.

  • No labels