---
title: "POST /gateway-update-item"
method: POST
path: "/gateway-update-item"
tags: ["v2"]
---

# POST /gateway-update-item

`POST /gateway-update-item`

## Request body

- GatewayUpdateItem — gatewayUpdateItem is a command that updates classic key
  - `add-tag` string[] — List of the new tags that will be attached to this item
  - `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 — 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 — 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 — 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` string[] — List of the existent tags that will be removed from this item
  - `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` string[] — How many days before the rotation of the item would you like to be notified
  - `rotation-hour` integer — The Rotation Hour
  - `rotation-interval` string — The number of days to wait between every automatic key rotation (1-365)
  - `rotator-creds-type` string — 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

## Response `201`

gatewayUpdateItemResponse wraps response body.

- GatewayUpdateItemOutput
  - `name` string

## Other responses

- `default` — errorResponse wraps any error to return it as a JSON object with one "error" field.

---

[API](https://skmtc.net/akeyless/apis/akeyless-api.md) · [All operations](https://skmtc.net/akeyless/apis/akeyless-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/akeyless/akeyless-api/versions/0ceb25634501/schema)