---
search:
  tags:
    - livesync
    - POST
seo:
  description: >-
    Create a livesync session and deploy it. Reference for the POST
    /api/v1/livesync endpoint in the TimescaleDB Enterprise API.
sidebar:
  label: Create a livesync session
  badge: POST
title: Create a livesync session
type: openapi-operation
---
Create a livesync session and deploy it.

`POST /api/v1/livesync`

**Request body** (`application/json`, required)

- `auto_add_tables` (boolean)
- `create_publication` (boolean)
- `host_server_id` (string)
- `name` (string)
- `publication` (string)
- `publication_tables` (string[])
- `source_cluster_id` (string)
- `source_conn` (string)
- `subscription` (string)
- `sync_schema` (boolean)
- `target_cluster_id` (string)
- `target_conn` (string)

Request body example:

```json
{
  "auto_add_tables": true,
  "create_publication": true,
  "host_server_id": "string",
  "name": "string",
  "publication": "string",
  "publication_tables": [
    "string"
  ],
  "source_cluster_id": "string",
  "source_conn": "string",
  "subscription": "string",
  "sync_schema": true,
  "target_cluster_id": "string",
  "target_conn": "string"
}
```

**Responses**

- `202` — Accepted
- `default` — Error

Response example, 202:

```json
{
  "auto_add_tables": true,
  "created_at": "string",
  "health": "string",
  "health_checked_at": "string",
  "health_detail": "string",
  "host_display": "string",
  "host_server_id": "string",
  "id": "string",
  "name": "string",
  "publication": "string",
  "publication_managed": true,
  "source_cluster_id": "string",
  "source_display": "string",
  "status": "string",
  "subscription": "string",
  "target_cluster_id": "string",
  "target_display": "string"
}
```
