v63

latestOpenAPI 3.1.0Dual (AGPL3.0, Commercial License Available)raw.githubusercontent.com2026-08-06211300932.3 KB

internal

Verify password for a password-protected share and return an access token.

The returned token is an HS256 JWT tied to the share's current password hash; subsequent /topology calls send the token instead of the raw password. Changing the share password invalidates outstanding tokens.

post/api/v1/shares/public/{id}/verify

Path parameters

idstring uuid required

Share ID

Response

Password verified; access token issued

errorstring nullable

Human-readable failure message. Omitted on success.

successboolean required

true when the request succeeded. false responses carry error instead of data.

Example response

{
  "meta": {
    "api_version": 1,
    "server_version": "0.17.8"
  }
}