Skip to main content

Create or update a config group in the DRAFT revision

PUT 
/api/v1/get_config/:configIdentifier/config/groups

Creates a new group or updates an existing one inside the current DRAFT revision. Sensitive keys: any key path listed in sensitiveKeys will have its value encrypted in Vault; the API returns *** for those paths instead of the real value. Preserving secrets: if you send *** as the value for a sensitive key (e.g. you are only updating non-sensitive fields), the existing secret is kept — you do not need to re-supply the plaintext. Apply: set apply: true to immediately promote the DRAFT to a new ACTIVE config version after saving this group; existing groups that were not changed are carried over. Defaults to false.

Request​

Path Parameters

    configIdentifier stringrequired

    Config project ID or name, or a device ID (resolved to its config: project)

Body

required

    name stringrequired
    displayName string

    Optional human-readable display name. Falls back to name when not set.

    isGlobal boolean

    Default value: false

    gitFilePath string
    sensitiveKeys string[]

    Dot-notation key paths to treat as sensitive (e.g. ["password", "db.password"]). Replaces the previous list.

    yamlContent string

    Complete YAML string for the group. Replaces existing content. Sensitive keys (listed in sensitiveKeys) will be encrypted and stored in Vault. When reading back a group the API masks those values as ***. If you submit *** as the value for a sensitive key, the existing secret is preserved — you do not need to re-supply the original plaintext value.

    apply boolean

    Default value: false

    When true, immediately apply a new config version after this group is saved, promoting the DRAFT (including existing groups that were not changed) to ACTIVE. Defaults to false, leaving the change in the DRAFT revision until applied explicitly.

Responses​

Loading...