API Documentation

Syncrypt Public API Reference

This page mirrors currently mounted API routes. Base URL is https://syncrypt.io/api/v1.

58 documented endpoints

Authentication Header

curl -X GET https://syncrypt.io/api/v1/keys/list \
  -H "Authorization: Bearer <jwt-token>"

Some legacy endpoints may still accept API-key auth. Public endpoints are marked with a Public badge.

Authentication

Session and account recovery endpoints.

POST/api/v1/auth/loginPublic

Authenticate with username/email + password and return JWT.

GET/api/v1/auth/meAuth

Get current authenticated user profile.

POST/api/v1/auth/forgot-passwordPublic

Request password reset email.

POST/api/v1/auth/reset-passwordPublic

Reset password using reset token.

POST/api/v1/auth/contactPublic

Submit support/contact request.

Passkey Authentication

WebAuthn registration, login, and device management.

POST/api/v1/auth/passkeys/register/beginAuth

Begin passkey registration and return WebAuthn options.

POST/api/v1/auth/passkeys/register/completeAuth

Complete passkey registration.

POST/api/v1/auth/passkeys/login/beginPublic

Begin passkey login and return authentication options.

POST/api/v1/auth/passkeys/login/completePublic

Complete passkey login and return JWT.

GET/api/v1/auth/passkeys/listAuth

List saved passkeys for the current user.

PATCH/api/v1/auth/passkeys/{passkey_id}Auth

Update passkey metadata (name/active state).

DELETE/api/v1/auth/passkeys/{passkey_id}Auth

Delete passkey credential.

Partners

Partner registration and partner API key lifecycle.

POST/api/v1/partners/registerPublic

POST/api/v1/partners/rotate-api-keyAuth

Rotate current partner API key.

GET/api/v1/partners/api-key-statusAuth

Get current partner API key status and expiry.

Profile

Self-service account and security settings.

PUT/api/v1/profile/updateAuth

Update username/email/company name.

POST/api/v1/profile/change-passwordAuth

Change account password.

GET/api/v1/profile/api-keyAuth

Get current partner API key metadata.

GET/api/v1/profile/recent-activityAuth

Get recent activity placeholder.

POST/api/v1/profile/update-rotation-daysAuth

Update auto-rotation policy (days).

POST/api/v1/profile/delete-accountAuth

Delete current account (non-admin).

PGP Keys

Key generation, encryption, decryption, retrieval, and disablement.

POST/api/v1/keys/generate-keyAuth

Generate key pair for authenticated user (multipart form).

GET/api/v1/keys/listAuth

List keys with filters (environment, label, active).

POST/api/v1/keys/get-public-keyAuth

Fetch public key by fingerprint.

POST/api/v1/keys/encryptAuth

Encrypt file(s) with stored fingerprint or supplied public key.

POST/api/v1/keys/decryptAuth

Decrypt file(s) using key fingerprint and passphrase.

POST/api/v1/keys/disable-keyAuth

Disable key by fingerprint.

Key Rotation

Manual rotation, schedule updates, and history.

POST/api/v1/keys/{fingerprint}/rotateAuth

Rotate key immediately.

POST/api/v1/keys/{fingerprint}/rotation-scheduleAuth

Set key rotation interval (days).

GET/api/v1/keys/{fingerprint}/rotation-historyAuth

Get rotation history for one key.

GET/api/v1/keys/rotation-historyAuth

Get partner-level rotation history.

Public Key Sharing

Share public keys with external recipients via tokenized links.

POST/api/v1/keys/share/createAuth

Create a key share and optional recipient email notification.

GET/api/v1/keys/share/Auth

List shares created by authenticated partner.

GET/api/v1/keys/share/analyticsAuth

Get share analytics summary.

GET/api/v1/keys/share/{share_token}Public

Public share-token lookup endpoint.

DELETE/api/v1/keys/share/{share_id}Auth

Revoke key share by share id.

Generated API Keys

Create and manage multiple API keys plus secure share links.

POST/api/v1/api-keys/generateAuth

Generate a new managed API key.

GET/api/v1/api-keysAuth

List managed API keys.

GET/api/v1/api-keys/{key_id}Auth

Get managed API key by id (includes value).

POST/api/v1/api-keys/{key_id}/rotateAuth

Rotate managed API key.

DELETE/api/v1/api-keys/{key_id}Auth

Revoke managed API key.

POST/api/v1/api-keys/{key_id}/shareAuth

Create share link for managed API key.

GET/api/v1/api-keys/{key_id}/sharesAuth

List shares for managed API key.

DELETE/api/v1/api-keys/shares/{share_id}Auth

Revoke managed API key share.

GET/api/v1/api-keys/shared/{share_token}Public

Public token endpoint to retrieve shared API key.

Billing

Stripe subscription, checkout, and customer portal flows.

GET/api/v1/billing/statusAuth

Get billing mode, plan, and Stripe status.

POST/api/v1/billing/checkoutAuth

Create Stripe Checkout session.

GET/api/v1/billing/portalAuth

Create Stripe billing portal session.

POST/api/v1/billing/webhooks/stripePublic

Stripe webhook receiver.

Audit Logs

Paginated audit events for compliance and traceability.

GET/api/v1/audit-logsAuth

List audit logs with page/page_size/action/status filters.

Team Access Sync

Link to a source teammate and inherit synchronized key access.

GET/api/v1/team-access/statusAuth

Get sync status.

GET/api/v1/team-access/membersAuth

Search eligible source members.

POST/api/v1/team-access/linkAuth

Link or change source member for sync.

DELETE/api/v1/team-access/linkAuth

Remove sync link.

Monitoring

Health and operational metrics endpoints.

GET/api/v1/healthPublic

API health check.

GET/api/v1/statusAdmin

System status snapshot.

GET/api/v1/keys/healthAdmin

Key health overview or by key_id.

GET/api/v1/keys/{key_id}/metricsAdmin

Detailed key metrics.