ECSCore supports authentication with a API Key (Application ProgrammingIinterface Key).

API keys can be used as an authentication method if access is not to be made via user-specific access data. An API key acts as a unique identifier and can easily be added, regenerated or removed. For many cloud scenarios, this is a viable and typical authentication mechanism.

To add a new API Key, click Add API Key in the API Keys section. You can add an API key for two types of users:

  1. Valid Windows user with Windows password: Such an API key generated for a Windows user can only be used for authentication within a cloud application that consumes web services created with ECS Core or REST API provided by ECS Core.
  2. Dashboard user created on the Management Site: Such an API key, created on a user independent from Windows, can only be used for deployment of web services in the WebService Designer.


For details about deploying and consuming services, see the Web Service Authentication section.

After the key is created, it is displayed under API Keys. You may need to clean up the cache first (described in System Operations).

Click on the API key to display the following options:

  • Update
  • remove

You will need the Update option if the user’s credentials have changed. The API key can be overwritten with values from another installation, for example. This would make sense in a load balanced architecture using Azure Relay.