Skip to main content
Server path: /doppler-configs | Type: Application | PCID required: Yes

Tools


doppler_configs_add_trusted_ip

Add Parameters:
ParameterTypeRequiredDefaultDescription
projectstringYesThe project value
configstringYesThe config value
ipstringYesAn IP address or CIDR range

doppler_configs_clone

Clone Parameters:
ParameterTypeRequiredDefaultDescription
configstringYesName of the branch config being cloned.
namestringYesName of the new branch config.
projectstringYesUnique identifier for the project object.

doppler_configs_config_logs_get

Retrieve Parameters:
ParameterTypeRequiredDefaultDescription
projectstringYesUnique identifier for the project object.
configstringYesName of the config object.
logstringYesUnique identifier for the log object.

doppler_configs_config_logs_list

List Parameters:
ParameterTypeRequiredDefaultDescription
projectstringYesUnique identifier for the project object.
configstringYesName of the config object.
pageintegerNoPage number
per_pageintegerNoItems per page

doppler_configs_config_logs_rollback

Rollback Parameters:
ParameterTypeRequiredDefaultDescription
projectstringYesUnique identifier for the project object.
configstringYesName of the config object.
logstringYesUnique identifier for the log object.

doppler_configs_create

Create Parameters:
ParameterTypeRequiredDefaultDescription
environmentstringYesIdentifier for the environment object.
namestringYesName of the new branch config.
projectstringYesUnique identifier for the project object.

doppler_configs_delete

Delete Parameters:
ParameterTypeRequiredDefaultDescription
projectstringYesUnique identifier for the project.
configstringYesName of the config.

doppler_configs_delete_trusted_ip

Delete Parameters:
ParameterTypeRequiredDefaultDescription
projectstringYesThe project value
configstringYesThe config value
ipstringYesAn IP address or CIDR range

doppler_configs_dynamic_secrets_issue_lease

Issue Lease Parameters:
ParameterTypeRequiredDefaultDescription
configstringYesThe config where the dynamic secret is located
dynamic_secretstringYesThe name of the dynamic secret for which to issue this lease
projectstringYesThe project where the dynamic secret is located
ttl_secintegerYesThe number of seconds until this lease is automatically revoked

doppler_configs_dynamic_secrets_revoke_lease

Revoke Lease Parameters:
ParameterTypeRequiredDefaultDescription
configstringYesThe config where the dynamic secret is located
dynamic_secretstringYesThe name of the dynamic secret from which this lease was issued
projectstringYesThe project where the dynamic secret is located
slugstringYesThe slug of the lease to revoke

doppler_configs_get

Retrieve Parameters:
ParameterTypeRequiredDefaultDescription
projectstringYesUnique identifier for the project object.
configstringYesName of the config object.

doppler_configs_inheritable

Inheritable Parameters:
ParameterTypeRequiredDefaultDescription
configstringYesName of the config.
inheritablebooleanYesBoolean determining if the config is inheritable or not.
projectstringYesUnique identifier for the project object.

doppler_configs_inherits

Inherits Parameters:
ParameterTypeRequiredDefaultDescription
configstringYesName of the config object doing the inheriting.
inheritsobject[]YesArray of objects indicating which configs are being inherited.
projectstringYesUnique identifier for the project object of the config doing the inheriting.

doppler_configs_list

List Parameters:
ParameterTypeRequiredDefaultDescription
projectstringYesThe project’s name
environmentstringNo(optional) the environment from which to list configs
pageintegerNoPage number
per_pageintegerNoItems per page

doppler_configs_list_trusted_ips

List Parameters:
ParameterTypeRequiredDefaultDescription
projectstringYesThe project value
configstringYesThe config value

doppler_configs_lock

Lock Parameters:
ParameterTypeRequiredDefaultDescription
configstringYesName of the config.
projectstringYesUnique identifier for the project object.

doppler_configs_secrets_delete

Delete Parameters:
ParameterTypeRequiredDefaultDescription
projectstringYesUnique identifier for the project object.
configstringYesName of the config object.
namestringYesName of the secret.

doppler_configs_secrets_download

