Skip to main content
POST
cURL

Body

application/json
name
string
required

The name of the Chef Sync to create. Must be slug-friendly.

Required string length: 1 - 256
projectId
string
required

The ID of the project to create the sync in.

Minimum string length: 1
connectionId
string<uuid>
required

The ID of the Chef Connection to use for syncing.

environment
string
required

The slug of the project environment to sync secrets from.

Required string length: 1 - 64
secretPath
string
required

The folder path to sync secrets from.

Minimum string length: 1
syncOptions
object
required

Optional parameters to modify how secrets are synced.

destinationConfig
object
required
description
string | null

An optional description for the Chef Sync.

Maximum string length: 256
isAutoSyncEnabled
boolean
default:true

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

Response

Default Response

secretSync
Chef · object
required