v1

latestOpenAPI 3.0.02026-07-246171,3332.1 MB
v2

post/gateway-update-item

Request body

add-tagstring[]

List of the new tags that will be attached to this item

api-idstring

API ID to rotate (relevant only for rotator-type=api-key)

api-keystring

API key to rotate (relevant only for rotator-type=api-key)

app-idstring

ApplicationId (used in azure)

auto-rotatestring

Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false]

custom-payloadstring

Secret payload to be sent with rotation request (relevant only for rotator-type=custom)

delete_protectionstring

Protection from accidental deletion of this object [true/false]

descriptionstring

Description of the object

gcp-keystring

Base64-encoded service account private key text

gcp-service-account-emailstring

The email of the gcp service account to rotate

gcp-service-account-key-idstring

The key id of the gcp service account to rotate

grace-rotationstring

Create a new access key without deleting the old key from AWS for backup (relevant only for AWS) [true/false]

jsonboolean

Set output format to JSON

keep-prev-versionstring

Whether to keep previous version [true/false]. (relevant only for --type=rotated-secret). If not set, use default according to account settings

keystring

The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)

namestring required

Item name

new-metadatastring

Deprecated - use description

new-namestring

New item name

new-versionboolean

Deprecated

password-lengthstring

The length of the password to be generated

rm-tagstring[]

List of the existent tags that will be removed from this item

rotated-passwordstring

rotated-username password (relevant only for rotator-type=password)

rotated-usernamestring

username to be rotated, if selected "use-self-creds" at rotator-creds-type, this username will try to rotate it's own password, if "use-target-creds" is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password)

rotation-event-instring[]

How many days before the rotation of the item would you like to be notified

rotation-hourinteger

The Rotation Hour

rotation-intervalstring

The number of days to wait between every automatic key rotation (1-365)

rotator-creds-typestring

The rotation credentials type

tokenstring

Authentication token (see /auth and /configure)

typestring required

Item type

uid-tokenstring

The universal identity token, Required only for universal_identity authentication

Response

gatewayUpdateItemResponse wraps response body.

namestring