Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ title: Create Virtual Key
openapi: post /virtual-keys
---

<Warning>
**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.
</Warning>

#### <Icon icon="microsoft" /> Azure OpenAI
Create virtual key to access your Azure OpenAI models or deployments, and manage all auth in one place.
<AccordionGroup>
Expand Down Expand Up @@ -247,6 +251,6 @@ main();
#### <Icon icon="google" /> Vertex AI
Create virtual key to access any models available or hosted on Vertex AI. [Docs →](/integrations/llms/vertex-ai)

<Card icon="gear" title="Learn More About Virtual Keys" href="/product/ai-gateway/virtual-keys">
Securely store your provider auth in Portkey vault and democratize and streamline access to Gen AI.
<Card icon="sparkles" title="Model Catalog" href="/product/model-catalog">
Manage AI providers and models centrally with budget limits, rate limits, and model provisioning.
</Card>
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,7 @@
title: Delete Virtual Key
openapi: delete /virtual-keys/{slug}
---

<Warning>
**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.
</Warning>
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,7 @@
title: List Virtual Key
openapi: get /virtual-keys
---

<Warning>
**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.
</Warning>
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,7 @@
title: Retrieve Virtual Key
openapi: get /virtual-keys/{slug}
---

<Warning>
**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.
</Warning>
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,7 @@
title: Update Virtual Key
openapi: put /virtual-keys/{slug}
---

<Warning>
**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.
</Warning>
6 changes: 3 additions & 3 deletions api-reference/admin-api/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
---
title: "Introduction"
description: "Manage your Portkey organization and workspaces programmatically"

Check warning on line 3 in api-reference/admin-api/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

api-reference/admin-api/introduction.mdx#L3

Did you really mean 'Portkey'?
---

# Portkey Admin API

Check warning on line 6 in api-reference/admin-api/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

api-reference/admin-api/introduction.mdx#L6

Did you really mean 'Portkey'?

The Portkey Admin API provides programmatic access to manage your organization, workspaces, and resources. Whether you're automating routine administration tasks, integrating Portkey with your existing systems, or customizing your deployment at scale, this API gives you the tools to control every aspect of your Portkey implementation.

Check warning on line 8 in api-reference/admin-api/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

api-reference/admin-api/introduction.mdx#L8

Did you really mean 'Portkey'?

Check warning on line 8 in api-reference/admin-api/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

api-reference/admin-api/introduction.mdx#L8

Did you really mean 'Portkey'?

Check warning on line 8 in api-reference/admin-api/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

api-reference/admin-api/introduction.mdx#L8

Did you really mean 'Portkey'?

## Understanding the Admin API Ecosystem

The Admin API is organized around key capabilities that let you manage different aspects of your Portkey environment. Let's explore what you can build and automate:

Check warning on line 12 in api-reference/admin-api/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

api-reference/admin-api/introduction.mdx#L12

Did you really mean 'Portkey'?

### Resource Management

At the foundation of Portkey are the resources that define how your AI implementation works. These can all be managed programmatically:

Check warning on line 16 in api-reference/admin-api/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

api-reference/admin-api/introduction.mdx#L16

Did you really mean 'Portkey'?

<CardGroup cols={3}>
<Card title="Configs" href="/api-reference/admin-api/control-plane/configs/create-config">
Create and manage configuration profiles that define routing rules, model settings, and more.
</Card>
<Card title="Virtual Keys" href="/api-reference/admin-api/control-plane/virtual-keys/create-virtual-key">
Manage virtual API keys that provide customized access to specific configurations.
<Card title="Providers & Integrations" href="/api-reference/admin-api/control-plane/providers/create-provider">
Manage AI providers and credentials across workspaces. Replaces Virtual Keys.
</Card>
<Card title="API Keys" href="/api-reference/admin-api/control-plane/api-keys/create-api-key">
Create and manage API keys for accessing Portkey services.
Expand All @@ -45,7 +45,7 @@

### User and Workspace Administration

Beyond resources and analytics, you'll need to manage who has access to your Portkey environment:

Check warning on line 48 in api-reference/admin-api/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

api-reference/admin-api/introduction.mdx#L48

Did you really mean 'Portkey'?

<CardGroup cols={2}>
<Card title="Users & Invites" href="/api-reference/admin-api/control-plane/users/retrieve-a-user">
Expand All @@ -58,7 +58,7 @@

## Authentication Strategy

Now that you understand what the Admin API can do, let's explore how to authenticate your requests. Portkey uses a sophisticated access control system with two types of API keys, each designed for different use cases:

Check warning on line 61 in api-reference/admin-api/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

api-reference/admin-api/introduction.mdx#L61

Did you really mean 'Portkey'?

<CardGroup cols={2}>
<Card title="Admin API Key" icon="key">
Expand All @@ -81,7 +81,7 @@

## Access Control and Permissions Model

Portkey's hierarchical access control system governs who can use which APIs. Let's examine how roles, API keys, and permissions interact:

Check warning on line 84 in api-reference/admin-api/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

api-reference/admin-api/introduction.mdx#L84

Did you really mean 'Portkey's'?

```mermaid
graph TD
Expand Down Expand Up @@ -120,9 +120,9 @@

Now that you understand the permission model, let's look at how to create the API keys you'll need:

### Through the Portkey Dashboard

Check warning on line 123 in api-reference/admin-api/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

api-reference/admin-api/introduction.mdx#L123

Did you really mean 'Portkey'?

The simplest way to create an API key is through the Portkey dashboard:

Check warning on line 125 in api-reference/admin-api/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

api-reference/admin-api/introduction.mdx#L125

Did you really mean 'Portkey'?

<Frame caption="Creating an Admin API Key in the Portkey Dashboard">
<img src="/images/admin-api/making-key.gif" />
Expand Down Expand Up @@ -171,14 +171,14 @@
| Manage organization settings | ✅ | ❌ |
| Create/manage workspaces | ✅ | ❌ |
| Manage users and permissions | ✅ | ❌ |
| Create/manage configs | ✅ (All workspaces) | ✅ (Single workspace) |

Check warning on line 174 in api-reference/admin-api/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

api-reference/admin-api/introduction.mdx#L174

Did you really mean 'configs'?
| Create/manage virtual keys | ✅ (All workspaces) | ✅ (Single workspace) |
| Create/manage providers | ✅ (All workspaces) | ✅ (Single workspace) |
| Access Analytics | ✅ (All workspaces) | ✅ (Single workspace) |
| Create/update feedback | ❌ | ✅ |

## Security and Compliance: Audit Logs

For security-conscious organizations, Portkey provides comprehensive audit logging of all Admin API operations. These logs give you complete visibility into administrative actions:

Check warning on line 181 in api-reference/admin-api/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

api-reference/admin-api/introduction.mdx#L181

Did you really mean 'Portkey'?

<Frame caption="Audit Logs in the Portkey Dashboard">
<img src="/images/audit-logs.gif" />
Expand All @@ -202,7 +202,7 @@
Now that you understand the Admin API ecosystem, authentication, and permissions model, you're ready to start making requests. Here's what you'll need:

1. **Appropriate role**: Ensure you have the right permissions (Org Owner/Admin for Admin API, Workspace Manager for Workspace API)
2. **API key**: Generate the appropriate key from the Portkey dashboard

Check warning on line 205 in api-reference/admin-api/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

api-reference/admin-api/introduction.mdx#L205

Did you really mean 'Portkey'?
3. **Make your first request**: Use your key in the request header


Expand Down