Update API Key

Update Api Keys

put

Authorizations

Portkey-Key

Path parameters

idstring · uuidRequired

Body

application/json

namestringOptionalExample: Development API Key

descriptionstringOptionalExample: API key for development environment

scopesstring[]OptionalExample: ["completions.write"]

alert_emailsstring · email[]OptionalExample: [email protected]

Responses

200

OK

application/json

Responseobject

put

DefaultDefaultDefaultSelf-HostedSelf-HostedSelf-Hosted

from portkey_ai import Portkey

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

# Update the API key
updated_api_key = portkey.api_keys.update(
    id="API_KEY_ID",
    name="API_KEY_NAME_0909",
    rate_limits=[
        {
            "type": "requests",
            "unit": "rpm",
            "value": 100
        }
    ],
    scopes=[
        "organisation_users.create", "organisation_users.read", "organisation_users.update",
        "organisation_users.delete", "organisation_users.list",
        "organisation_service_api_keys.create", "organisation_service_api_keys.update",
        "organisation_service_api_keys.read", "organisation_service_api_keys.delete",
        "organisation_service_api_keys.list", "workspaces.delete", "workspaces.create",
        "workspaces.read", "workspaces.update", "workspaces.list", "logs.export",
        "logs.list", "logs.view", "configs.create", "configs.update", "configs.delete",
        "configs.read", "configs.list", "virtual_keys.create", "virtual_keys.update",
        "virtual_keys.delete", "virtual_keys.duplicate", "virtual_keys.read",
        "virtual_keys.list", "virtual_keys.copy", "workspace_service_api_keys.create",
        "workspace_service_api_keys.delete", "workspace_service_api_keys.update",
        "workspace_service_api_keys.read", "workspace_service_api_keys.list",
        "workspace_user_api_keys.create", "workspace_user_api_keys.delete",
        "workspace_user_api_keys.update", "workspace_user_api_keys.read",
        "workspace_user_api_keys.list", "workspace_users.create", "workspace_users.read",
        "workspace_users.update", "workspace_users.delete", "workspace_users.list",
        "analytics.view"
    ]
)

print(updated_api_key)

200

OK

{}