v1

latestOpenAPI 3.0.02026-07-246171,3332.1 MB
v2

post/rotated-secret-create-snowflake

Request body

authentication-credentialsstring

The credentials to connect with use-user-creds/use-target-creds

auto-rotatestring

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

delete_protectionstring

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

descriptionstring

Description of the object

input-rulestring[]

Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input)

item-custom-fieldsobject

Additional custom fields to associate with the item

jsonboolean

Set output format to JSON

keystring

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

max-versionsstring

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

namestring required

Rotated secret name

output-rulestring[]

Agentic output rule in name=...,rule=... format (e.g. name=rule1,rule=Mask secrets)

password-lengthstring

The length of the password to be generated

private-keystring

RSA Private key (base64 encoded) to rotate (relevant only for rotator-type=key)

private-key-file-namestring

The path to the file containing the private key (relevant only for rotator-type=key)

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 or rotator-type=key)

rotation-event-instring[]

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

rotation-hourinteger

The Hour of the rotation in UTC

rotation-intervalstring

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

rotator-typestring required

The rotator type. options: [target/password/key]

tagsstring[]

Add tags attached to this object

target-namestring required

The target name to associate

tokenstring

Authentication token (see /auth and /configure)

uid-tokenstring

The universal identity token, Required only for universal_identity authentication

Response

rotatedSecretCreateSnowflakeResponse wraps response body.

namestring