---
title: "Sync retrieval source"
method: POST
path: "/v1/projects/{project_id}/retrieval/sources/{source_id}/sync"
tags: ["retrieval"]
---

# Sync retrieval source

`POST /v1/projects/{project_id}/retrieval/sources/{source_id}/sync`

## Request

- Base URL: `https://api.connic.co`
- URL: `https://api.connic.co/v1/projects/{project_id}/retrieval/sources/{source_id}/sync`
- Auth: HTTP bearer

Queue a manual sync for a retrieval source, regardless of its sync interval.

The sync is recorded as a run with trigger `manual`. If a sync of this source is already running, no extra run starts.

Required permission: `retrieval.manage`.

## Path parameters

- `project_id` string, uuid, required
- `source_id` string, uuid, required

## Query parameters

- `environment_id` string, uuid, required: Environment ID from `GET /environments`.

## Response `200`

Successful Response

- PublicRetrievalSyncResponse
  - `queued` boolean, required: True when a sync was queued.

## Other responses

- `401`: Missing or invalid API key.
- `403`: The API key lacks the required permission or access to the environment.
- `404`: The resource does not exist in this project.
- `422`: Validation Error
- `429`: Rate limit exceeded.

---

[API](https://skmtc.dev/connic/apis/connic-api.md) · [All operations](https://skmtc.dev/connic/apis/connic-api/llms.txt) · [OpenAPI document](https://skmtc.dev/connic/apis/connic-api/revisions/482932da5fbe?raw)
