Retrieve Integration

GET /integrations/{slug}

Python

Default

from portkey_ai import Portkey

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

# Get a specific virtual key
virtual_key = portkey.virtual_keys.retrieve(
    slug='VIRTUAL_KEY_SLUG'
)

print(virtual_key)

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ai_provider_id": "<string>",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "last_updated_at": "2023-11-07T05:31:56Z",
  "slug": "<string>",
  "description": "<string>",
  "masked_key": "<string>",
  "configurations": {
    "openai_organization": "<string>",
    "openai_project": "<string>"
  },
  "global_workspace_access_settings": {
    "enabled": true,
    "usage_limits": [
      {
        "credit_limit": 10,
        "periodic_reset": "monthly",
        "alert_threshold": 8
      }
    ],
    "rate_limits": [
      {
        "value": 123
      }
    ]
  },
  "allow_all_models": true,
  "workspace_count": 123,
  "secret_mappings": [
    {
      "target_field": "key",
      "secret_reference_id": "my-aws-secret",
      "secret_key": "<string>"
    }
  ]
}

Authorizations

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

Path Parameters

slug · string · required

Response

200 - application/json

Successful response

id · string<UUID>

organisation_id · string<UUID>

ai_provider_id · string

name · string

status · enum<string>

Available options: active, archived

created_at · string<date-time>

last_updated_at · string<date-time> | null

slug · string

description · string

object · enum<string>

Available options: integration

masked_key · string

Masked API key

configurations · OpenAI · object

Provider-specific configuration object

⚠️ Security Note - Response Masking: When retrieving integration details, sensitive fields are automatically masked:

• Sensitive fields get a masked_ prefix (e.g., client_secret → masked_client_secret)
• Non-sensitive fields (IDs, URLs, regions, etc.) remain unchanged

OpenAI

Azure OpenAI

AWS Bedrock

Vertex AI

Azure AI

Workers AI

AWS Sagemaker

Hugginface

Cortex

Custom Base URL

Show child attributes

global_workspace_access_settings · object

Global workspace access configuration

Show child attributes

allow_all_models · boolean

Whether new models will be enabled by default

workspace_count · integer

Number of workspaces with access to this integration

secret_mappings · object[]

Secret reference mappings for this integration. Valid target_field values are "key" or "configurations.".

Show child attributes