v4

latestOpenAPI 3.0.32026-07-312,317012.2 MB
Secret Syncs

Create a CircleCI Sync for the specified project environment.

post/api/v1/secret-syncs/circleci

Request body

namestring required

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

projectIdstring required

The ID of the project to create the sync in.

descriptionstring nullable

An optional description for the CircleCI Sync.

connectionIdstring uuid required

The ID of the CircleCI Connection to use for syncing.

environmentstring required

The slug of the project environment to sync secrets from.

secretPathstring required

The folder path to sync secrets from.

isAutoSyncEnabledboolean

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

Response

Default Response