---
title: "POST /api/v1/secret-syncs/vercel/{syncId}/sync-secrets"
method: POST
path: "/api/v1/secret-syncs/vercel/{syncId}/sync-secrets"
tags: ["Secret Syncs"]
---

# POST /api/v1/secret-syncs/vercel/{syncId}/sync-secrets

`POST /api/v1/secret-syncs/vercel/{syncId}/sync-secrets`

Trigger a sync for the specified Vercel Sync.

## Path parameters

- `syncId` string, uuid, required

## Response `200`

Default Response

- object
  - `secretSync` object, required
    - `id` string, uuid, required
    - `name` string, required
    - `description` string, nullable
    - `isAutoSyncEnabled` boolean
    - `version` number
    - `projectId` string, required
    - `folderId` string, uuid, nullable
    - `connectionId` string, uuid, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `syncStatus` string, nullable
    - `lastSyncJobId` string, nullable
    - `lastSyncMessage` string, nullable
    - `lastSyncedAt` string, date-time, nullable
    - `importStatus` string, nullable
    - `lastImportJobId` string, nullable
    - `lastImportMessage` string, nullable
    - `lastImportedAt` string, date-time, nullable
    - `removeStatus` string, nullable
    - `lastRemoveJobId` string, nullable
    - `lastRemoveMessage` string, nullable
    - `lastRemovedAt` string, date-time, nullable
    - `syncOptions` object, required — Optional parameters to modify how secrets are synced.
      - `initialSyncBehavior` 'overwrite-destination' | 'import-prioritize-source' | 'import-prioritize-destination', required — Specify how Infisical should resolve the initial sync to the Vercel destination.
      - `keySchema` string — Specify the format to use for structuring secret keys in the Vercel destination.
      - `disableSecretDeletion` boolean — Enable this flag to prevent removal of secrets from the Vercel destination when syncing.
    - `connection` object, required
      - `app` 'vercel', required
      - `name` string, required
      - `id` string, uuid, required
    - `environment` object, nullable, required
      - `slug` string, required
      - `name` string, required
      - `id` string, uuid, required
    - `folder` object, nullable, required
      - `id` string, required
      - `path` string, required
    - `destination` 'vercel', required
    - `destinationConfig` union, required
      - object
        - `scope` 'project', required
        - `app` string, required — The ID of the Vercel app to sync secrets to.
        - `appName` string, required — The name of the Vercel app to sync secrets to.
        - `env` union, required — The ID of the Vercel environment to sync secrets to.
          - 'development' | 'preview' | 'production'
          - string
        - `branch` string — The branch to sync preview secrets to.
        - `teamId` string, required — The ID of the Vercel team to sync secrets to.
        - `sensitive` boolean — Whether to create Vercel environment variables as Sensitive (cannot be read back). Not allowed when targeting the Development environment.
      - object
        - `scope` 'team', required
        - `teamId` string, required — The ID of the Vercel team to sync secrets to.
        - `teamName` string — The name of the team to sync the secrets to. This is an optional field only intended for display purposes.
        - `targetEnvironments` string[] — An optional array of Vercel default environments (development, preview, production) to add shared environment variables to.
        - `applyToAllCustomEnvironments` boolean — Whether to apply shared environment variables to all custom environments in the team.
        - `targetProjects` string[] — An optional array of Vercel projects to add shared environment variables to.
        - `sensitive` boolean — Whether to create Vercel environment variables as Sensitive (cannot be read back). Not allowed when targeting the Development environment.

## Other responses

- `400` — Default Response
- `401` — Default Response
- `403` — Default Response
- `404` — Default Response
- `422` — Default Response
- `500` — Default Response

---

[API](https://skmtc.net/infisical/apis/infisical-api.md) · [All operations](https://skmtc.net/infisical/apis/infisical-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/infisical/infisical-api/versions/f10a4f8c1d41/schema)
