/gateway-update-item

post

https://api.akeyless.io/gateway-update-item

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

add-tag

array of strings

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

add-tag

api-id

string

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

api-key

string

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

app-id

string

ApplicationId (used in azure)

auto-rotate

string

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

custom-payload

string

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

delete_protection

string

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

description

string

Defaults to default_metadata

Description of the object

gcp-key

string

Base64-encoded service account private key text

gcp-service-account-email

string

The email of the gcp service account to rotate

gcp-service-account-key-id

string

The key id of the gcp service account to rotate

grace-rotation

string

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

json

boolean

Defaults to false

Set output format to JSON

keep-prev-version

string

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

key

string

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

name

string

required

Item name

new-metadata

string

Defaults to default_metadata

Deprecated - use description

new-name

string

New item name

new-version

boolean

Deprecated

password-length

string

The length of the password to be generated

rm-tag

array of strings

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

rm-tag

rotated-password

string

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

rotated-username

string

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-in

array of strings

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

rotation-event-in

rotation-hour

int32

Defaults to 0

The Rotation Hour

rotation-interval

string

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

rotator-creds-type

string

Defaults to use-self-creds

The rotation credentials type

token

string

Authentication token (see /auth and /configure)

type

string

required

Item type

uid-token

string

The universal identity token, Required only for universal_identity authentication

Responses

201gatewayUpdateItemResponse wraps response body.

defaulterrorResponse wraps any error to return it as a JSON object with one "error" field.