# `PhoenixKit.Modules.Sync.Web.ApiController`
[🔗](https://github.com/BeamLabEU/phoenix_kit/blob/v1.7.71/lib/modules/sync/web/api_controller.ex#L1)

API controller for Sync cross-site operations.

Handles incoming connection registration requests from remote PhoenixKit sites.
When a remote site creates a sender connection pointing to this site, they call
this API to automatically register the connection here.

## Security

- Incoming connection mode controls how requests are handled
- Optional password protection for incoming connections
- All connections are logged with remote site information

## Endpoints

- `POST /{prefix}/sync/api/register-connection` - Register incoming connection

# `delete_connection`
[🔗](https://github.com/BeamLabEU/phoenix_kit/blob/v1.7.71/lib/modules/sync/web/api_controller.ex#L140)

Deletes a connection when requested by the remote site.

Called when a receiver deletes their connection - the sender should also delete.

Expected JSON body:
- `sender_url` (required) - URL of the site sending this request
- `auth_token_hash` (required) - The auth token hash to identify the connection

## Responses

- 200 OK - Connection deleted successfully
- 404 Not Found - Connection not found
- 503 Service Unavailable - DB Sync module is disabled

# `get_connection_status`
[🔗](https://github.com/BeamLabEU/phoenix_kit/blob/v1.7.71/lib/modules/sync/web/api_controller.ex#L310)

Returns the current status of a connection.

Called by receiver to get the sender's current connection status.
This allows receivers to sync their status with the sender.

Expected JSON body:
- `receiver_url` (required) - URL of the receiver site requesting status
- `auth_token_hash` (required) - The auth token hash to identify the connection

## Responses

- 200 OK - Returns connection status
- 404 Not Found - Connection not found
- 503 Service Unavailable - DB Sync module is disabled

# `list_tables`
[🔗](https://github.com/BeamLabEU/phoenix_kit/blob/v1.7.71/lib/modules/sync/web/api_controller.ex#L372)

Lists available tables for sync.

Called by receiver to get a list of tables that can be synced from this sender.

Expected JSON body:
- `auth_token_hash` (required) - The auth token hash to identify the connection

## Responses

- 200 OK - Returns list of tables with row counts and sizes
- 401 Unauthorized - Invalid auth token
- 503 Service Unavailable - DB Sync module is disabled

# `pull_data`
[🔗](https://github.com/BeamLabEU/phoenix_kit/blob/v1.7.71/lib/modules/sync/web/api_controller.ex#L425)

Pulls data for a specific table.

Called by receiver to fetch table data during sync.

Expected JSON body:
- `auth_token_hash` (required) - The auth token hash to identify the connection
- `table_name` (required) - Name of the table to pull
- `conflict_strategy` (optional) - How to handle conflicts (skip, overwrite, merge)

## Responses

- 200 OK - Returns table data
- 401 Unauthorized - Invalid auth token
- 404 Not Found - Table not found
- 503 Service Unavailable - DB Sync module is disabled

# `register_connection`
[🔗](https://github.com/BeamLabEU/phoenix_kit/blob/v1.7.71/lib/modules/sync/web/api_controller.ex#L48)

Registers an incoming connection from a remote site.

Expected JSON body:
- `sender_url` (required) - URL of the site sending this request
- `connection_name` (required) - Name for the connection
- `auth_token` (required) - The auth token for the connection
- `password` (optional) - Password if this site requires one

## Responses

- 200 OK - Connection registered successfully
- 400 Bad Request - Missing required fields
- 401 Unauthorized - Invalid password
- 403 Forbidden - Incoming connections are denied
- 409 Conflict - Connection already exists for this site
- 503 Service Unavailable - DB Sync module is disabled

# `status`
[🔗](https://github.com/BeamLabEU/phoenix_kit/blob/v1.7.71/lib/modules/sync/web/api_controller.ex#L113)

Health check endpoint for DB Sync API.

Returns whether the module is enabled and accepting connections.

# `table_records`
[🔗](https://github.com/BeamLabEU/phoenix_kit/blob/v1.7.71/lib/modules/sync/web/api_controller.ex#L565)

Returns records from a specific table for preview.

Expected JSON body:
- `auth_token_hash` - Hash of the auth token
- `table_name` - Name of the table
- `limit` - Maximum number of records (default: 10)
- `offset` - Offset for pagination (default: 0)
- `ids` (optional) - List of specific IDs to fetch
- `id_start`, `id_end` (optional) - ID range filter

Returns:
- 200 OK with records
- 401 Unauthorized
- 404 Not Found

# `table_schema`
[🔗](https://github.com/BeamLabEU/phoenix_kit/blob/v1.7.71/lib/modules/sync/web/api_controller.ex#L507)

Returns schema for a specific table.

Expected JSON body:
- `auth_token_hash` - Hash of the auth token
- `table_name` - Name of the table

Returns:
- 200 OK with schema data
- 401 Unauthorized
- 404 Not Found

# `update_status`
[🔗](https://github.com/BeamLabEU/phoenix_kit/blob/v1.7.71/lib/modules/sync/web/api_controller.ex#L196)

Updates the status of a connection when notified by the sender.

Called when the sender suspends, reactivates, or revokes their connection.
The receiver should mirror the status change.

Expected JSON body:
- `sender_url` (required) - URL of the site sending this request
- `auth_token_hash` (required) - The auth token hash to identify the connection
- `status` (required) - The new status ("active", "suspended", "revoked")

## Responses

- 200 OK - Status updated successfully
- 404 Not Found - Connection not found
- 503 Service Unavailable - DB Sync module is disabled

# `verify_connection`
[🔗](https://github.com/BeamLabEU/phoenix_kit/blob/v1.7.71/lib/modules/sync/web/api_controller.ex#L268)

Verifies a connection still exists.

Called by sender to check if receiver still has the connection.
Used for self-healing when the receiver was offline during delete.

Expected JSON body:
- `sender_url` (required) - URL of the site sending this request
- `auth_token_hash` (required) - The auth token hash to identify the connection

## Responses

- 200 OK - Connection exists
- 404 Not Found - Connection not found (deleted)
- 503 Service Unavailable - DB Sync module is disabled

---

*Consult [api-reference.md](api-reference.md) for complete listing*