---
title: "Sync a folder now"
method: POST
path: "/v1/media-sync/{id}/sync"
tags: ["media-sync"]
---

# Sync a folder now

`POST /v1/media-sync/{id}/sync`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/media-sync/{id}/sync`
- Auth: HTTP bearer

Trigger an immediate sync of one connected folder, bounded to a fixed number of files for the run, and return a summary of what happened. This action is recorded in the activity log.

**Notes.**
- A failed run still answers 200: read `error`.

## Path parameters

- `id` string, required

## Response `200`

Success.

- object
  - `data` object, required
    - `imported` integer, required
    - `updated` integer, required
    - `removed` integer, required
    - `skipped` integer, required
    - `failed` integer, required
    - `caughtUp` boolean, required: False when more changes remain for the next run.
    - `error` string, nullable, required: Why the run stopped, in words; null when it did not.

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `404`: No synced folder with this id.
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/7c2741bcdb16?raw)