v1

latestOpenAPI 3.0.02026-07-246171,3332.1 MB
v2

post/update-item

Request body

ProviderTypestring
accessibilitystring

for personal password manager

add-tagstring[]

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

cert-file-datastring

PEM Certificate in a Base64 format. Used for updating RSA keys' certificates.

certificate-formatstring
change-eventstring

Trigger an event when a secret value changed [true/false] (Relevant only for Static Secret)

delete_protectionstring

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

descriptionstring

Description of the object

expiration-event-instring[]

How many days before the expiration of the certificate would you like to be notified.

gcp-sm-regionsstring

GCP Secret Manager regions to query for regional secrets (comma-separated, e.g., us-east1,us-west1). Max 12 regions. USC with GCP targets only.

host-providerstring

Host provider type [explicit/target], Default Host provider is explicit, Relevant only for Secure Remote Access of ssh cert issuer, ldap rotated secret and ldap dynamic secret

item-custom-fieldsobject

Additional custom fields to associate with the item

jsonboolean

Set output format to JSON

lock-during-sra-sessionstring

Lock this secret for read/update while an SRA session is active

max-versionsstring

Set the maximum number of versions, limited by the account settings defaults.

namestring required

Current item name

new-metadatastring

Deprecated - use description

new-namestring

New item name

rm-tagstring[]

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

rotate-after-disconnectstring

StringOrBool accepts JSON strings, booleans, and numbers for backward compatibility with older SDK versions that send boolean values for rotate-after-disconnect.

secure-access-add-hoststring[]

List of the new hosts that will be attached to SRA servers host

secure-access-allow-external-userstring

Allow providing external user for a domain users [true/false]

secure-access-allow-port-forwadingboolean

Enable Port forwarding while using CLI access (relevant only for EKS/GKE/K8s Dynamic-Secret)

secure-access-apistring

Bastion's SSH control API endpoint. E.g. https://my.sra-server:9900 (relevant only for ssh cert issuer)

secure-access-aws-account-idstring

The AWS account id (relevant only for aws)

secure-access-aws-native-cliboolean

The AWS native cli (relevant only for aws)

secure-access-aws-regionstring

The AWS region (relevant only for aws)

secure-access-bastion-apistring

Deprecated. use secure-access-api

secure-access-bastion-issuerstring

Deprecated. use secure-access-certificate-issuer

secure-access-bastion-sshstring

Deprecated. use secure-access-ssh

secure-access-certificate-issuerstring

Path to the SSH Certificate Issuer for your Akeyless Secure Access

secure-access-cluster-endpointstring

The K8s cluster endpoint URL (relevant only for EKS/GKE/K8s Dynamic-Secret)

secure-access-dashboard-urlstring

The K8s dashboard url (relevant only for k8s)

secure-access-db-namestring

The DB name (relevant only for DB Dynamic-Secret)

secure-access-db-schemastring

The DB schema (relevant only for DB Dynamic-Secret)

secure-access-enablestring

Enable/Disable secure remote access [true/false]

secure-access-gatewaystring
secure-access-hoststring[]

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-rd-gateway-serverstring

RD Gateway server (relevant only for rdp)

secure-access-rdp-domainstring

Required when the Dynamic Secret is used for a domain user (relevant only for RDP Dynamic-Secret)

secure-access-rdp-userstring

Override the RDP Domain username

secure-access-rm-hoststring[]

List of the existent hosts that will be removed from SRA servers host

secure-access-sshstring

Bastion's SSH server. E.g. my.sra-server:22 (relevant only for ssh cert issuer)

secure-access-ssh-credsstring

Secret values contains SSH Credentials, either Private Key or Password [password/private-key] (relevant only for Static-Secret or Rotated-secret)

secure-access-ssh-creds-userstring

SSH username to connect to target server, must be in 'Allowed Users' list (relevant only for ssh cert issuer)

secure-access-urlstring

Destination URL to inject secrets

secure-access-use-internal-bastionboolean

Deprecated. Use secure-access-use-internal-ssh-access

secure-access-use-internal-ssh-accessboolean

Use internal SSH Access

secure-access-web-browsingboolean

Secure browser via Akeyless's Secure Remote Access (SRA)

secure-access-web-proxyboolean

Web-Proxy via Akeyless's Secure Remote Access (SRA)

tokenstring

Authentication token (see /auth and /configure)

uid-tokenstring

The universal identity token, Required only for universal_identity authentication

usc-tagsstring

Comma-separated list of tags to apply to all secrets created/synced on the remote USC

USC items only.

use-tags-as-filterstring

Whether to filter the USC secret list using the specified usc-tags [true/false]

USC items only.

Response

updateItemResponse wraps response body.

updatedboolean