---
title: "UpdateBYOKKeyRequest"
---

## Fields

| Field                                                                                                                                                                                              | Type                                                                                                                                                                                               | Required                                                                                                                                                                                           | Description                                                                                                                                                                                        | Example                                                                                                                                                                                            |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `allowed_models`                                                                                                                                                                                   | List[*str*]                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                 | Optional allowlist of model slugs this credential may be used for. `null` means no restriction.                                                                                                    | null                                                                                                                                                                                               |
| `allowed_user_ids`                                                                                                                                                                                 | List[*str*]                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                 | Optional allowlist of user IDs that may use this credential. `null` means no restriction.                                                                                                          | null                                                                                                                                                                                               |
| `disabled`                                                                                                                                                                                         | *Optional[bool]*                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                 | Whether this credential is disabled.                                                                                                                                                               | false                                                                                                                                                                                              |
| `is_fallback`                                                                                                                                                                                      | *Optional[bool]*                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                 | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried.                                                                        | false                                                                                                                                                                                              |
| `key`                                                                                                                                                                                              | *Optional[str]*                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                 | A new raw provider API key to rotate the credential in-place. The previous key material is overwritten and the masked label is regenerated. Encrypted at rest and never returned in API responses. | sk-proj-newkey456...                                                                                                                                                                               |
| `name`                                                                                                                                                                                             | *OptionalNullable[str]*                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                 | Optional human-readable name for the credential.                                                                                                                                                   | Updated OpenAI Key                                                                                                                                                                                 |