/doppler-configs | Type: Application | PCID required: Yes
Tools
doppler_configs_add_trusted_ip
Add Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project | string | Yes | — | The project value |
config | string | Yes | — | The config value |
ip | string | Yes | — | An IP address or CIDR range |
doppler_configs_clone
Clone Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
config | string | Yes | — | Name of the branch config being cloned. |
name | string | Yes | — | Name of the new branch config. |
project | string | Yes | — | Unique identifier for the project object. |
doppler_configs_config_logs_get
Retrieve Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project | string | Yes | — | Unique identifier for the project object. |
config | string | Yes | — | Name of the config object. |
log | string | Yes | — | Unique identifier for the log object. |
doppler_configs_config_logs_list
List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project | string | Yes | — | Unique identifier for the project object. |
config | string | Yes | — | Name of the config object. |
page | integer | No | — | Page number |
per_page | integer | No | — | Items per page |
doppler_configs_config_logs_rollback
Rollback Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project | string | Yes | — | Unique identifier for the project object. |
config | string | Yes | — | Name of the config object. |
log | string | Yes | — | Unique identifier for the log object. |
doppler_configs_create
Create Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
environment | string | Yes | — | Identifier for the environment object. |
name | string | Yes | — | Name of the new branch config. |
project | string | Yes | — | Unique identifier for the project object. |
doppler_configs_delete
Delete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project | string | Yes | — | Unique identifier for the project. |
config | string | Yes | — | Name of the config. |
doppler_configs_delete_trusted_ip
Delete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project | string | Yes | — | The project value |
config | string | Yes | — | The config value |
ip | string | Yes | — | An IP address or CIDR range |
doppler_configs_dynamic_secrets_issue_lease
Issue Lease Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
config | string | Yes | — | The config where the dynamic secret is located |
dynamic_secret | string | Yes | — | The name of the dynamic secret for which to issue this lease |
project | string | Yes | — | The project where the dynamic secret is located |
ttl_sec | integer | Yes | — | The number of seconds until this lease is automatically revoked |
doppler_configs_dynamic_secrets_revoke_lease
Revoke Lease Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
config | string | Yes | — | The config where the dynamic secret is located |
dynamic_secret | string | Yes | — | The name of the dynamic secret from which this lease was issued |
project | string | Yes | — | The project where the dynamic secret is located |
slug | string | Yes | — | The slug of the lease to revoke |
doppler_configs_get
Retrieve Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project | string | Yes | — | Unique identifier for the project object. |
config | string | Yes | — | Name of the config object. |
doppler_configs_inheritable
Inheritable Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
config | string | Yes | — | Name of the config. |
inheritable | boolean | Yes | — | Boolean determining if the config is inheritable or not. |
project | string | Yes | — | Unique identifier for the project object. |
doppler_configs_inherits
Inherits Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
config | string | Yes | — | Name of the config object doing the inheriting. |
inherits | object[] | Yes | — | Array of objects indicating which configs are being inherited. |
project | string | Yes | — | Unique identifier for the project object of the config doing the inheriting. |
doppler_configs_list
List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project | string | Yes | — | The project’s name |
environment | string | No | — | (optional) the environment from which to list configs |
page | integer | No | — | Page number |
per_page | integer | No | — | Items per page |
doppler_configs_list_trusted_ips
List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project | string | Yes | — | The project value |
config | string | Yes | — | The config value |
doppler_configs_lock
Lock Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
config | string | Yes | — | Name of the config. |
project | string | Yes | — | Unique identifier for the project object. |
doppler_configs_secrets_delete
Delete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project | string | Yes | — | Unique identifier for the project object. |
config | string | Yes | — | Name of the config object. |
name | string | Yes | — | Name of the secret. |
doppler_configs_secrets_download
Download Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project | string | Yes | — | Unique identifier for the project object. Not required if using a Service Token. |
config | string | Yes | — | Name of the config object. Not required if using a Service Token. |
format | string | No | — | The format value |
name_transformer | string | No | — | Transform secret names to a different case |
include_dynamic_secrets | boolean | No | — | Whether or not to issue leases and include dynamic secret values for the config |
dynamic_secrets_ttl_sec | integer | No | — | The number of seconds until dynamic leases expire. Must be used with include_dynamic_secrets. Defaults to 1800 (30 minutes). |
secrets | string | No | — | Comma-delimited list of secrets to include in the download. Defaults to all secrets if left unspecified. |
doppler_configs_secrets_get
Retrieve Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project | string | Yes | — | Unique identifier for the project object. |
config | string | Yes | — | Name of the config object. |
name | string | Yes | — | Name of the secret. |
doppler_configs_secrets_list
List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project | string | Yes | — | Unique identifier for the project object. |
config | string | Yes | — | Name of the config object. |
include_dynamic_secrets | boolean | No | — | Whether or not to issue leases and include dynamic secret values for the config |
dynamic_secrets_ttl_sec | integer | No | — | The number of seconds until dynamic leases expire. Must be used with include_dynamic_secrets. Defaults to 1800 (30 minutes). |
secrets | string | No | — | A comma-separated list of secrets to include in the response |
include_managed_secrets | boolean | No | — | Whether to include Doppler’s auto-generated (managed) secrets |
doppler_configs_secrets_names
List Names Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project | string | Yes | — | Unique identifier for the project object. |
config | string | Yes | — | Name of the config object. |
include_dynamic_secrets | boolean | No | — | Whether or not to issue leases and include dynamic secret values for the config |
include_managed_secrets | boolean | No | — | Whether to include Doppler’s auto-generated (managed) secrets |
doppler_configs_secrets_update
Update Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
change_requests | object[] | No | — | Either 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. |
config | string | Yes | — | Name of the config object. |
project | string | Yes | — | Unique identifier for the project object. |
secrets | object | No | — | Either 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
access | string | No | — | Token’s capabilities. |
config | string | Yes | — | Name of the config object. |
expire_at | string | No | — | Unix timestamp of when token should expire. |
name | string | Yes | — | Name of the service token. |
project | string | Yes | — | Unique identifier for the project object. |
doppler_configs_service_tokens_delete
Delete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
config | string | Yes | — | Name of the config object. |
project | string | Yes | — | Unique identifier for the project object. |
slug | string | No | — | The slug of the service token. |
token | string | No | — | The token value. |
doppler_configs_service_tokens_list
List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project | string | Yes | — | Unique identifier for the project object. |
config | string | Yes | — | Name of the config object. |
doppler_configs_syncs_create
Create Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project | string | Yes | — | The project slug |
config | string | Yes | — | The config slug |
await_initial_sync | boolean | No | — | Causes sync creation to wait for the initial sync to complete before returning. |
data | object | Yes | — | Configuration data for the sync |
import_option | string | No | — | An option indicating if and how Doppler should attempt to import secrets from the sync destination |
integration | string | Yes | — | The integration slug which the sync will use |
doppler_configs_syncs_delete
Delete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project | string | Yes | — | The project slug |
config | string | Yes | — | The config slug |
sync | string | Yes | — | The sync slug |
delete_from_target | boolean | Yes | — | Whether or not to delete the synced data from the target integration |
doppler_configs_syncs_get
Retrieve Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project | string | Yes | — | The project slug |
config | string | Yes | — | The config slug |
sync | string | Yes | — | The sync slug |
doppler_configs_unlock
Unlock Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
config | string | Yes | — | Name of the config. |
project | string | Yes | — | Unique identifier for the project object. |
doppler_configs_update
Update Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
config | string | Yes | — | Name of the config object. |
name | string | Yes | — | The new name of config. |
project | string | Yes | — | Unique identifier for the project object. |