Download Parameters:
ParameterTypeRequiredDefaultDescription
projectstringYesUnique identifier for the project object. Not required if using a Service Token.
configstringYesName of the config object. Not required if using a Service Token.
formatstringNoThe format value
name_transformerstringNoTransform secret names to a different case
include_dynamic_secretsbooleanNoWhether or not to issue leases and include dynamic secret values for the config
dynamic_secrets_ttl_secintegerNoThe number of seconds until dynamic leases expire. Must be used with include_dynamic_secrets. Defaults to 1800 (30 minutes).
secretsstringNoComma-delimited list of secrets to include in the download. Defaults to all secrets if left unspecified.

doppler_configs_secrets_get

Retrieve Parameters:
ParameterTypeRequiredDefaultDescription
projectstringYesUnique identifier for the project object.
configstringYesName of the config object.
namestringYesName of the secret.

doppler_configs_secrets_list

List Parameters:
ParameterTypeRequiredDefaultDescription
projectstringYesUnique identifier for the project object.
configstringYesName of the config object.
include_dynamic_secretsbooleanNoWhether or not to issue leases and include dynamic secret values for the config
dynamic_secrets_ttl_secintegerNoThe number of seconds until dynamic leases expire. Must be used with include_dynamic_secrets. Defaults to 1800 (30 minutes).
secretsstringNoA comma-separated list of secrets to include in the response
include_managed_secretsbooleanNoWhether to include Doppler’s auto-generated (managed) secrets

doppler_configs_secrets_names

List Names Parameters:
ParameterTypeRequiredDefaultDescription
projectstringYesUnique identifier for the project object.
configstringYesName of the config object.
include_dynamic_secretsbooleanNoWhether or not to issue leases and include dynamic secret values for the config
include_managed_secretsbooleanNoWhether to include Doppler’s auto-generated (managed) secrets

doppler_configs_secrets_update

Update Parameters:
ParameterTypeRequiredDefaultDescription
change_requestsobject[]NoEither secrets or change_requests is required (can’t use both). Object of secrets you would like to save to the config. Try it with the sample secrets below.
configstringYesName of the config object.
projectstringYesUnique identifier for the project object.
secretsobjectNoEither secrets or change_requests is required (can’t use both). Object of secrets you would like to save to the config. Try it with the sample secrets below.

doppler_configs_service_tokens_create

Create Parameters:
ParameterTypeRequiredDefaultDescription
accessstringNoToken’s capabilities.
configstringYesName of the config object.
expire_atstringNoUnix timestamp of when token should expire.
namestringYesName of the service token.
projectstringYesUnique identifier for the project object.

doppler_configs_service_tokens_delete

Delete Parameters:
ParameterTypeRequiredDefaultDescription
configstringYesName of the config object.
projectstringYesUnique identifier for the project object.
slugstringNoThe slug of the service token.
tokenstringNoThe token value.

doppler_configs_service_tokens_list

List Parameters:
ParameterTypeRequiredDefaultDescription
projectstringYesUnique identifier for the project object.
configstringYesName of the config object.

doppler_configs_syncs_create

Create Parameters:
ParameterTypeRequiredDefaultDescription
projectstringYesThe project slug
configstringYesThe config slug
await_initial_syncbooleanNoCauses sync creation to wait for the initial sync to complete before returning.
dataobjectYesConfiguration data for the sync
import_optionstringNoAn option indicating if and how Doppler should attempt to import secrets from the sync destination
integrationstringYesThe integration slug which the sync will use

doppler_configs_syncs_delete

Delete Parameters:
ParameterTypeRequiredDefaultDescription
projectstringYesThe project slug
configstringYesThe config slug
syncstringYesThe sync slug
delete_from_targetbooleanYesWhether or not to delete the synced data from the target integration

doppler_configs_syncs_get

Retrieve Parameters:
ParameterTypeRequiredDefaultDescription
projectstringYesThe project slug
configstringYesThe config slug
syncstringYesThe sync slug

doppler_configs_unlock

Unlock Parameters:
ParameterTypeRequiredDefaultDescription
configstringYesName of the config.
projectstringYesUnique identifier for the project object.

doppler_configs_update

Update Parameters:
ParameterTypeRequiredDefaultDescription
configstringYesName of the config object.
namestringYesThe new name of config.
projectstringYesUnique identifier for the project object.