Skip to content

Cove API setup

The app reads device and backup data from Cove using a dedicated login. This page creates that login and gives it to the app. No prior API experience needed.

Cove has a dedicated API user type for exactly this. You'll create one, copy its token, and give three things to the app: the login name, the token, and your partner (company) name.

1. Sign in to the Cove Management Console

  1. Go to https://backup.management and sign in with a SuperUser or Administrator account.

2. Create an API user

  1. In the vertical menu, go to Management → Users → API Users.
  2. Click Add API user.
  3. Complete the fields:
    • Customer — choose the top-level partner (your company, e.g. TOTLCOM Inc). Note this exact name; it's your partner name for step 4.
    • Login name — for example api-reporter.
    • Role — the dropdown offers SuperUser, Administrator, Manager, Operator, Supporter. Choose Supporter — it's the most read-only, which is all this app needs (it never changes anything). If a Security Officer checkbox appears, leave it unchecked.
  4. Click Save and continue.
  5. Copy the token — click Copy token to clipboard (or Download token). It is shown only once; if you lose it, delete the API user and recreate it.
  6. Click Copy and close.

Note

API users can use the API but cannot log in to the Console (that's expected). The token acts as the password in step 3.

3. Give the login name and token to the app

From the project folder in your terminal (where you ran npm install), set the two secrets:

npx wrangler secret put COVE_API_USER
→ paste the API user's login name, press Enter.

npx wrangler secret put COVE_API_PASSWORD
→ paste the token you copied, press Enter.

4. Set the partner name in the config

Open server/config/app.config.ts and set the Cove partner name. This must be the full partner string exactly as Cove displays it — including the account‑owner email in parentheses, e.g. TOTLCOM Inc. (dannythompson@totlcom.com). Just the company name (TOTLCOM Inc) will fail with "Unknown partner/username or bad password".

cove: {
  partnerName: "Your Company Name (owner@yourdomain.com)",
},

Confirm the exact partner string

It's the value shown in the Customer dropdown when you created the API user, or the partner name at the top of the Cove console — copy it verbatim (capitalization, period, spacing, and the (email) part).

Save, then re-deploy so the app picks up the secrets and config:

npm run deploy

4. Verify it works

  1. Open the app and go to Admin.
  2. Click Test Cove API.
  3. It should report a device count.

Warning

  • If it says the login failed, double-check the username/password secrets (re-run the two wrangler secret put commands and re-deploy).
  • If the device count is lower than expected, or you get a permissions error, the Supporter role is too narrow — recreate the API user with the Manager role (then Administrator if still short) and test again.
  • If login fails, confirm the partner name in the config exactly matches the Customer name in Cove.

What the app does with this

  • It calls Cove's endpoint https://api.backup.management/jsonapi.
  • It signs in for a short-lived session token (cached), then reads device statistics to build the monthly report.
  • It only ever reads — it never modifies devices, customers, or settings.