Skip to content

API documentation for PUT /api/v1/keys/{name} is missing TTL #3783

@nmaludy

Description

@nmaludy

The API documentation for PUT /api/v1/keys/{name} link is missing the ttl parameter that's available in the CLI:

[root@stackstorm ~]# st2 key set --help
usage: st2 key set [-h] [-t TOKEN] [--api-key API_KEY] [-j] [-y] [-l TTL] [-e]
                   [-s SCOPE] [-u USER]
                   name value

Set an existing key value pair.

positional arguments:
  name                  Name of the key value pair.
  value                 Value paired with the key.

optional arguments:
  -h, --help            show this help message and exit
  -t TOKEN, --token TOKEN
                        Access token for user authentication. Get
                        ST2_AUTH_TOKEN from the environment variables by
                        default.
  --api-key API_KEY     Api Key for user authentication. Get ST2_API_KEY from
                        the environment variables by default.
  -j, --json            Prints output in JSON format.
  -y, --yaml            Prints output in YAML format.
  -l TTL, --ttl TTL     TTL (in seconds) for this value.
  -e, --encrypt         Encrypt value before saving the value.
  -s SCOPE, --scope SCOPE
                        Specify the scope under which you want to place the
                        item.
  -u USER, --user USER  User for user scoped items (admin only).

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions