api-key patch

qlik api-key patch

Update API key description

Synopsis

Updates an API key description for a given API key ID.

Allowed operations: replace

Allowed paths: /description

qlik api-key patch <api-keyId> [flags]

Examples

  qlik api-key patch <api-keyId> --body '[{"op":"`replace`","path":"`/description`","value":<value>}]'

Options

      --body string    A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902. (JSON array)
                       Array of JSON-objects with the fields:
                         "op" - The operation to be performed. (string)
                         "path" - The path for the given resource field to patch. (string)
                         "value" - The value to be used for this operation. (string)
                       Required fields: op, path, value
                       Example value: [{"op":"abc","path":"abc","value":"abc"}]
  -f, --file string    Reads request from a file
  -h, --help           help for patch
      --interval int   Duration in seconds to wait between retries, at least 1 (default 1)
  -q, --quiet          Return only IDs from the command
      --raw            Return original response from server without any processing
      --retry int      Number of retries to do before failing, max 10

Options inherited from parent commands

  -c, --config string            path/to/config.yml where parameters can be set instead of on the command line
      --context string           Name of the context used when connecting to Qlik Associative Engine
      --headers stringToString   HTTP headers to use when connecting to Qlik Associative Engine (default [])
      --insecure                 Enabling insecure will make it possible to connect using self-signed certificates
      --json                     Returns output in JSON format, if possible. Disables verbose and traffic output
  -s, --server string            URL to Qlik Cloud or directly to a Qlik Associative Engine
      --server-type string       The type of server you are using: cloud, Windows (Enterprise on Windows) or engine
  -v, --verbose                  Log extra information