---
title: "PATCH /api/v1/secret-syncs/portainer/{syncId}"
method: PATCH
path: "/api/v1/secret-syncs/portainer/{syncId}"
tags: ["Secret Syncs"]
---

# PATCH /api/v1/secret-syncs/portainer/{syncId}

`PATCH /api/v1/secret-syncs/portainer/{syncId}`

## Request

- Base URL: `https://us.infisical.com`
- URL: `https://us.infisical.com/api/v1/secret-syncs/portainer/{syncId}`
- Auth: none declared

Update the specified Portainer Sync.

## Path parameters

- `syncId` string, uuid, required

## Request body

- object
  - `name` string: The updated name of the Portainer Sync. Must be slug-friendly.
  - `connectionId` string, uuid: The updated ID of the Portainer Connection to use for syncing.
  - `description` string, nullable: The updated description of the Portainer Sync.
  - `environment` string: The updated slug of the project environment to sync secrets from.
  - `secretPath` string: The updated folder path to sync secrets from.
  - `isAutoSyncEnabled` boolean: Whether secrets should be automatically synced when changes occur at the source location or not.
  - `syncOptions` object: 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 Portainer destination.
    - `keySchema` string: Specify the format to use for structuring secret keys in the Portainer destination.
    - `disableSecretDeletion` boolean: Enable this flag to prevent removal of secrets from the Portainer destination when syncing.
    - `includeAllSubFolders` boolean: Whether to sync secrets from folders beneath the source path as well.
  - `destinationConfig` object
    - `environmentId` integer, required: The ID of the Portainer environment (endpoint) that hosts the stack.
    - `stackId` integer, required: The ID of the Portainer stack to sync secrets to.

## 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 Portainer destination.
      - `keySchema` string: Specify the format to use for structuring secret keys in the Portainer destination.
      - `disableSecretDeletion` boolean: Enable this flag to prevent removal of secrets from the Portainer destination when syncing.
      - `includeAllSubFolders` boolean: Whether to sync secrets from folders beneath the source path as well.
    - `connection` object, required
      - `app` 'portainer', 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` 'portainer', required
    - `destinationConfig` object, required
      - `environmentId` integer, required: The ID of the Portainer environment (endpoint) that hosts the stack.
      - `stackId` integer, required: The ID of the Portainer stack to sync secrets to.

## Other responses

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

## Changes

- **2026-10-15** `d737fe2eced6`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/infisical/apis/infisical-api/changes/api/v1/secret-syncs/portainer/:syncId/patch.md)

---

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