PAGES

← Passbolt

Passbolt — API

Passbolt APIv5.0.0 Read the vendor's spec ↗

  • 98 endpoints
  • 3 versions archived since Jul 20, 2026
  • Last checked Sep 22, 2026

This is a low-level overview of the API and its endpoints, if you need higher-level guides for interacting with the endpoints, use the Developer guide.

Get started

first call 
$ curl "https://passbolt.local/tags.json" \
  -H "Authorization: Bearer $TOKEN"

Set $TOKEN first, then paste.

Base URL
https://passbolt.local
Authenticate
Bearer token in the Authorization header Bearer token using a JWT
1 other scheme
  • API key in the passbolt_session cookie
Shape

What it covers

  • Groups 7 Organize users in logical groups to make it easier to share resources with them.
  • Metadata Keys 6 Manipulate metadata keys.
  • Metadata Rotate Key 6 Gather information about metadata keys that needs to be rotated
  • Metadata Upgrade 6 Upgrading elements to the new v5 metadata format
  • Users 6 User are entities with the ability to interact with the application.
  • Authentication (gpgauth) 5 The legacy authentication method, using the GPGAuth protocol.
  • Authentication (jwt) 5 JWT-based authentication is the preferred way to interact with the Passbolt API.
  • Folders 5 Organize your passwords and share them in bulk using folders.
  • Resources 5 A resource holds the metadata for its secrets.
  • Action Logs 4 Read the activity of an entity, or the raw action log.
  • Comments 4 Manipulate comments for resources.
  • Metadata Session Key 4 Gather information on the saved encrypted session keys cache
17 more areas
  • Resource Types 4 Resource-types are used for describing how and what data is stored for a resource and its associated secrets.
  • Shares 4 Share resources and folders to users with an exhaustive permission system.
  • Multi Factor Authentication 3 Complete and validate authentication for users with MFA enabled.
  • Offline Mode 3 Configure the organisation settings that enable Offline mode and set the session duration, the data retention period and the item limit.
  • Tags 3 Get tags and add tags to resources to categorize them.
  • Directory Sync 2 Run directory synchronization.
  • Favorites 2 The favorite endpoints are used to add or remove a Resource from your favorites.
  • Gpg Keys 2 In order to encrypt information, the server and the clients needs the user's public keys.
  • Healthcheck 2 Gather data about the passbolt instance's health.
  • Metadata Private Keys 2 Manipulate private keys for metadata.
  • Metadata Types Settings 2 Retrieve information about the resource types settings selected by the administrators
  • Avatars 1 Query avatar images.
  • Move 1 Move a folder or a resource across folders.
  • Permissions 1 Query permissions for resources.
  • Roles 1 Different categories of users.
  • Secrets 1 Secrets associated to resources.
  • Settings 1 Retrieve the server settings

Endpoints

98 of 98

Open an endpoint for a runnable command, its inputs and what it returns.

Groups 7

  • DELETE /groups/{groupId}.json Delete a group.

    Loading…

  • DELETE /groups/{groupId}/dry-run.json Dry run a group deletion.

    Loading…

  • GET /groups.json Get multiple groups.

    Loading…

  • GET /groups/{groupId}.json Get a group.

    Loading…

  • POST /groups.json Create a group.

    Loading…

  • PUT /groups/{groupId}.json Update a group.

    Loading…

  • PUT /groups/{groupId}/dry-run.json Dry run a group update.

    Loading…

Metadata Keys 6

  • DELETE /metadata/keys/{metadataKeyId}.json Delete a metadata key.

    Loading…

  • GET /metadata/keys.json Get metadata keys.

    Loading…

  • GET /metadata/keys/settings.json Get metadata keys settings.

    Loading…

  • POST /metadata/keys.json Create a metadata key.

    Loading…

  • POST /metadata/keys/settings.json Update metadata keys settings.

    Loading…

  • PUT /metadata/keys/{metadataKeyId}.json Mark a metadata key as expired.

    Loading…

