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

# PATCH /api/v1/secret-syncs/octopus-deploy/{syncId}

`PATCH /api/v1/secret-syncs/octopus-deploy/{syncId}`

Update the specified Octopus Deploy Sync.

## Path parameters

- `syncId` string, uuid, required

## Request body

- object
  - `name` string — The updated name of the Octopus Deploy Sync. Must be slug-friendly.
  - `connectionId` string, uuid — The updated ID of the Octopus Deploy Connection to use for syncing.
  - `description` string, nullable — The updated description of the Octopus Deploy 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', required — Specify how Infisical should resolve the initial sync to the Octopus Deploy destination.
    - `keySchema` string — Specify the format to use for structuring secret keys in the Octopus Deploy destination.
    - `disableSecretDeletion` boolean — Enable this flag to prevent removal of secrets from the Octopus Deploy destination when syncing.
  - `destinationConfig` object
    - `spaceId` string, required — The ID of the Octopus Deploy space to sync secrets to.
    - `spaceName` string — The name of the Octopus Deploy space to sync secrets to.
    - `scope` 'project', required
    - `projectId` string, required — The ID of the Octopus Deploy project to sync secrets to.
    - `projectName` string — The name of the Octopus Deploy project to sync secrets to.
    - `scopeValues` object — The Octopus Deploy scope values that secrets should be synced to.
      - `environments` string[]
      - `roles` string[]
      - `machines` string[]
      - `processes` string[]
      - `actions` string[]
      - `channels` string[]

## 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', required — Specify how Infisical should resolve the initial sync to the Octopus Deploy destination.
      - `keySchema` string — Specify the format to use for structuring secret keys in the Octopus Deploy destination.
      - `disableSecretDeletion` boolean — Enable this flag to prevent removal of secrets from the Octopus Deploy destination when syncing.
    - `connection` object, required
      - `app` 'octopus-deploy', 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` 'octopus-deploy', required
    - `destinationConfig` object, required
      - `spaceId` string, required — The ID of the Octopus Deploy space to sync secrets to.
      - `spaceName` string — The name of the Octopus Deploy space to sync secrets to.
      - `scope` 'project', required
      - `projectId` string, required — The ID of the Octopus Deploy project to sync secrets to.
      - `projectName` string — The name of the Octopus Deploy project to sync secrets to.
      - `scopeValues` object — The Octopus Deploy scope values that secrets should be synced to.
        - `environments` string[]
        - `roles` string[]
        - `machines` string[]
        - `processes` string[]
        - `actions` string[]
        - `channels` string[]

## 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/885aef3e6c11/schema)