Sync Scheduler Config — Admin API | HNU-TimeLetter

The sync configuration API lets you inspect and update the Feishu data sync scheduler without restarting the server. You can read the current cron schedule, toggle the scheduler on or off, and change which tables are synced by default. All changes take effect immediately via hot-reload.

SyncTableKey reference

Each SyncTableKey value maps to a Feishu Bitable table and writes to a specific JSON output file read by the frontend runtime API.

Key	Feishu Table	Output File
`locations`	地点表	`src/config/locations.json`
`stories`	故事表	`src/data/content.json`
`creation_headers`	创作板-头表	`src/data/creation-board-headers.json`
`creation_board`	创作板-主表	`src/data/creation-board.json`
`contributors`	参与贡献名单	`src/data/contributors.json`

GET /api/admin/sync/config

Returns the current scheduler configuration, runtime state, available table definitions, and next scheduled run time. Authentication: admin_auth cookie required. Returns 401 Unauthorized if absent or invalid.

Response fields

config

object

required

Persisted scheduler configuration.

Show config fields

config.enabled

boolean

required

Whether the cron scheduler is currently enabled.

config.cron

string

required

The cron expression that controls when automatic syncs fire (e.g. "0 2 * * *" for 02:00 UTC daily).

config.defaultTables

SyncTableKey[]

required

The list of tables synced when the scheduler fires automatically. Must contain at least one entry.

runtime

object

required

Live scheduler state — updated as jobs run.

Show runtime fields

runtime.currentJobId

string | null

required

Job ID of the sync task currently executing, or null when idle.

runtime.lastJobId

string | null

required

Job ID of the most recently completed sync task, or null if no job has ever run.

runtime.lastRunAt

string | null

required

ISO 8601 timestamp of when the last sync finished, or null if no job has ever run.

availableTables

TableDefinition[]

required

All tables the system supports. Use the key values when setting defaultTables or creating jobs.

Show TableDefinition fields

availableTables[].key

SyncTableKey

required

The unique identifier for this table (e.g. "locations").

availableTables[].label

string

required

Human-readable display name (e.g. "地点表").

availableTables[].dependsOn

SyncTableKey[]

required

Other table keys this table depends on. Empty array means no dependencies.

nextRunAt

string | null

required

ISO 8601 timestamp of when the scheduler will next fire. null when config.enabled is false.

Example response

{
  "config": {
    "enabled": true,
    "cron": "0 2 * * *",
    "defaultTables": ["locations", "stories", "creation_headers", "creation_board", "contributors"]
  },
  "runtime": {
    "currentJobId": null,
    "lastJobId": "sync_20260430100000_ab12cd",
    "lastRunAt": "2026-04-30T10:00:00.000Z"
  },
  "availableTables": [
    { "key": "locations",         "label": "地点表",           "dependsOn": [] },
    { "key": "stories",           "label": "故事表",           "dependsOn": [] },
    { "key": "creation_headers",  "label": "创作板-头表",       "dependsOn": [] },
    { "key": "creation_board",    "label": "创作板-主表",       "dependsOn": [] },
    { "key": "contributors",      "label": "参与贡献名单",      "dependsOn": [] }
  ],
  "nextRunAt": "2026-04-30T18:00:00.000Z"
}

curl example

curl -X GET https://himematsu.cn/api/admin/sync/config \
  --cookie "admin_auth=<YOUR_SESSION_COOKIE>"

PATCH /api/admin/sync/config

Updates one or more scheduler settings. All fields are optional — only include the fields you want to change. The scheduler is hot-reloaded immediately; no server restart is required. Authentication: admin_auth cookie required.

Request body

enabled

boolean

Set to true to activate the cron scheduler, false to pause it. Omit to leave unchanged.

cron

string

A valid cron expression with at least 5 space-separated segments (e.g. "0 */6 * * *" for every 6 hours). Omit to leave unchanged.

defaultTables

SyncTableKey[]

Replaces the full list of tables synced by the scheduler. Must contain at least one valid SyncTableKey — an empty array is rejected with 400. Omit to leave unchanged.

Responses

200 OK — Returns the same structure as GET /api/admin/sync/config, reflecting the updated state. 400 Bad Request — Returned when an unrecognised table key is supplied or the cron expression is malformed.

{ "message": "不支持的同步表: unknown_table" }

401 Unauthorized — Missing or invalid admin_auth cookie.

{ "message": "Unauthorized" }

curl examples

Disable the scheduler:

curl -X PATCH https://himematsu.cn/api/admin/sync/config \
  --cookie "admin_auth=<YOUR_SESSION_COOKIE>" \
  -H "Content-Type: application/json" \
  -d '{ "enabled": false }'

Change the cron schedule to every 6 hours and update the default tables:

curl -X PATCH https://himematsu.cn/api/admin/sync/config \
  --cookie "admin_auth=<YOUR_SESSION_COOKIE>" \
  -H "Content-Type: application/json" \
  -d '{
    "cron": "0 */6 * * *",
    "defaultTables": ["locations", "stories"]
  }'

Overview

Admin API

Frontend API

Sync Scheduler Config — Admin API | HNU-TimeLetter

SyncTableKey reference

GET /api/admin/sync/config

Response fields

Example response

curl example

PATCH /api/admin/sync/config

Request body

Responses

curl examples

Build docs developers (and LLMs) love

Overview

Admin API

Frontend API

Documentation Index

​SyncTableKey reference

​GET /api/admin/sync/config

​Response fields

​Example response

​curl example

​PATCH /api/admin/sync/config

​Request body

​Responses

​curl examples

Build docs developers (and LLMs) love

SyncTableKey reference

GET /api/admin/sync/config

Response fields

Example response

curl example

PATCH /api/admin/sync/config

Request body

Responses

curl examples