Metadata Rotate Key 6

  • GET /metadata/rotate-key/folders.json Get folders with expired keys

    Loading…

  • GET /metadata/rotate-key/resources.json Get resources with expired keys

    Loading…

  • GET /metadata/rotate-key/tags.json Get tags with expired keys

    Loading…

  • POST /metadata/rotate-key/folders.json Rotate expired metadata keys for folders

    Loading…

  • POST /metadata/rotate-key/resources.json Rotate expired metadata keys for resources

    Loading…

  • POST /metadata/rotate-key/tags.json Rotate expired metadata keys for tags

    Loading…

Metadata Upgrade 6

  • GET /metadata/upgrade/folders.json Get Upgradable Folders

    Loading…

  • GET /metadata/upgrade/resources.json Get Upgradable Resources

    Loading…

  • GET /metadata/upgrade/tags.json Get Upgradable Tags

    Loading…

  • POST /metadata/upgrade/folders.json Upgrade a folder

    Loading…

  • POST /metadata/upgrade/resources.json Upgrade a Resource

    Loading…

  • POST /metadata/upgrade/tags.json Upgrade a tag

    Loading…

Users 6

  • DELETE /users/{userId}.json Delete a user.

    Loading…

  • DELETE /users/{userId}/dry-run.json Dry run a user deletion.

    Loading…

  • GET /users.json Get multiple users.

    Loading…

  • GET /users/{userId}.json Get a user.

    Loading…

  • POST /users.json Create a user.

    Loading…

  • PUT /users/{userId}.json Update a user.

    Loading…

Authentication (gpgauth) 5

  • GET /auth/is-authenticated.json Check authentication status.

    Loading…

  • GET /auth/verify.json Get the server's public PGP key.

    Loading…

  • POST /auth/login.json Log in.

    Loading…

  • POST /auth/logout.json Log out.

    Loading…

  • POST /auth/verify.json Verify the server's identity.

    Loading…

Authentication (jwt) 5

  • GET /auth/jwt/jwks.json Get the JWKs server information.

    Loading…

  • GET /auth/jwt/rsa.json Get the JWT RSA server information.

    Loading…

  • POST /auth/jwt/login.json Login.

    Loading…

  • POST /auth/jwt/logout.json Logout.

    Loading…

  • POST /auth/jwt/refresh.json Refresh access token.

    Loading…

Folders 5

  • DELETE /folders/{folderId}.json Delete a folder.

    Loading…

  • GET /folders.json Get multiple folders.

    Loading…

  • GET /folders/{folderId}.json Get a folder.

    Loading…

  • POST /folders.json Create a folder.

    Loading…

  • PUT /folders/{folderId}.json Update a folder.

    Loading…

Resources 5

  • DELETE /resources/{resourceId}.json Delete a resource.

    Loading…

  • GET /resources.json Get multiple resources.

    Loading…

  • GET /resources/{resourceId}.json Get a resource.

    Loading…

  • POST /resources.json Create a resource.

    Loading…

  • PUT /resources/{resourceId}.json Update a resource.

    Loading…

Action Logs 4

  • GET /actionlog/folder/{folderId}.json Get the activity of a folder.

    Loading…

  • GET /actionlog/logs.json Get the raw action log.

    Loading…

  • GET /actionlog/resource/{resourceId}.json Get the activity of a resource.

    Loading…

  • GET /actionlog/user/{userId}.json Get the activity of a user.

    Loading…

Comments 4

  • DELETE /comments/{commentId}.json Delete a comment.

    Loading…

  • GET /comments/resource/{resourceId}.json Get comments for a resource.

    Loading…

  • POST /comments/resource/{resourceId}.json Add a comment.

    Loading…

  • PUT /comments/{commentId}.json Update a comment.

    Loading…

Metadata Session Key 4

  • DELETE /metadata/session-key/{sessionKeyId}.json Delete a given session-key entry.

    Loading…

  • GET /metadata/session-keys.json Get session keys.

    Loading…

  • POST /metadata/session-key/{sessionKeyId}.json Update a given session-key entry.

    Loading…

  • POST /metadata/session-keys.json Add a session key.

    Loading…

Resource Types 4

  • DELETE /resource-types/{resourceTypeId}.json Delete a resource type.

    Loading…

  • GET /resource-types.json Get multiple resource types.

    Loading…

  • GET /resource-types/{resourceTypeId}.json Get a resource type.

    Loading…

  • PUT /resource-types/{resourceTypeId}.json Update resource type.

    Loading…

