Update Virtual Key

PUT /virtual-keys/{slug}

Python

Default

from portkey_ai import Portkey

# Initialize the Portkey client
portkey = Portkey(
    api_key="PORTKEY_API_KEY",
)

# Update a specific virtual key
updated_virtual_key = portkey.virtual_keys.update(
    slug='VIRTUAL_KEY_SLUG',
    name="openaiVKey",
    note="hello",
    rate_limits=[{"type": "requests", "unit": "rpm", "value": 696}]
)

print(updated_virtual_key)

200

{}

{
  "success": false,
  "data": {
    "message": "Unauthorised Request"
  }
}

Deprecated. Use the Providers API instead. Existing virtual keys continue to work — no code changes needed.

Authorizations

x-portkey-api-key · string · header · required

Path Parameters

slug · string · required

Body

application/json

name · string

key · string

note · string | null

deploymentConfig · object[]

Show child attributes

usage_limits · object

Show child attributes

Example:

{
  "credit_limit": 10,
  "periodic_reset": "monthly",
  "alert_threshold": 8
}

secret_mappings · object[]

Dynamically resolve secrets from secret references at runtime. Valid target_field values are "key" or "model_config." (e.g. "model_config.awsSecretAccessKey"). Each target_field must be unique.

Show child attributes

Response

200

application/json

Successful response

The response is of type object.