Issue personal access tokens to access the private UpdaterCloud REST API endpoints


Introduction

If you prefer a hands-on approach, you can use the UpdaterCloud REST API to programatically manage every aspect of your update server, including releases, customers, licenses and update channels. UpdaterCloud REST API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP authentication, response codes and verbs. Please see the API Reference to learn more about the UpdaterCloud's available API endpoints.

{warning} UpdaterCloud's admin API endpoins require authentication.

Personal access tokens allow access to the admin endpoints of the UpdaterCloud REST API. The personal access token should not be shared with anybody.

Create Personal Access Token

Access tokens can be created by using the New button in the top toolbar. You can generate a personal access token for each application you use that needs access to the UpdaterCloud REST API. Once you're done editing, click on the Save button and copy your access token. The access token won't be displayed again after that. If you loose your access token, you must delete the lost access token and create a new one.

Personal Access Token Details

When creating a new access token, the following fields are available:

Field Required Description
Name Yes Pick a name to describe the application where this access token will be used. The access token name must be unique.

Personal Access Token Scopes

{warning} You must assign at least one scope to your access token, depending on what the token will be used for.

Field Required Description
api Yes Grants complete read-write access to the API, including authenticated user profile, releases, licenses and reports.
read_user Yes Grants read-only access to the authenticated user profile through the /me API endpoint, which includes name and email.
read_releases Yes Grants read-only access to releases (groups, products, versions, files and update channels).
manage_releases Yes Grants read-write access to releases (groups, products, versions, files and update channels).
read_licenses Yes Grants read-only access to licenses (customers, download keys and activations).
manage_licenses Yes Grants read-write access to licenses (customers, download keys and activations).
reports Yes Grants read-write access to reports.

Delete Personal Access Token

Access tokens can be deleted from the access tokens list, by clicking on the Delete link next to the access token you want to delete.

{danger} Deleted items are not recoverable. This action is permanent and can't be undone.