Shares 4

  • GET /share/search-aros.json Get AROs for sharing.

    Loading…

  • POST /share/simulate/resource/{foreignId}.json Simulate sharing a resource.

    Loading…

  • PUT /share/folder/{foreignId}.json Share a folder.

    Loading…

  • PUT /share/resource/{foreignId}.json Share a resource.

    Loading…

Multi Factor Authentication 3

  • GET /mfa/verify/error.json Information about MFA requirements.

    Loading…

  • GET /mfa/verify/{mfaProviderName}.json Check multi-factor authentication.

    Loading…

  • POST /mfa/verify/{mfaProviderName}.json Attempt multi-factor authentication.

    Loading…

Offline Mode 3

  • DELETE /offline/settings/{id}.json Delete the Offline mode settings.

    Loading…

  • GET /offline/settings.json Get the Offline mode settings.

    Loading…

  • POST /offline/settings.json Save the Offline mode settings.

    Loading…

Tags 3

  • GET /tags.json Get personal tags and shared tags.

    Loading…

  • POST /tags/{resourceOrTagId}.json Add tags to a resource.

    Loading…

  • PUT /tags/{resourceOrTagId}.json Update a tag.

    Loading…

Directory Sync 2

  • GET /directorysync/synchronize/dry-run.json Simulate directory synchronization without making changes.

    Loading…

  • POST /directorysync/synchronize.json Run the directory synchronization.

    Loading…

Favorites 2

  • DELETE /favorites/{favoriteId}.json Unset a resource as favorite.

    Loading…

  • POST /favorites/resource/{foreignId}.json Set a resource as favorite.

    Loading…

Gpg Keys 2

  • GET /gpgkeys.json Get multiple GPG keys.

    Loading…

  • GET /gpgkeys/{gpgkeyId}.json Get a GPG key.

    Loading…

Healthcheck 2

  • GET /healthcheck.json Get healthcheck information.

    Loading…

  • GET /healthcheck/status.json Check if passbolt is up.

    Loading…

Metadata Private Keys 2

  • POST /metadata/keys/privates.json Create a metadata private key.

    Loading…

  • PUT /metadata/keys/private/{metadataPrivateKeyId}.json Update a metadata private key.

    Loading…

Metadata Types Settings 2

  • GET /metadata/types/settings.json Get metadata types settings

    Loading…

  • POST /metadata/types/settings.json Upgrade a resource types settings

    Loading…

Avatars 1

  • GET /avatars/view/{avatarId}/{avatarFormat} Get an avatar as an image.

    Loading…

Move 1

  • PUT /move/{foreignModel}/{foreignId}.json Move an element.

    Loading…

Permissions 1

  • GET /permissions/resource/{resourceId}.json Get permissions for a resource.

    Loading…

Roles 1

  • GET /roles.json Get multiple roles.

    Loading…

Secrets 1

  • GET /secrets/resource/{resourceId}.json View user's secret for a resource.

    Loading…

Settings 1

  • GET /settings.json Get the server settings.

    Loading…

Change log

    • +DELETE /offline/settings/{id}.json
    • +GET /offline/settings.json
    • +POST /offline/settings.json
    • +DELETE /favorites/{favoriteId}.json
    • +GET /actionlog/folder/{folderId}.json
    • +GET /actionlog/logs.json
    • +GET /actionlog/resource/{resourceId}.json
    • +GET /actionlog/user/{userId}.json
    • +POST /favorites/resource/{foreignId}.json
    • +POST /share/simulate/resource/{foreignId}.json
    • +PUT /share/folder/{foreignId}.json
    • +PUT /share/resource/{foreignId}.json
    • −DELETE /favorite/{favoriteId}.json
    • −POST /favorite/{foreignModel}/{foreignId}.json
    • −POST /share/simulate/{foreignModel}/{foreignId}.json
    • −PUT /share/{foreignModel}/{foreignId}.json
compare.md

    Free the public facts, no sign-in Any paid plan all other sections Researcher & Business pricing history and category rank

    my-toolchain — 0 tools

      Betas, release candidates and previews. Turn it off to see final releases only. It also applies to changes you ask for over MCP when you're signed in.
      browse all tools → score card for your toolchain →
      cyber-toolchain / feedback

      Send us feedback