PATCH /api/v1/secret-syncs/octopus-deploy/:syncId

v5

OpenAPI 3.0.32026-08-052,281012.1 MB

Secret Syncs

Update the specified Octopus Deploy Sync.

patch/api/v1/secret-syncs/octopus-deploy/{syncId}

syncIdstring uuid required

The ID of the Octopus Deploy Sync to be updated.

namestring

The updated name of the Octopus Deploy Sync. Must be slug-friendly.

connectionIdstring uuid

The updated ID of the Octopus Deploy Connection to use for syncing.

descriptionstring nullable

The updated description of the Octopus Deploy Sync.

environmentstring

The updated slug of the project environment to sync secrets from.

secretPathstring

The updated folder path to sync secrets from.

isAutoSyncEnabledboolean

Whether secrets should be automatically synced when changes occur at the source location or not.

Default Response