Create a new secrets sync.

General

Each sync integration type has its own configuration parameters which must be provided in the data field. Some parameter values are completely user-defined (e.g. AWS Secret Manager path) but others are identifiers from the external service (e.g. Fly.io app ID). You can use the Integration > Get Options endpoint to fetch all available options for a particular integration.

Below are the data fields for each integration type:

AWS Secrets Manager

FieldTypeDescription
pathstringThe path of the AWS Secret Manager secret
regionstringThe AWS region to create the secret (e.g. us-east-1)
tagsobject<string, string> (optional)Tags to attach to the AWS secrets

AWS Parameter Store

FieldTypeDescription
pathstringThe path of the parameters in AWS
regionstringThe AWS region to create the secret (e.g. us-east-1)
tagsobject<string, string> (optional)Tags to attach to the parameters
secure_stringboolean (optional)Whether or not the parameters should be created as secure strings (defaults to true)

CircleCI

FieldTypeDescription
resource_typestringEither "project" or "context", based on the resource type to sync to
resource_idstringThe resource ID (either project or context) to sync to
organization_slugstringThe organization slug where the resource is located

Fly.io

FieldTypeDescription
app_idstringThe Fly.io app ID to sync to
restart_machinesbooleanWhether or not Doppler should automatically restart Fly.io machines after secrets are synced

Heroku

FieldTypeDescription
project_typestringEither "app" or "pipeline", based on the resource type to sync to
pipeline_idstring (pipeline only)The Heroku pipeline ID to sync to
stagestring (pipeline only)The Heroku pipeline stage to sync to
app_idstring (app only)The Heroku app ID to sync to

Terraform Cloud

FieldTypeDescription
sync_targetstringEither "workspace" or "variableSet", based on the resource type to sync to
workspace_idstring (workspace only)The Terraform Cloud workspace ID to sync to
variable_set_idstring (variable set only)The Terraform Cloud variable set ID to sync to
variable_sync_typestringEither "terraform" to sync secrets as Terraform variables or "env" to sync as environment variables
name_transformstringA name transform to apply before syncing secrets: "none" or "lowercase"
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!