Skip to main content
PATCH
Update a key vault

Authorizations

Authorization
string
header
required

Personal API key (prefix up_). Create one in the studio under Account → API keys.

Path Parameters

studioId
string
required
keyVaultId
string
required

Body

application/json
vaultName
string

New display name for the vault.

Required string length: 2 - 80
vaultDescription
string | null

New description for the vault. Pass null to clear it.

Maximum string length: 2000
keyType
enum<string>

Switch the credential type this vault holds.

Available options:
steam,
custom
steamKeyType
enum<string> | null

Steam key variant (playtest_standard, default_release, release_state_override, developer_autogrant). Only when keyType is 'steam'.

Available options:
playtest_standard,
default_release,
release_state_override,
developer_autogrant,
null
steamRedeemScope
enum<string> | null

What a Steam key unlocks (game, dlc, bundle). Only when keyType is 'steam'.

Available options:
game,
dlc,
bundle,
null
onboardingIdentityProviders
enum<string>[] | null

The identities a recipient must hold before claiming a key, in canonical order. Pass null to reset to the default (email).

Minimum array length: 1
Available options:
email,
discord,
steam,
google

Response

200 - application/json

The updated key vault

data
object
required