There was a problem loading the comments.

How to add a API token used for backups.

Support Portal  »  Knowledgebase  »  Viewing Article

  Print

In this guide, we will explain how to set up an API token to use with PBS for authentication to your PVE environment

 

1. Go to your PBS environment (pbs00X.tuxis.nl), and log in.

2. Go to the Access Control tab.

f240b83e6f0c7c1a145e75da2363586da164b2b1e217bab3dad939c95db1fbbfa0c04ffdbd107bf1?t=676c8290336e41fdc006eeeb4c8bc65b

3. Click on API Token.

db9a78af317fa8163f8a29aefe9536acaebb3cb043511f8de24ce5ea02a0a35e7018949014ad73e0?t=dcadbcc2438918f8990f4ce992eb8a95

4. Click on add.

2e5847417127504090a749856d0f5b60c5ef3add9c6d40194099cb87ff3c3d13bdcbce925b8cb38a?t=7bf1ca3be948b048d7299af39bdebe5e

5. Give the API token a name. 

b70c468cd32448fc3f44df350625ad7bae428d2628e3b52d6d590b42cff5a182b60458cb8cfa8ee7?t=d3a3b5cf938b9af48be4dce359c13234

User: Select the user you want to create an API token for. 

Token Name: You can enter something yourself, this does not matter.

Expire: Can be set to make the API token expire after a certain date. Default is never.

Enable: Must be checked for the API token to function.

Comment: Can be used to add a description to the API token.

 

6. Save the API secret (VERY IMPORTANT)

dc8a7da89439ff53111c06bc1952d07561a8e76c4ce1a393dc17e0b7c5e74c3aeb624870984d7ed5?t=55e6184a63e7d58126938de5af72219e

The secret will be used for authentication when adding the PBS to PVE.

 

7. Click on Permissions.

2945e73c3a1f797130cc0ab25a19eff2c0af9305a9e310f4434d4da04d8c07bd03bdc3cf42c15fe8?t=f000989be0c0bcac2c1553943d2957e0

8. Click on add.

1da89e22f195466d6641236c7b51c04889b667c92bdfa7f5ebfd85621261dc37d74e66c3009b1f9b?t=01a4a1c51eb4c4aa408bebb8f0946d40

9. Select "API token permission"

05717a6271c8f983f2cda7f8d49ba13eb71d3a8dc79a26c3b9bd704c00ebc5a731e4a0fade210c34?t=67d67bcf730de25dc3477d52b8d73bbd

10. Enter the information needed for the API token.

0f031e98e4a7495ded5cdf3a28e1fed62ed1cfcf49e9e8ae62de6dfa750fd98b1ae7215926fbc694?t=d7755076f8df07c890be68b02d49cf96

Path: Select the datastore that you want to use, going by "/datastore/<datastorename>"

API Token: Select the api token that you have previously created. 

Role: Select the role "DatastoreBackup". With this you will be able to make and restore backups that are owned by PVE.

Propagate: Should be checked if you have multiple namespaces on the datastore and want the token to be able to access all of them

 

Now you can add the datastore to your pve environment following the following documentation


Share via
Did you find this article useful?  

Related Articles

© Tuxis B.V.