Skip to content

Connecting Snipe-IT to Tote ​

Part of the Tote Help Center — setup guides for the Snipe-IT instance Tote syncs devices into.

Tote connects to your Snipe-IT instance with a personal API token. This page covers how to create that token, which permissions it needs, and exactly what Tote is allowed to create in your instance.

Create an API token ​

  1. Sign in to Snipe-IT as the user Tote should act as.
  2. Open that user's account settings and select Manage API Keys.
  3. Create a personal API token and copy it. Snipe-IT shows the token only once.
  4. In Tote, enter your Snipe-IT instance URL (for example, snipe.company.com) and the token.

A Snipe-IT superuser is not required. We recommend a dedicated user that has only the permissions listed below, so that Tote can do its job and nothing more.

Permissions Tote needs ​

Grant the token's user the following permissions in Snipe-IT.

View

  1. Categories
  2. Status labels
  3. Companies
  4. Custom fields (and fieldsets)
  5. Manufacturers
  6. Models
  7. Assets
  8. Users

Create

  1. Models
  2. Assets
  3. Manufacturers
  4. Custom fields and fieldsets
  5. Categories

Two of the create permissions depend on how you set Tote up:

  • Status labels: Create is only needed if you let Tote create a missing Pending or Ready to Deploy status label during setup.
  • Users: Create is only needed if user sync is turned on.

What Tote can create in your Snipe-IT ​

Tote only creates objects in your Snipe-IT when you ask it to, and it never creates a duplicate of something that already exists.

During setup, and only if you accept the suggested "Create ..." options, Tote can create:

  1. One asset category (default name Computers).
  2. One custom fieldset (default name Tote Hardware) that holds Tote's custom fields.
  3. A Pending status label and a Ready to Deploy status label, but only when they are missing.

Nothing is created until you press Save. Before creating anything, Tote looks for an existing object with the same name and reuses it.

During a full sync, Tote can also create:

  1. A manufacturer (for example, Lenovo) when it cannot find a matching one.
  2. Models.
  3. Assets.

Manufacturer matching ignores letter case and company suffixes such as "Inc.", so Apple Inc. and APPLE are treated as the same manufacturer.

Preview runs never create anything. A dry-run (preview) shows what Tote would do without writing to your instance.

Every object Tote creates during setup is recorded in your Tote audit log.

If Tote says it can't create something ​

If Tote reports that it cannot create an object, the API token's user is missing the matching Create permission. You have two options:

  1. Grant that user the missing Create permission in Snipe-IT, then run the step again.
  2. Pick an existing category or fieldset in Tote instead of creating a new one.

Companies ​

When you connect, Tote asks your Snipe-IT instance for its list of companies. What you see on the settings step depends on the answer:

  1. Snipe-IT has no companies. The Company field is not shown at all. Tote saves no company, and it does not send a company when it creates assets or users in your instance.
  2. Snipe-IT has exactly one company. The Company field is shown with that company already selected. Change it to None if you do not want Tote to assign it.
  3. Snipe-IT has two or more companies. The Company field is shown with None selected. Pick a company only if you want the assets and users Tote creates to belong to it.

Choose a company only if your Snipe-IT instance uses multiple-company support. When a company is chosen, Tote sets it on the assets and users it creates. When None is chosen, Tote sends no company.