Connectors API

GET /connectors/

List Connectors

Responses

Example

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

GET /connectors/{connector_name}/access-token

Connector Access Token

Return a short-lived decrypted access token from the relay. Returns the relay payload ({access_token, store_handle, ...}) on success, else {"error": <code>, "detail": str} with error codes: not_connected, session_invalid, subscription_required, relay_error.

Parameters

Responses

Example

curl -X GET http://localhost:8000/connectors/:connector_name/access-token \
  -H "Authorization: Bearer $TOKEN"

POST /connectors/{connector_name}/credentials

Store Credentials

Validate API-key credentials against the store, then store them on the relay. Returns {"ok": True} on success, else {"ok": False, "error": <code>, "detail": str} with error codes: store_rejected, store_unreachable, subscription_required, relay_not_https, relay_error.

Parameters

Request body

Responses

Example

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

DELETE /connectors/{connector_name}/credentials

Revoke Credentials

Revoke stored connector credentials on the relay (disconnect). A 404 from the relay means nothing was stored - already disconnected, so ok.

Parameters

Responses

Example

curl -X DELETE http://localhost:8000/connectors/:connector_name/credentials \
  -H "Authorization: Bearer $TOKEN"

POST /connectors/{connector_name}/sync

Trigger Sync

Parameters

Request body

Responses

Example

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