Settings API

GET /settings/account-methods

Account Methods Api

Return optional sign-in methods for this local instance. An incumbent credential proves only the instance it authenticates; it never replaces the durable local destination of an explicit account action.

Responses

Example

curl -X GET http://localhost:8000/settings/account-methods \
  -H "Authorization: Bearer $TOKEN"

POST /settings/account-signup

Account Signup Api

Proxy the magic-link signup request using the API-process instance_id.

Request body

object

Responses

Example

curl -X POST http://localhost:8000/settings/account-signup \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /settings/account-status

Account Status Api

Proxy status for the durable local instance. A stored credential may unmask this destination only when it proves the same instance (or a legacy relay omits identity); foreign proof never retargets it.

Responses

Example

curl -X GET http://localhost:8000/settings/account-status \
  -H "Authorization: Bearer $TOKEN"

GET /settings/backup-status

Backup Status

Return backup scheduler state: last results and next scheduled run times.

Responses

Example

curl -X GET http://localhost:8000/settings/backup-status \
  -H "Authorization: Bearer $TOKEN"

GET /settings/billing-catalog

Billing Catalog Api

Non-secret display catalog. Failure omits prices rather than fabricating them.

Responses

Example

curl -X GET http://localhost:8000/settings/billing-catalog \
  -H "Authorization: Bearer $TOKEN"

POST /settings/cloud-accept-tos

Cloud Accept Tos Api

Persist TOS acceptance, restart gateway client with new tos_version.

Responses

Example

curl -X POST http://localhost:8000/settings/cloud-accept-tos \
  -H "Authorization: Bearer $TOKEN"

POST /settings/cloud-activate

Cloud Activate Api

Synchronise Connect using explicit authority and activation intent.

Request body

object, optional

Responses

Example

curl -X POST http://localhost:8000/settings/cloud-activate \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /settings/cloud-apply-token

Cloud Apply Token Api

Compatibility endpoint for trusted local callers. Current UI never transports gateway credentials through HTML. A local caller may still explicitly apply a credential, using the same durable CAS boundary.

Request body

object

Responses

Example

curl -X POST http://localhost:8000/settings/cloud-apply-token \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /settings/cloud-claim

Cloud Claim Api

Request body

object

Responses

Example

curl -X POST http://localhost:8000/settings/cloud-claim \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /settings/cloud-disconnect

Cloud Disconnect

Persist sticky disconnect first, then stop all live cloud activity.

Responses

Example

curl -X POST http://localhost:8000/settings/cloud-disconnect \
  -H "Authorization: Bearer $TOKEN"

GET /settings/cloud-instance-id

Cloud Instance Id

Return the canonical instance_id from the API process.

Responses

Example

curl -X GET http://localhost:8000/settings/cloud-instance-id \
  -H "Authorization: Bearer $TOKEN"

POST /settings/cloud-send-otp

Cloud Send Otp Api

Request body

object

Responses

Example

curl -X POST http://localhost:8000/settings/cloud-send-otp \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /settings/cloud-status

Cloud Status

Return transport and entitlement independently. A missing WS session never means a missing subscription. Durable bearer auth reads entitlement when possible; paid instances self-heal only when the owner has not explicitly disconnected Cloud.

Responses

Example

curl -X GET http://localhost:8000/settings/cloud-status \
  -H "Authorization: Bearer $TOKEN"

POST /settings/cloud/billing-portal

Cloud Billing Portal

Create a Stripe Billing Portal session via the relay so the merchant can manage their subscription (cancel, change card, download invoices).

Responses

Example

curl -X POST http://localhost:8000/settings/cloud/billing-portal \
  -H "Authorization: Bearer $TOKEN"

GET /settings/connectors-catalog

Connectors Catalog Api

Proxy relay /api/connectors using a fresh relay JWT (API process only).

Responses

Example

curl -X GET http://localhost:8000/settings/connectors-catalog \
  -H "Authorization: Bearer $TOKEN"

GET /settings/connectors/{platform}/authorize-url

Connector Authorize Url

Get OAuth authorize URL for a connector platform via API process (holds gateway token).

Parameters

Responses

Example

curl -X GET http://localhost:8000/settings/connectors/:platform/authorize-url \
  -H "Authorization: Bearer $TOKEN"

POST /settings/partner-claim/accept

Partner Claim Accept

Accept a partner claim: the relay binds the relationship and pushes the new commercial context. Owner/admin only. Accepting a token that is no longer acceptable (already claimed or expired) is a relay 409, surfaced as a neutral not-available message, never a fabricated success. Never touches gateway_token.

Request body

object

Responses

Example

curl -X POST http://localhost:8000/settings/partner-claim/accept \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /settings/partner-claim/resolve

Partner Claim Resolve

Preview the partner identity behind a claim token. Owner/admin only. Binds nothing: a resolve leaves the install celerp_direct.

Request body

object

Responses

Example

curl -X POST http://localhost:8000/settings/partner-claim/resolve \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'