Retrieve an API Key

Get Api Keys

GEThttps://api.portkey.ai/v1/api-keys/{id}

Path parameters

id*string (uuid)

Response

200

OK

Headers

Body

application/json

idstring (uuid)

Example: "f47ac10b-58cc-4372-a567-0e02b2c3d479"

keystring

Example: "Xk*******S4"

namestring

Example: "Development API Key"

descriptionstring

Example: "API key for development environment"

typeenum

Example: "organisation-service"

organisation-serviceworkspace-serviceworkspace-user

organisation_idstring (uuid)

Example: "a1b2c3d4-e5f6-4a5b-8c7d-9e0f1a2b3c4d"

workspace_idstring

Example: "ws-myworkspace"

user_idstring (uuid)

Example: "c3d4e5f6-a7b8-6c7d-0e1f-2a3b4c5d6e7f"

statusenum

Example: "active"

activeexhausted

created_atstring (date-time)

Example: "2023-09-15T10:30:00Z"

last_updated_atstring (date-time)

Example: "2023-09-15T10:30:00Z"

creation_modeenum

Example: "ui"

uiapiauto

rate_limitsarray of object

usage_limitsUsageLimits (object)

reset_usagenumber

Example: 0

scopesarray of string

defaultsobject

objectenum

Example: "api-key"

api-key

Response

200

{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "key": "Xk*******S4",
  "name": "Development API Key",
  "description": "API key for development environment",
  "type": "organisation-service",
  "organisation_id": "a1b2c3d4-e5f6-4a5b-8c7d-9e0f1a2b3c4d",
  "workspace_id": "ws-myworkspace",
  "user_id": "c3d4e5f6-a7b8-6c7d-0e1f-2a3b4c5d6e7f",
  "status": "active",
  "created_at": "2023-09-15T10:30:00Z",
  "last_updated_at": "2023-09-15T10:30:00Z",
  "creation_mode": "ui",
  "rate_limits": [
    {
      "type": "requests",
      "unit": "rpm",
      "value": 100
    }
  ],
  "usage_limits": {
    "credit_limit": 10,
    "periodic_reset": "monthly",
    "alert_threshold": 8
  },
  "reset_usage": 0,
  "scopes": [
    "completions.write"
  ],
  "defaults": {
    "metadata": {
      "environment": "development",
      "team": "backend"
    },
    "config_id": "config-abc"
  },
  "object": "api-key"
}