/rotated-secret-update-gcp

post

https://api.akeyless.io/rotated-secret-update-gcp

Body Params

add-tag

array of strings

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

add-tag

authentication-credentials

string

Defaults to use-user-creds

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

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

Enable graceful rotation (keep both versions temporarily). When enabled, a new secret version is created while the previous version is kept for the grace period, so both versions exist for a limited time. [true/false]

grace-rotation-hour

int32

The Hour of the grace rotation in UTC

grace-rotation-interval

string

The number of days to wait before deleting the old key (must be bigger than rotation-interval)

grace-rotation-timing

string

When to create the new version relative to the rotation date [after/before]

item-custom-fields

object

Additional custom fields to associate with the item

json

boolean

Defaults to false

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)

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

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

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

The Hour of the rotation in UTC

rotation-interval

string

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

rotator-type

string

required

The rotator type. options: [target/service-account-rotator]

token

string

Authentication token (see /auth and /configure)

uid-token

string

The universal identity token, Required only for universal_identity authentication

Responses

201rotatedSecretUpdateGcpResponse wraps response body.

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