Skip to content
PluraprintDocs

Start typing to search the documentation.

↑↓to navigateto open

Accounts & Authentication

API Keys

Create and manage API keys for scripts and integrations.

API keys let scripts, integrations, and other systems authenticate with Pluraprint without signing in as a person. They’re useful for things like automated file ingestion, reporting dashboards, or connecting Pluraprint to other tools your organization uses.

Creating an API key

  1. Open Admin in the sidebar, then choose API Keys.
  2. Select Create API Key.
  3. Give the key a descriptive name: for example, “Slicer ingest pipeline” or “Reporting dashboard”, so your team can recognize what it’s used for later.
  4. Choose an expiration: 30 days, 90 days, 1 year, a custom date, or never.
  5. Select Create.

Managing existing keys

The API Keys page lists every key created for your organization, showing:

  • Its name
  • When it expires
  • When it was last used

You can search the list by name. To revoke a key, for example, if it’s no longer needed or may have been exposed: select Delete. Any system using that key will immediately lose access.

Good practices

  • Create a separate key for each integration, rather than sharing one key everywhere. This makes it easy to revoke access to a single system without affecting others.
  • Set an expiration date when possible, and rotate keys periodically.
  • Treat API keys like passwords: never commit them to source control or share them over unencrypted channels.

Creating, viewing, and deleting API keys requires the appropriate permissions: see Roles & Permissions.