Colectica Portal exposes the functionality of Colectica Repository by providing a REST-style API. By default, the API is disabled. To enable the API, follow these steps:

  1. As an administrator, enable the API in the Site Information page.

  2. In the appsettings.json file, add the following as a top level section:

    "API": {
      "ColecticaAdministratorKey": "ADMINKEY",
      "ColecticaUserKey": "USERKEY"

    Replace ADMINKEY and USERKEY with your desired API keys. Support for improved API key management is forthcoming in a future release.


Visit the Colectica REST API v1 documentation page for details.

For interactive documentation for all API methods, visit your Portal’s site: http://example.org/swagger/ui.