> ## Documentation Index > Fetch the complete documentation index at: https://portkey-docs-chore-v2-11-2.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Rotate API Key > Rotates an existing API key and returns a newly generated key value. The previous key remains valid during the transition period and expires at `key_transition_expires_at`. ## OpenAPI ````yaml post /api-keys/{id}/rotate openapi: 3.0.0 info: title: Portkey API description: >- The Portkey REST API. Please see https://portkey.ai/docs/api-reference for more details. version: 2.0.0 termsOfService: https://portkey.ai/terms contact: name: Portkey Developer Forum url: https://portkey.wiki/community license: name: MIT url: https://github.com/Portkey-AI/portkey-openapi/blob/master/LICENSE servers: - url: https://api.portkey.ai/v1 description: Portkey API Public Endpoint security: - Portkey-Key: [] tags: - name: Assistants description: Build Assistants that can call models and use tools. - name: Audio description: Turn audio into text or text into audio. - name: Chat description: >- Given a list of messages comprising a conversation, the model will return a response. - name: Realtime description: WebSocket proxy for provider Realtime APIs - name: Collections description: Create, List, Retrieve, Update, and Delete collections of prompts. - name: Labels description: Create, List, Retrieve, Update, and Delete labels. - name: Prompt Collections description: Create, List, Retrieve, Update, and Delete prompt collections. - name: PromptPartials description: Create, List, Retrieve, Update, and Delete prompt partials. - name: Prompts description: >- Given a prompt template ID and variables, will run the saved prompt template and return a response. - name: Guardrails description: Create, List, Retrieve, Update, and Delete prompt Guardrails. - name: Completions description: >- Given a prompt, the model will return one or more predicted completions, and can also return the probabilities of alternative tokens at each position. - name: Embeddings description: >- Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms. - name: Rerank description: >- Rerank a list of documents based on their relevance to a query. Supported providers include Cohere, Voyage, Jina, Pinecone, Bedrock, and Azure AI. - name: Fine-tuning description: Manage fine-tuning jobs to tailor a model to your specific training data. - name: Batch description: Create large batches of API requests to run asynchronously. - name: Files description: >- Files are used to upload documents that can be used with features like Assistants and Fine-tuning. - name: Images description: Given a prompt and/or an input image, the model will generate a new image. - name: Models description: List and describe the various models available in the API. - name: Moderations description: >- Given a input text, outputs if the model classifies it as potentially harmful. - name: Configs description: Create, List, Retrieve, and Update your Portkey Configs. - name: Feedback description: Send and Update any feedback. - name: Logs description: Custom Logger to add external logs to Portkey. - name: Integrations description: Create, List, Retrieve, Update, and Delete your Portkey Integrations. - name: Integrations > Workspaces description: Manage workspace access for your Portkey Integrations. - name: Integrations > Models description: Manage model access for your Portkey Integrations. - name: Providers description: Create, List, Retrieve, Update, and Delete your Portkey Providers. - name: Virtual-keys description: Create, List, Retrieve, Update, and Delete your Portkey Virtual keys. - name: Users description: Create and manage users. - name: User-invites description: Create and manage user invites. - name: Workspaces description: Create and manage workspaces. - name: Workspaces > Members description: Create and manage workspace members. - name: MCP Integrations description: Create, List, Retrieve, Update, and Delete MCP Integrations. - name: MCP Integrations > Workspaces description: Manage workspace access for MCP Integrations. - name: MCP Integrations > Capabilities description: List and manage capabilities for MCP Integrations. - name: MCP Integrations > Metadata description: Get MCP Integration metadata and sync info. - name: MCP Servers description: >- Create, List, Retrieve, Update, and Delete MCP Servers (workspace instances of MCP Integrations). - name: MCP Servers > Capabilities description: List and manage capabilities for MCP Servers. - name: MCP Servers > User Access description: List and manage user access for MCP Servers. - name: MCP Servers > Connections description: List and manage user connections for MCP Servers. - name: Api-Keys description: Create, List, Retrieve, Update, and Delete your Portkey API keys. - name: Logs Export description: Exports logs service. - name: Audit Logs description: Get audit logs for your Portkey account. - name: Analytics description: >- Get analytics over different data points like requests, costs, tokens, etc. - name: Analytics > Graphs description: Get data points for graphical representation. - name: Analytics > Summary description: Get overall summary for the selected time bucket. - name: Analytics > Groups description: Get grouped metrics for the selected time bucket. - name: Usage Limits Policies description: Manage usage limits policies to control total usage over time - name: Rate Limits Policies description: Manage rate limits policies to control request or token rates - name: Model Pricing description: Model pricing configurations for 2300+ LLMs across 40+ providers - name: Secret-References description: >- Create, List, Retrieve, Update, and Delete secret references to external secret managers. paths: /api-keys/{id}/rotate: servers: - url: https://api.portkey.ai/v1 description: Portkey API Public Endpoint - url: SELF_HOSTED_CONTROL_PLANE_URL description: Self-Hosted Control Plane URL post: tags: - Api-Keys summary: Rotate API Key description: > Rotates an existing API key and returns a newly generated key value. The previous key remains valid during the transition period and expires at `key_transition_expires_at`. parameters: - name: id in: path schema: type: string format: uuid required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/RotateApiKeyRequest' examples: default: summary: Rotate with a custom transition period value: key_transition_period_ms: 3600000 responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: $ref: '#/components/schemas/RotateApiKeyResponse' x-code-samples: - lang: python label: Default source: | import requests response = requests.post( "https://api.portkey.ai/v1/api-keys/API_KEY_ID/rotate", headers={ "x-portkey-api-key": "PORTKEY_API_KEY", "Content-Type": "application/json", }, json={ "key_transition_period_ms": 3600000 } ) print(response.json()) - lang: javascript label: Default source: > const response = await fetch("https://api.portkey.ai/v1/api-keys/API_KEY_ID/rotate", { method: "POST", headers: { "x-portkey-api-key": "PORTKEY_API_KEY", "Content-Type": "application/json", }, body: JSON.stringify({ key_transition_period_ms: 3600000 }), }); const rotatedApiKey = await response.json(); console.log(rotatedApiKey); - lang: curl label: Default source: | curl -X POST "https://api.portkey.ai/v1/api-keys/{id}/rotate" \ -H "x-portkey-api-key: PORTKEY_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "key_transition_period_ms": 3600000 }' - lang: python label: Self-Hosted source: | import requests response = requests.post( "SELF_HOSTED_CONTROL_PLANE_URL/api-keys/API_KEY_ID/rotate", headers={ "x-portkey-api-key": "PORTKEY_API_KEY", "Content-Type": "application/json", }, json={ "key_transition_period_ms": 3600000 } ) print(response.json()) - lang: javascript label: Self-Hosted source: > const response = await fetch("SELF_HOSTED_CONTROL_PLANE_URL/api-keys/API_KEY_ID/rotate", { method: "POST", headers: { "x-portkey-api-key": "PORTKEY_API_KEY", "Content-Type": "application/json", }, body: JSON.stringify({ key_transition_period_ms: 3600000 }), }); const rotatedApiKey = await response.json(); console.log(rotatedApiKey); - lang: curl label: Self-Hosted source: | curl -X POST "SELF_HOSTED_CONTROL_PLANE_URL/api-keys/{id}/rotate" \ -H "x-portkey-api-key: PORTKEY_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "key_transition_period_ms": 3600000 }' components: schemas: RotateApiKeyRequest: type: object properties: key_transition_period_ms: type: integer minimum: 1800000 description: >- Optional transition period in milliseconds during which the previous key remains valid. example: 3600000 RotateApiKeyResponse: type: object properties: id: type: string format: uuid example: 550e8400-e29b-41d4-a716-446655440000 key: type: string description: Newly rotated API key value. example: pk_live_new_rotated_key_value key_transition_expires_at: type: string format: date-time description: Timestamp when the previous key version stops being accepted. example: '2026-01-15T10:30:00.000Z' securitySchemes: Portkey-Key: type: apiKey in: header name: x-portkey-api-key ````