STstackstorm

PUT /api/v1/keys/{name}

Create a new key value pair or update an existing one.

Request

  • The document declares no server URL.
  • Auth
    • API key in header X-Auth-Token
    • or API key in header St2-Api-Key
    • or API key in query parameter x-auth-token
    • or API key in query parameter st2-api-key
    • or API key in header auth-token

Path parameters

namestring required

Key Name.

Request body

namestring required

Key Name.

valuestring required

Key's value.

secretboolean

Encrypt value before saving the value.

encryptedboolean

Value provided is already encrypted with this instances crypto key and should be stored as-is. This is useful when migrating / loading keys from one StackStorm instance to another.

scopestring

Scope the item is under. Example: 'user'.

ttlinteger

TTL (in seconds) for this value.

userstring nullable

User for user scoped items (admin only).

Response

Key set/updated.

KeyValuePair required

Changes

No recorded changes to this operation across all 73 revisions of this API.