The change_requests parameter is a new parameter that is an array whose elements are objects matching the following format. This endpoint must receive either a secrets or change_requests parameter (but not both).

change_requests: Array<{
  name: string;
  originalName: string | null;
  value: string | null;
  originalValue?: string | null;
  visibility?: "masked" | "unmasked" | "restricted";
  originalVisibility?: "masked" | "unmasked" | "restricted";
  shouldPromote?: boolean;
  shouldDelete?: boolean;
  shouldConverge?: boolean;  
  • shouldPromote can only be set to true if the config being updated is a branch config. In this case, the provided secret will be set in both the branch config as well as the root config in that environment.
  • shouldDelete if set to true will delete the secret matching the name field.
  • shouldConverge can only be set to true if the config being updated is a branch config and there is a secret with the same name in the root config. In this case, the branch secret will inherit the value and visibility type from the root secret.
  • value should be set to the value you want to update the secret to have. If you don't want to change the existing value, set this to null.
  • originalName should be set to null if a new secret is being added. Otherwise, if originalName is different from name and points to an existing secret, Doppler will treat the operation as a rename.
  • originalValue and originalVisibility, when set, are used to instruct Doppler to only process the change request if the provided values match the latest values.
Click Try It! to start a request and see the response here!