Nuvelics documentation
CLICommand reference

nuvelics credential

Usage, options and details of the nuvelics credential commands.

nuvelics credential create

Create a credential

You will be prompted for the secret value (API key, password, or token). Use --secret-stdin to read the secret from stdin instead, for automation: echo "$TOKEN" | nuvelics credential create --secret-stdin --name "CI Bearer" --type bearer

The secret must never be passed as a flag value (visible in ps and shell history).

A vendor preset (--preset) replaces --type/--in/--key-name for a known vendor: the operator types that vendor's own field values instead of the raw scheme. The secret field is still read via readSecret, never a flag.

Examples: nuvelics credential create --name "My Bearer" --type bearer nuvelics credential create --name "My Key" --type apiKey --in header --key-name X-API-Key nuvelics credential create --name "My Basic" --type basic --username alice nuvelics credential create --name "DigiChief - GB" --preset digichief --customer GB --secret-stdin

  • --name <name> — Credential display name
  • --type <type> — Scheme type: apiKey, basic, or bearer
  • --in <placement> — apiKey placement: header, query, or path
  • --key-name <name> — apiKey parameter name
  • --username <username> — Username (required for type basic)
  • --preset <id> — Vendor preset id (e.g. digichief, datafactory, x, grok)
  • --customer <id> — Preset field: vendor customer id (e.g. --preset digichief)
  • --secret-stdin — Read the secret from stdin instead of the interactive prompt

nuvelics credential delete [id]

Delete a credential (irreversible)

Pass --yes to confirm. This action is irreversible.

  • --yes — Confirm irreversible deletion

nuvelics credential get [id]

Get a credential by ID

nuvelics credential list

List credentials

  • --filter <field.op=value> — Filter: field.op=value (repeatable, e.g. --filter name.contains=bearer)
  • --sort <-field|field> — Sort order: "-field" descending, "field" ascending. Use --sort=-field (with "="), not --sort -field, or the shell/parser reads -field as another flag. Accepted: name, -name, createdAt, -createdAt, updatedAt, -updatedAt (default -updatedAt)
  • --include-health — Include each credential's health (adds one batched lookup)

nuvelics credential update [id]

Update a credential

The current version is fetched automatically. If modified concurrently, a 412 is returned — retry. When --type is provided, you will be prompted for the new secret value.

  • --name <name> — New display name
  • --type <type> — Replacement scheme type: apiKey, basic, or bearer
  • --in <placement> — apiKey placement (required when --type apiKey)
  • --key-name <name> — apiKey parameter name (required when --type apiKey)
  • --username <username> — Username (required when --type basic)

Report a problem with this page

On this page