---
title: "POST /rotated-secret-update-ssh"
method: POST
path: "/rotated-secret-update-ssh"
tags: ["v2"]
---

# POST /rotated-secret-update-ssh

`POST /rotated-secret-update-ssh`

## Request body

- RotatedSecretUpdateSsh
  - `add-tag` string[] — List of the new tags that will be attached to this item
  - `authentication-credentials` string — The credentials to connect with use-user-creds/use-target-creds
  - `auto-rotate` string — Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false]
  - `delete_protection` string — Protection from accidental deletion of this object [true/false]
  - `description` string — Description of the object
  - `input-rule` string[] — Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input)
  - `item-custom-fields` object — Additional custom fields to associate with the item
  - `json` boolean — Set output format to JSON
  - `keep-prev-version` string — Whether to keep previous version [true/false]. 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)
  - `key-data-base64` string — Private key file contents encoded using base64
  - `lock-during-sra-session` string — Lock this secret for read/update while an SRA session is active
  - `max-versions` string — Set the maximum number of versions, limited by the account settings defaults.
  - `name` string, required — Rotated secret name
  - `new-name` string — New item name
  - `output-rule` string[] — Agentic output rule in name=...,rule=... format (e.g. name=rule1,rule=Mask secrets)
  - `password-length` string — The length of the password to be generated
  - `public-key-remote-path` string — The path to the public key that will be rotated on the server
  - `rm-tag` string[] — List of the existent tags that will be removed from this item
  - `rotate-after-disconnect` string — StringOrBool accepts JSON strings, booleans, and numbers for backward compatibility with older SDK versions that send boolean values for rotate-after-disconnect.
  - `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 Hour of the rotation in UTC
  - `rotation-interval` string — The number of days to wait between every automatic key rotation (1-365)
  - `rotator-custom-cmd` string — Custom rotation command
  - `rotator-type` string, required — The rotator type. options: [target/password/key]
  - `same-password` string — Rotate same password for each host from the Linked Target (relevant only for Linked Target)
  - `secure-access-allow-external-user` boolean — Allow providing external user for a domain users
  - `secure-access-bastion-issuer` string — Deprecated. use secure-access-certificate-issuer
  - `secure-access-certificate-issuer` string — Path to the SSH Certificate Issuer for your Akeyless Secure Access
  - `secure-access-enable` string — Enable/Disable secure remote access [true/false]
  - `secure-access-host` string[] — Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)
  - `secure-access-rdp-domain` string — Default domain name server. i.e. microsoft.com
  - `secure-access-rdp-user` string — Override the RDP Domain username
  - `secure-access-ssh-user` string — Override the SSH username as indicated in SSH Certificate Issuer
  - `secure-access-target-type` string — Specify target type. Options are ssh or rdp
  - `token` string — Authentication token (see `/auth` and `/configure`)
  - `uid-token` string — The universal identity token, Required only for universal_identity authentication

## Response `201`

rotatedSecretUpdateSshResponse wraps response body.

- RotatedSecretUpdateOutput
  - `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)