From 88788991e89a4e73237ec23e69ea51df8f7a86c4 Mon Sep 17 00:00:00 2001 From: siddharthsambharia-portkey Date: Fri, 27 Feb 2026 17:48:31 +0530 Subject: [PATCH] docs: Add deprecation notices to Virtual Keys API endpoints --- .../control-plane/virtual-keys/create-virtual-key.mdx | 8 ++++++-- .../control-plane/virtual-keys/delete-virtual-key.mdx | 4 ++++ .../control-plane/virtual-keys/list-virtual-keys.mdx | 4 ++++ .../control-plane/virtual-keys/retrieve-virtual-key.mdx | 4 ++++ .../control-plane/virtual-keys/update-virtual-key.mdx | 4 ++++ api-reference/admin-api/introduction.mdx | 6 +++--- 6 files changed, 25 insertions(+), 5 deletions(-) diff --git a/api-reference/admin-api/control-plane/virtual-keys/create-virtual-key.mdx b/api-reference/admin-api/control-plane/virtual-keys/create-virtual-key.mdx index bf5f5c7e..07d78056 100644 --- a/api-reference/admin-api/control-plane/virtual-keys/create-virtual-key.mdx +++ b/api-reference/admin-api/control-plane/virtual-keys/create-virtual-key.mdx @@ -3,6 +3,10 @@ title: Create Virtual Key openapi: post /virtual-keys --- + +**Deprecated.** Use the [Integrations API](/api-reference/admin-api/control-plane/integrations/create-integration) to store provider credentials and the [Providers API](/api-reference/admin-api/control-plane/providers/create-provider) to create AI Providers in your workspace. Existing virtual keys continue to work — no code changes needed. + + #### Azure OpenAI Create virtual key to access your Azure OpenAI models or deployments, and manage all auth in one place. @@ -247,6 +251,6 @@ main(); #### Vertex AI Create virtual key to access any models available or hosted on Vertex AI. [Docs →](/integrations/llms/vertex-ai) - -Securely store your provider auth in Portkey vault and democratize and streamline access to Gen AI. + +Manage AI providers and models centrally with budget limits, rate limits, and model provisioning. diff --git a/api-reference/admin-api/control-plane/virtual-keys/delete-virtual-key.mdx b/api-reference/admin-api/control-plane/virtual-keys/delete-virtual-key.mdx index f29e0b68..c7f27eea 100644 --- a/api-reference/admin-api/control-plane/virtual-keys/delete-virtual-key.mdx +++ b/api-reference/admin-api/control-plane/virtual-keys/delete-virtual-key.mdx @@ -2,3 +2,7 @@ title: Delete Virtual Key openapi: delete /virtual-keys/{slug} --- + + +**Deprecated.** Use the [Providers API](/api-reference/admin-api/control-plane/providers/delete-provider) instead. Existing virtual keys continue to work — no code changes needed. + diff --git a/api-reference/admin-api/control-plane/virtual-keys/list-virtual-keys.mdx b/api-reference/admin-api/control-plane/virtual-keys/list-virtual-keys.mdx index cc325306..f86b7409 100644 --- a/api-reference/admin-api/control-plane/virtual-keys/list-virtual-keys.mdx +++ b/api-reference/admin-api/control-plane/virtual-keys/list-virtual-keys.mdx @@ -2,3 +2,7 @@ title: List Virtual Key openapi: get /virtual-keys --- + + +**Deprecated.** Use the [Providers API](/api-reference/admin-api/control-plane/providers/list-providers) instead. Existing virtual keys continue to work — no code changes needed. + diff --git a/api-reference/admin-api/control-plane/virtual-keys/retrieve-virtual-key.mdx b/api-reference/admin-api/control-plane/virtual-keys/retrieve-virtual-key.mdx index 42545fb1..7c74fba6 100644 --- a/api-reference/admin-api/control-plane/virtual-keys/retrieve-virtual-key.mdx +++ b/api-reference/admin-api/control-plane/virtual-keys/retrieve-virtual-key.mdx @@ -2,3 +2,7 @@ title: Retrieve Virtual Key openapi: get /virtual-keys/{slug} --- + + +**Deprecated.** Use the [Providers API](/api-reference/admin-api/control-plane/providers/retrieve-provider) instead. Existing virtual keys continue to work — no code changes needed. + diff --git a/api-reference/admin-api/control-plane/virtual-keys/update-virtual-key.mdx b/api-reference/admin-api/control-plane/virtual-keys/update-virtual-key.mdx index 59f57f83..b6e4cd9f 100644 --- a/api-reference/admin-api/control-plane/virtual-keys/update-virtual-key.mdx +++ b/api-reference/admin-api/control-plane/virtual-keys/update-virtual-key.mdx @@ -2,3 +2,7 @@ title: Update Virtual Key openapi: put /virtual-keys/{slug} --- + + +**Deprecated.** Use the [Providers API](/api-reference/admin-api/control-plane/providers/update-provider) instead. Existing virtual keys continue to work — no code changes needed. + diff --git a/api-reference/admin-api/introduction.mdx b/api-reference/admin-api/introduction.mdx index 528ccc21..a66d2a6c 100644 --- a/api-reference/admin-api/introduction.mdx +++ b/api-reference/admin-api/introduction.mdx @@ -19,8 +19,8 @@ At the foundation of Portkey are the resources that define how your AI implement Create and manage configuration profiles that define routing rules, model settings, and more. - - Manage virtual API keys that provide customized access to specific configurations. + + Manage AI providers and credentials across workspaces. Replaces Virtual Keys. Create and manage API keys for accessing Portkey services. @@ -172,7 +172,7 @@ Both key types have different capabilities. This table clarifies which operation | Create/manage workspaces | ✅ | ❌ | | Manage users and permissions | ✅ | ❌ | | Create/manage configs | ✅ (All workspaces) | ✅ (Single workspace) | -| Create/manage virtual keys | ✅ (All workspaces) | ✅ (Single workspace) | +| Create/manage providers | ✅ (All workspaces) | ✅ (Single workspace) | | Access Analytics | ✅ (All workspaces) | ✅ (Single workspace) | | Create/update feedback | ❌ | ✅ |