---
title: "Sync a data source now"
method: POST
path: "/v1/data-sources/{id}/sync"
tags: ["data-sources"]
---

# Sync a data source now

`POST /v1/data-sources/{id}/sync`

## Request

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

Pull fresh data for one data source immediately instead of waiting for its regular schedule.

Runs the connector once and caches the result. A connector failure is NOT an HTTP error: the answer is 200 with `synced: false` and the reason.

## Path parameters

- `id` string, required

## Response `200`

Success.

- object
  - `data` union, required
    - object
      - `id` string, required
      - `synced` true, required
    - object
      - `id` string, required
      - `synced` false, required
      - `error` string, required: Why the connector failed. Also stored as the source's `syncError`.

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `404`: No such data source in this workspace.
- `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/02fd3665dc7d?raw)