Passbolt website screenshot

Passbolt

Passbolt is an open source password manager for teams. The Passbolt API provides programmatic access to manage resources (passwords), folders, users, groups, sharing, comments, metadata, and authentication via GPGAuth or JWT.

Passbolt publishes 27 APIs on the APIs.io network, including Authentication (GPGAuth) API, Authentication (JWT) API, Avatars API, and 24 more. Tagged areas include Password Manager, Security, Secrets, and Identity.

Passbolt’s developer surface includes authentication, documentation, engineering blog, and 6 more developer resources.

38.1/100 thin ▬ flat Agent 31/100 agent aware Full breakdown ↓
scored 2026-08-05 · rubric v0.9.1
AccessFreemiumSelf serve⚡ Free to try
27 APIs
Password ManagerSecuritySecretsIdentity

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-08-05 · rubric v0.9.1
Composite quality — 38.1/100 · thin
Contract Quality 15.3 / 25
Developer Ergonomics 4.3 / 20
Commercial Clarity 7.9 / 20
Operational Transparency 4.1 / 13
Governance 0.0 / 12
Discoverability 6.5 / 10
Agent readiness — 31/100 · agent aware
Machine-Readable Contract 18 / 18
Agentic Access Contract 10 / 10
MCP Server 0 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 0 / 8
Request/Response Examples 0 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 0 / 6
Agent Skills 0 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 0 / 4
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/passbolt: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 27

Individual APIs this provider publishes, each with its own machine-readable definition.

Passbolt Authentication (GPGAuth) API

