Add a web service
  • 21 Jun 2022
  • 1 minute to read

Add a web service

Web services in Totara are now legacy functionality. Please refer to the GraphQL developer documentation to find out about the replacement for web services.

To add a new external web service, follow these steps:

  1. Go to Quick-access menu > Plugins > Web services > External services.
  2. Click Add
  3. Fill out the form as required. You can click Show more... to see additional options. Mandatory fields are marked with an asterisk (*).
  4. Click Add service to save this new external service.

Manage protocols

The Manage protocols page (Quick-access menu > Plugins > Web services > Manage protocols) allows you to enable or disable various web service protocols. Available protocols are: AMF, REST, SOAP, and XML-RPC.

It is recommended for security reasons that you only enable protocols that are in use by your site.

If you are either a developer yourself or you are working with a web services client developer then you will want to enable Web services documentation. You can do this by ticking the Web services documentation box, then clicking Save changes

Manage tokens

You can generate a unique token for any users in the system. Note that this is the only way to generate tokens for admin users.

The Manage tokens page (Quick-access menu > Plugins > Web services > Manage tokens) will show you a list of all currently issued tokens. You can click Delete to get rid of any of these. The list only shows the details of the current tokens, and not the tokens themselves (to maintain their security and integrity). 

To create a new token, follow these steps:

  1. Click Add (under the list of tokens).
  2. Complete the mandatory fields (marked with an asterisk). You can also add an IP restriction and Valid until date. 
  3. Once you have entered all the required information, click Save changes to generate the token. 
  4. You will be shown the newly created token, which you will need to copy before closing the page, as it will not be shown again.

© Copyright 2022 Totara Learning Solutions. All rights reserved. Some content originally obtained via GPLv3 license and continues to be available under GPLv3. All other content is the sole copyright of Totara Learning Solutions. 

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.