HTTP Error 401 in SystemLink Enterprise Swagger UI

Issue Details

• I want to interact with my SystemLink Enterprise (SLE) instance programmatically over HTTP. However, whenever I do, I receive the HTTP response code 401. What causes this?
• I have created an API key in the SLE web UI for my user account. When I use this API key to authenticate a HTTP session in the Swagger UI, I receive an error similar to below. Why is my API key invalid?

Error 401: Invalid API Key.

Solution

This error can occur due to two reasons:

• You are not using a valid API key.
• The user account associated with the API key does not have the necessary permissions for this API.

To identify and resolve the issue, follow the steps below:

• Ensure that your API key is valid.
  1. Using the instructions in Creating an API Key, remove the existing API key and create a new one.
  2. Attempt to use the new API Key with the Swagger UI instead. If the problem persists, the issue relates to your user account.
• Ensure that your user account is assigned an appropriate Role.
  1. Depending on the API you wish to use, different Roles will be required. Ask an SLE admin to check the Role associated with your account and modify it if the required permissions are missing. Refer to Configuring a Role and Privileges to understand how to view/assign permissions to Roles.
  2. For example, if you wish to retrieve a list of Workspaces using the /workspaces HTTP GET request, only the Workspace Owner built-in Role has sufficient permissions.