The legacy authentication method, using the GPGAuth protocol. Find more [here](https://www.passbolt.com/docs/development/authentication).

Passbolt Authentication (JWT) API

JWT-based authentication is the preferred way to interact with the Passbolt API. Find more [here](https://www.passbolt.com/docs/development)

Passbolt Avatars API

Query avatar images.

Passbolt Comments API

Manipulate comments for resources.

Passbolt Directory Sync API

Run directory synchronization.

Passbolt Favorites API

The favorite endpoints are used to add or remove a `Resource` from your favorites.

Passbolt Folders API

Organize your passwords and share them in bulk using folders.

Passbolt GPG keys API

In order to encrypt information, the server and the clients needs the user's public keys. These OpenPGP endpoints let you query the saved public key data.

Passbolt Groups API

Organize users in logical groups to make it easier to share resources with them.

Passbolt Healthcheck API

Gather data about the passbolt instance's health.

Passbolt Metadata keys API

Manipulate metadata keys.

Passbolt Metadata private keys API

Manipulate private keys for metadata.

Passbolt Metadata rotate key API

Gather information about metadata keys that needs to be rotated

Passbolt Metadata session key API

Gather information on the saved encrypted session keys cache

Passbolt Metadata types settings API

Retrieve information about the resource types settings selected by the administrators

Passbolt Metadata upgrade API

Upgrading elements to the new v5 metadata format

Passbolt Move API

Move a folder or a resource across folders.

Passbolt Multi-Factor Authentication API

Complete and validate authentication for users with MFA enabled.

Passbolt Permissions API

Query permissions for resources.

Passbolt Resource types API

Resource-types are used for describing how and what data is stored for a resource and its associated secrets.

Passbolt Resources API

A resource holds the metadata for its secrets.

Passbolt Roles API

Different categories of users.

Passbolt Secrets API

Secrets associated to resources.

Passbolt Settings API

Retrieve the server settings

Passbolt Shares API

Share resources and folders to users with an exhaustive permission system.

Passbolt Tags API

Get tags and add tags to resources to categorize them.

Passbolt Users API

User are entities with the ability to interact with the application.

Scroll for all 27

Pricing Plans 1

Published pricing tiers and plan structures.

Rate Limits 1

Documented rate limits and quota policies.

Passbolt Rate Limits

5 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Security Posture 3

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Passbolt Authentication

apiKey/http · 2 schemes

SECURITY

Passbolt Domain Security

TLSv1.3 · DNSSEC · DMARC

SECURITY

Passbolt Vulnerability Disclosure

security.txt · contact published

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Passbolt Agentic Access

90 operations · 51 acting

90 operations · 51 acting

AGENTIC

Resources

Documentation 1

Reference material describing how the API behaves

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

Build 1

SDKs, sample code, and the tooling you integrate with

Access & Security 3

Authentication, authorization, and security posture

Company 3

The organization behind the API

Source (apis.yml)

apis.yml Raw ↑
aid: passbolt
name: Passbolt
description: Passbolt is an open source password manager for teams. The Passbolt API provides programmatic access to manage
  resources (passwords), folders, users, groups, sharing, comments, metadata, and authentication via GPGAuth or JWT.
type: Index
accessModel:
  pricing: freemium
  onboarding: self-serve
  trial: false
  try_now: true
  public: false
  label: Freemium · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  method: derived
position: Consumer
access: 3rd-Party
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/passbolt.png
tags:
- Password Manager
- Security
- Secrets
- Identity
created: '2025-02-21'
modified: '2026-05-19'
url: https://raw.githubusercontent.com/api-evangelist/passbolt/refs/heads/main/apis.yml
specificationVersion: '0.19'
apis:
- aid: passbolt:passbolt-authentication-gpgauth-api
  name: Passbolt Authentication (GPGAuth) API
  description: 'The legacy authentication method, using the GPGAuth protocol.


    Find more [here](https://www.passbolt.com/docs/development/authentication).'
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Authentication (GPGAuth)
  properties:
  - type: OpenAPI
    url: openapi/passbolt-authentication-gpgauth-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-authentication-jwt-api
  name: Passbolt Authentication (JWT) API
  description: JWT-based authentication is the preferred way to interact with the Passbolt API. Find more [here](https://www.passbolt.com/docs/development)
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Authentication (JWT)
  properties:
  - type: OpenAPI
    url: openapi/passbolt-authentication-jwt-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-avatars-api
  name: Passbolt Avatars API
  description: Query avatar images.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Avatars
  properties:
  - type: OpenAPI
    url: openapi/passbolt-avatars-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-comments-api
  name: Passbolt Comments API
  description: Manipulate comments for resources.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Comments
  properties:
  - type: OpenAPI
    url: openapi/passbolt-comments-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-directory-sync-api
  name: Passbolt Directory Sync API
  description: Run directory synchronization.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Directory Sync
  properties:
  - type: OpenAPI
    url: openapi/passbolt-directory-sync-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-favorites-api
  name: Passbolt Favorites API
  description: The favorite endpoints are used to add or remove a `Resource` from your favorites.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Favorites
  properties:
  - type: OpenAPI
    url: openapi/passbolt-favorites-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-folders-api
  name: Passbolt Folders API
  description: Organize your passwords and share them in bulk using folders.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Folders
  properties:
  - type: OpenAPI
    url: openapi/passbolt-folders-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-gpg-keys-api
  name: Passbolt GPG keys API
  description: In order to encrypt information, the server and the clients needs the user's public keys. These OpenPGP endpoints
    let you query the saved public key data.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - GPG keys
  properties:
  - type: OpenAPI
    url: openapi/passbolt-gpg-keys-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-groups-api
  name: Passbolt Groups API
  description: Organize users in logical groups to make it easier to share resources with them.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Groups
  properties:
  - type: OpenAPI
    url: openapi/passbolt-groups-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-healthcheck-api
  name: Passbolt Healthcheck API
  description: Gather data about the passbolt instance's health.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Healthcheck
  properties:
  - type: OpenAPI
    url: openapi/passbolt-healthcheck-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-metadata-keys-api
  name: Passbolt Metadata keys API
  description: Manipulate metadata keys.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Metadata keys
  properties:
  - type: OpenAPI
    url: openapi/passbolt-metadata-keys-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-metadata-private-keys-api
  name: Passbolt Metadata private keys API
  description: Manipulate private keys for metadata.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Metadata private keys
  properties:
  - type: OpenAPI
    url: openapi/passbolt-metadata-private-keys-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-metadata-rotate-key-api
  name: Passbolt Metadata rotate key API
  description: Gather information about metadata keys that needs to be rotated
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Metadata rotate key
  properties:
  - type: OpenAPI
    url: openapi/passbolt-metadata-rotate-key-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-metadata-session-key-api
  name: Passbolt Metadata session key API
  description: Gather information on the saved encrypted session keys cache
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Metadata session key
  properties:
  - type: OpenAPI
    url: openapi/passbolt-metadata-session-key-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-metadata-types-settings-api
  name: Passbolt Metadata types settings API
  description: Retrieve information about the resource types settings selected by the administrators
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Metadata types settings
  properties:
  - type: OpenAPI
    url: openapi/passbolt-metadata-types-settings-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-metadata-upgrade-api
  name: Passbolt Metadata upgrade API
  description: Upgrading elements to the new v5 metadata format
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Metadata upgrade
  properties:
  - type: OpenAPI
    url: openapi/passbolt-metadata-upgrade-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-move-api
  name: Passbolt Move API
  description: Move a folder or a resource across folders.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Move
  properties:
  - type: OpenAPI
    url: openapi/passbolt-move-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-multi-factor-authentication-api
  name: Passbolt Multi-Factor Authentication API
  description: Complete and validate authentication for users with MFA enabled.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Multi-Factor Authentication
  properties:
  - type: OpenAPI
    url: openapi/passbolt-multi-factor-authentication-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-permissions-api
  name: Passbolt Permissions API
  description: Query permissions for resources.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Permissions
  properties:
  - type: OpenAPI
    url: openapi/passbolt-permissions-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-resource-types-api
  name: Passbolt Resource types API
  description: Resource-types are used for describing how and what data is stored for a resource and its associated secrets.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Resource types
  properties:
  - type: OpenAPI
    url: openapi/passbolt-resource-types-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-resources-api
  name: Passbolt Resources API
  description: A resource holds the metadata for its secrets.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Resources
  properties:
  - type: OpenAPI
    url: openapi/passbolt-resources-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-roles-api
  name: Passbolt Roles API
  description: Different categories of users.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Roles
  properties:
  - type: OpenAPI
    url: openapi/passbolt-roles-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-secrets-api
  name: Passbolt Secrets API
  description: Secrets associated to resources.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Secrets
  properties:
  - type: OpenAPI
    url: openapi/passbolt-secrets-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-settings-api
  name: Passbolt Settings API
  description: Retrieve the server settings
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Settings
  properties:
  - type: OpenAPI
    url: openapi/passbolt-settings-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-shares-api
  name: Passbolt Shares API
  description: Share resources and folders to users with an exhaustive permission system.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Shares
  properties:
  - type: OpenAPI
    url: openapi/passbolt-shares-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-tags-api
  name: Passbolt Tags API
  description: Get tags and add tags to resources to categorize them.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Tags
  properties:
  - type: OpenAPI
    url: openapi/passbolt-tags-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-users-api
  name: Passbolt Users API
  description: User are entities with the ability to interact with the application.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Users
  properties:
  - type: OpenAPI
    url: openapi/passbolt-users-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
common:
- type: AgenticAccess
  url: agentic-access/passbolt-agentic-access.yml
- type: VulnerabilityDisclosure
  url: security/passbolt-vulnerability-disclosure.yml
- type: DomainSecurity
  url: security/passbolt-domain-security.yml
- type: Authentication
  url: authentication/passbolt-authentication.yml
- type: LinkedIn
  url: https://www.linkedin.com/company/passbolt
- type: Website
  url: https://www.passbolt.com
- type: Documentation
  url: https://www.passbolt.com/docs/
- type: SourceCode
  url: https://github.com/passbolt
- url: https://www.passbolt.com/blog
  type: Blog
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com