Add an API client
  • 19 Oct 2022
  • 1 minute to read

Add an API client


To use the external API in Totara, you need to have one or more registered clients. These clients control which services can be accessed by an external system, and how the API is used. We recommend that you create a separate client for each use of the API, and configure the client to have the relevant access to complete a specific task only.

From the Clients page, you can manage the API clients on your site. Follow these steps to add a new API client:

  1. Navigate to Quick-access menu > Development > API > API clients.
  2. Click Add client.
  3. Enter a Name and Description for the API client.
  4. Select a Service Account to be used by the client. See API service accounts for more information.
  5. Use the Status checkbox to determine whether the client is enabled. You can edit and enable the client at a later date if required.
  6. Click Save.

Once the client has been created you will see the new client expanded to show its details.

A tenant member can't create a client outside of their tenant, but system users can create a client within a tenant.

Adding a new API client.

Next steps

© Copyright 2022 Totara Learning Solutions. All rights reserved.


Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.