tPjkr$#UdZddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl m Z m Z m Z mZddlmZmZmZddlmZmZmZmZmZmZmZmZddlZddlZddlmZmZmZm Z m!Z!m"Z"m#Z#ddl$Z$ddl%m&Z&ddl'm(Z(dd l)m*Z*dd l+m,Z,m-Z-m.Z.m/Z/dd l0m1Z1dd l2m3Z3dd l4m5Z5ddl6m7Z7m8Z8m9Z9ddl:m;Z;ddl<ddlZ>m?Z?ddl@mAZAmBZBmCZCmDZDmEZEddlFmGZGmHZHmIZIddlJmKZKddlLmMZMddlNmOZOddlPmQZQmRZRddlSmTZTmUZUddlVmWZWddlXmYZYddlZm[Z[ddl\m]Z]ddl^m_Z_ddl`maZambZbmcZcmdZdmeZemfZfmgZgmhZhddlimjZjdd lkmlZlmmZmmnZndd!lompZpdd"lqmrZrmsZsmtZtmuZumvZvmwZwdd#lxmyZydd$lzm{Z{dd%l|m}Z}dd&l~mZdd'lmZmZmZmZmZdd(lmZdd)lmZdd*lmZmZdd+lmZdd,lmZdd-lmZdd.lmZmZdd/lmZdd0lmZdd1lmZdd2lmZdd3lmZdd4lmZdd5lmZmZmZmZmZdd6lmZdd7lmZmZmZer dd8lmZdd9lmZed:e;ZGd<d=eZGd>d?eZGd@dAeZdBeedCeefdDZdEedCdFfdGZdEedCdHfdIZdEedCeefdJZdEedCee5fdKZdEedCefdLZdMedzdCdfdNZdOee>zfdPZdQedRedzdCedzfdSZdTedCefdUZ ddOedVedTedzdWedzdCdf dXZdYedRedzdZedzdCefd[Zd\edzdQedYed]ed^ef d_ZdOed`eedzfdaZdQedYedOed^efdbZdYedcedzfddZdeedzdCedzfdfZdYedOefdgZdQedzdYedOed^edCef dhZdie eefdzdCdfdjZ ddYedOeezdkedzdledRedzdCedmf dnZeZeedo<dOedpedCefdqZedrdshZeedt<dOedzdue>dYedCdfdvZdwdwdxdyedzdYedzed{edCdf d|ZdOedYedCdfd}Zd~eedzdedzdYededQedzdCdf dZdZedzdEedzfdZegdZ ddOeezdedCdfdZdOedYededzdQedzdCef dZdee>dOeezdedzdedzdeeefdeeefdedCdfdZdee>dOeezdedzdedzdedCdf dZdee>dQedOeezdCdfdZdee>dQedOeezdCdfdZdQedOeezdEedCdfdZeejjejjhZeed<dedOeezdEede[dCdf dZdee>dedOeezdCdfdZdee>dedOeezdCdfdZdYededEedCdfdZdedOeezdEedCdfdZeِjddgeeKge謟e{eeKeddfdOedYededzfdZeِjddgeeKge{eeKeddfdOedYededzfdZdOedededCefdZdOeezdue>fdZdpedue>dCefdZdOedue>dCefdZdedzdCdfdZ ddedzdEedzdedzdCe>fdZdOedue>dCefdZ ddedYededzdEedzde[dedkedzde dzdue>dzdCeeeffdZdOddeddue>dEedzde[dedCedzfdZdOedue>dYedkedzdledEede[dCdfdZeِjddgeeKge{eeKeddfde"dOedYededzfdZ eِjddgeeKgee{eeKeddfdOedYededzfdZ dede due>dzdCefd„Z eِjddgeeKgee{eeKeddfdOedYededzfdĄZ de>dƐededkefdȄZeِjddgeeKge{eeKeddfdOedYededzfdʄZdede ee eeffde*dzdCeeeeefffd̈́ZeِjddgeeKgdwϫdeeKfdOedzdYefdЄZeِj)ddgeeKge{ejBddҬӫeeKfdedzdYefdԄZdeedzdkedzdledCedmfdքZdgiidddddddddddddddddidddddgiidddddddddddddddddddddddddf7deddedzdedededededzdedzdedzdedzdedzdedzdedzdedzdedzdRedzdedzdZedzdedzdedzdedzdedzdiedzdedzdedzdeddedzdedzdedzdedzdedzdedzdedzdedzdedzdedzdedzdedzdedzdedzdedzdedzdeddzdedzdedzdedzdyedzdedzdedzdedzdeedzdVedzdTedzdedzdeedzd~edzfpdZdYeȐde>dEede[fdZde>de[dYedEedCef dZ ddede[dYededzdCeedzee>ff d Z ddee>dYededzdCeeeeffd Z dd ee eefdEed d dCdfdZ ddee>dEedYededzd d dCdf dZ ddeede[dEedYededzdCeedzee>ff dZdEedYeȐdededCdf dZ dYedCdfdZ!eِjddgeeKgeeKe!dwdfdYeȐdefdZ"eِj)ddgeeKgeeKfdYefdZ#dOedzdCefdZ$dEdded ed!edzdCdf d"Z%dEed#e>d$ededOedzdYededzde[dedCefd%Z&eِjd&dgeeKgeِjd'dgeeKge{ddeeKeddfdedzdOedzdYededzdCedzf d(Z'd#e>dYedEede[dCdf d)Z(d*eՐd#e>dCefd+Z)d,ed-edCdfd.Z*d~eeezdzdCee eefd/ffd0Z+d1e eefdCe eeffd2Z,dEed$ed~eeezdzdCdfd3Z-eِjd4dgeeKge{eeKeddfdedOe.dYededzdCeeeff d5Z/dYedRedzdZedzdedzdedzd6edzdEedCe0dzfd7Z1d8e0dzdEedCe̐efd9Z2dYeȐd:e̐edCeefd;Z3dYeȐd:e̐edCeefd<Z4dYeȐd:e̐edCeefd=Z5d8e0dzdYedEedCeefd>Z6d8e0dzdYedEedCeefd?Z7eܐd@dAhZ8eeڐdB<eِj)dCdgeeKge{eeKe!dDdEdDFe!dGdHdDdIJe!ddKe!ddLe!ddMe!ddNe!ddOe!dwdPe!dwdQe!dwdRe!ddSӫe!dTdUӫe!ddVe!ddWe!ddXe!ddYe!ddZe!dwd[e!dd\fde"dYeȐd]ed^edRedzdZedzdedzd6edzdedzd_eƐd`eƐdaeƐdbedzdceddeedzdeedzdedzdfedzdedzdgeƐdhedzdCe9f,diZ:dYedEedjeedkeedCdf dlZ;eِj)dmdgeeKge{eeKe!dDdDdEne!dodDdIdHpe!ddqe!ddrfdYeȐd]ed^edsedzdZedzdCeeeff dtZ<dbedzdcedCeeefdzfduZ=dvedwedCeeeffdxZ> ddRedzdZedzdedzdedzd6edzdyedzdzeedzd{eedzdaededzdfedzdedzd|eƐdvedzdCe eeffd}Z? ddEed]ed^edRedzdZedzdedzdedzd6edzdyedzd_eƐdzeedzd{eedzdaeƐdbedzdceddeedzdeedzdedzdfedzdedzd|eƐdvedzdCe9f.d~Z@dCe eeffdZAdYeȐdedzdEedzde[d^edCdf dZBeِjddgeeKge{eeKeddfdOeCde"dYededzdCe>dzf dZDeِjddgeeKge{eeKeddfdOeCde"dYededzfdZEeِjddgeeKgeFe{eeKfde"dYefdZGdYededzde>dCefdZHdYede"dee eefdCeIfdZJejdZLeeڐd<dedzdCdfdZM ddedzdEedzdedzdCdfdZNdedzdCdfdZOy(z` KEY MANAGEMENT All /key management endpoints /key/generate /key/info /key/update /key/delete N) AwaitableCallableMappingSequence)datetime timedeltatimezone) TYPE_CHECKINGAnyFinalLiteralOptionalProtocolTypeVarcast) APIRouterDependsHeader HTTPExceptionQueryRequeststatus)verbose_proxy_logger)uuid) DualCache)LENGTH_OF_LITELLM_GENERATED_KEYLITELLM_PROXY_ADMIN_NAMEMINIMUM_CUSTOM_KEY_LENGTHUI_SESSION_TOKEN_TEAM_ID)duration_in_seconds) safe_dumps)CredentialItem)(rotate_mcp_server_credentials_master_key&rotate_mcp_user_credentials_master_key#rotate_mcp_user_env_vars_master_key))rotate_sso_identity_assertions_master_key)*)Litellm_EntityTypeLiteLLM_VerificationToken hash_token)_delete_cache_key_objectcan_team_access_modelget_org_objectget_project_objectget_team_object)abbreviate_api_key0enforce_batch_enqueued_token_limit_is_admin_only-enforce_output_token_estimates_are_admin_only)user_api_key_auth)publish_auth_cache_invalidation)logging_metadata_config_error)decrypt_callback_varsencrypt_callback_vars)coordination_redis_cachepublish_config_change)!check_org_admin_can_generate_keysget_budget_reset_time)UserApiKeyCache)KeyManagementEventHooks)build_model_max_budget_usage)+_check_passthrough_routes_caller_permission_is_user_org_admin_for_team_is_user_team_admin_set_object_metadata_field_team_member_has_permission_user_has_admin_viewvalidate_budget_durationvalidate_finite_spend)_add_model_to_db) sync_key_access_group_membership-sync_key_regeneration_access_group_membership'sync_key_update_access_group_membership)with_settings_updated_at)_set_object_permission attach_object_permission_to_dict&handle_update_object_permission_common%validate_key_mcp_servers_against_team&validate_key_search_tools_against_team'validate_key_vector_stores_against_team)TeamMemberPermissionChecks)management_endpoint_wrapper)_is_master_key)get_ui_settings_cached) PrismaClient ProxyLogging_hash_token_if_neededhandle_exception_on_proxyis_valid_api_key)BaseRepository)BudgetRepository) ConfigParamConfigRepository)CredentialsRepository)ModelRepository) TableActions)"DeletedVerificationTokenRepository%DeprecatedVerificationTokenRepository)TeamRepository)UserRepository)VerificationTokenRepository)Router)raise_if_unsafe_secret_name) get_secret)BulkUpdateKeyRequestBulkUpdateKeyResponseBulkUpdateTeamKeysRequestFailedKeyUpdateSuccessfulKeyUpdate) Deployment) BudgetConfigPersonalUIKeyGenerationConfigTeamUIKeyGenerationConfig)Prisma)models_RepositoryModelT)boundceZdZdZededzfdZededzfdZededzfdZde ee ffdZ de ee ffdZ y) _UserRowLikezCRead-only view of the user columns ``/key/list`` expands keys with.returnNcyNselfs /home/oem/CyberBrain26-unified/.venv/lib/python3.12/site-packages/litellm/proxy/management_endpoints/key_management_endpoints.pyuser_idz_UserRowLike.user_ids%(cyr|r}r~s r user_emailz_UserRowLike.user_email(+rcyr|r}r~s r user_aliasz_UserRowLike.user_aliasrrcyr|r}r~s r model_dumpz_UserRowLike.model_dumprcyr|r}r~s rdictz_UserRowLike.dictrr) __name__ __module__ __qualname____doc__propertystrrrrrobjectrrr}rrryryslM (t(( +C$J++ +C$J++5GCK05/gc6k*/rryceZdZUeeed<y) _TxTableslitellm_proxymodeltableN)rrrrbr__annotations__r}rrrrs )&11rrcPeZdZdZdeefdZdeee fdeee fdedzfdZ y)_ConfigTableActionszYConfig table surface this module needs; the shared repository seam exposes no ``update``.rzc Kywr|r}r~s r find_manyz_ConfigTableActions.find_manyswheredataNc Kywr|r})rrrs rupdatez_ConfigTableActions.updates !r) rrrrrr^rrrrrr}rrrrsLc;+!6;!sF{#!c6k" ! t  !rr repositoryrzc.td|jS)NzTableActions[_RepositoryModelT])rtable)rs r _prisma_tablers ):+;+; r prisma_clientzDD rcustom_key_valuecK|ytd{}|jdddur$tjdt dddi y7=w) zHRaise 403 if custom API keys are disabled and a custom key was provided.Ndisable_custom_api_keysFTz;Custom API key rejected: disable_custom_api_keys is enablederrorzVCustom API key values are disabled by your administrator. Keys must be auto-generated. status_codedetail)rVgetrwarningr)r ui_settingss r_check_custom_key_allowedrsa577K0%8D@$$%bcuv  A8sAA>Arc|jduSr|team_idrs r _is_team_keyrs <// >> %&..G*CM rrotation_intervalc|tjtj}t |}|t |zS)a Helper function to calculate the next rotation time for a key based on the rotation interval. Args: rotation_interval: String representing the rotation interval (e.g., '30d', '90d', '1h') Returns: datetime: The calculated next rotation time in UTC seconds)rnowr utcr r)rrinterval_secondss r_calculate_key_rotation_timers3hll+C12CD #34 44r auto_rotateexisting_key_aliasc|r~|r{tjLtjjdur0|jd|t dt j dd|j||t|dyyy)ax Helper function to set rotation fields in key data if auto_rotate is enabled. Args: data: Dictionary to update with rotation fields auto_rotate: Whether auto rotation is enabled rotation_interval: The rotation interval string (required if auto_rotate is True) existing_key_alias: The existing key alias from the database (if any) NT key_aliaszkey_alias is required when auto_rotate=True and store_virtual_keys is enabled. This ensures stable secret naming during rotation.messagetypeparamcode)rrkey_rotation_at) litellm_key_management_settingsstore_virtual_keysrProxyExceptionProxyErrorTypesbad_request_errorrr)rrrrs r_set_key_rotation_fieldsrs(  , , 800CCtK%-"* \$66!   *%6#?@Q#R  ){ruser_api_key_dictrc|j(|jtjjk(ry|&||jk(sJd|d|j| |j |j t k(ryy)z Assert user only creates/updates keys for themselves Relevant issue: https://github.com/BerriAI/litellm/issues/7336 Tz6User can only create keys for themselves. Got user_id=z , Your ID=) user_roleLitellmUserRoles PROXY_ADMINvaluerr UI_TEAM_IDrrrs r_is_allowed_to_make_key_requestr9s"".3D3N3NRbRnRnRtRt3t+333 DWIZXiXqXqWr s 3  $ $ 05F5N5NR\5\ rassigned_user_idteam_key_generationroutec|,t||}|tdd|d|jt||j}|jduxr'|jt j jk(}|ry|'tdd|jd|jd|vr1|j|dvr tdd|jd |dtj||| y) NrrrUser=z not assigned to team=rTallowed_team_member_roleszTeam member role z" not in allowed_team_member_roles=team_member_objectrr) rrrrrrrrrolerS.does_team_member_have_permissions_for_endpoint)rrrrrkey_assigned_user_in_teamris_admins r%_team_key_operation_team_member_checkrSsM#+< \l+m! $ ,/00FzGYGYFZ[  !2ZQbQjQj k ##4/u4E4O4OScSoSoSuSu4u   #,4455KJL^L^K_`  $'::  # #+>?Z+[ [&'9'>'>&??abuwRcSbTU  MM- rrequired_paramscf|y|jd}|D]}||vstdd|dy)NT exclude_unsetrzRequired param z not in datar)rr)rr data_dictrs r$_key_generation_required_param_checkrsST:I   !(|<  rc|jtjjk(rytj &dtj vrtj d}nt ddg}t|j||||t||jdtj|||jy) NTradminuserrrrrrrrrraccess_group_ids)rrrrrkey_generation_settingsrsrrrrrS'enforce_member_can_assign_access_groupsr)rrrr_team_key_generations r_team_key_generation_checkrs ""&6&B&B&H&HH&&27LPWPoPo7o&>>?TU8'.&7 *+0 )   !23FF+.. rpersonal_key_generationct|d|vry|j|dvr tdd|dd|jy)Nallowed_user_rolesTrzBPersonal key creation has been restricted by admin. Allowed roles=z . Your role=r)rr)rr s r_personal_key_membership_checkr s&*>F]*]""*ABV*WWWXoqEYFXGGSTeToToSpq  robject_permissioncH|ytt|jdS)NTr)rObjectPermissionDictr)r s r_object_permission_to_dictrs+  $&7&B&BQU&B&V WWrctj|d|jtjtjj dytjd}t ||t||j dy)Nrr T)r r)rSrrrrrr r)rr_personal_key_generations r_personal_key_generation_checkrsFF+.. ''/  * * . ./H I Q&-&E&EF_&`" 8 )  $$%67 rcZt|}|jduxr'|jtjjk(}|rZ|*t j tdd|j||rytdd|jt||||St||S) z^ Check if admin has restricted key creation to certain roles for teams or individuals rNrz1Unable to find team object in database. Team ID: rTrrrr)rr) rrrrrrrrrrr)rrrr is_team_key _is_admins rkey_generation_checkrs&40K##4/u4E4O4OScSoSoSuSu4u  '"A"A"MJ4<<.Y  J4<<.Y *!/   .@QX\]]rmetadatac<t|}|tdd|iy)zKey-level logging writes go through key metadata, not /team/callback. Without this the same New Relic config the team endpoint rejects would be accepted here and then silently ignored or misrouted at request time. Nrrr)r5r)rrs r#raise_on_invalid_key_logging_configrs+ 1:E We4DEEr llm_router premium_userTc t||xs |j|jt|j||y#t$r}t dt |d}~wt $r}t dt |d}~wwxYw)zF Check if user is allowed to make a key request, for this key rrrN)rurrT) rrrAssertionErrorrr Exception_check_model_access_groupru)rrrrres rcommon_key_access_checksr$s '/+t||LL {{! !  q6    q6   s#&A B A  B,BBrouter data_jsonc|j}||jdd|S|j|d<|tjk(rdg|d<|S|tj k(rdg|d<|S|tj k(rdg|d<|S)z Handle the key type. Nkey_typellm_api_routesallowed_routesmanagement_routes info_routes)r(poprLiteLLMKeyTypeLLM_API MANAGEMENT READ_ONLY)rr&r(s rhandle_key_typer2AsmmH j$'$NNIj>)))'7&8 "#  ^.. .':&; "#  ^-- -'4o "# rr)r,&_NON_ADMIN_SAFE_ALLOWED_ROUTES_PRESETSexisting_key_rowc"|jtjjk(ry|yt |ddxs t }d|vryt |dd}||dk(r t ddt |dd}||k7rt dd|d |y) u Non-admin callers must not rebind a key's ``user_id`` to a different user. The ``user_id`` on a verification token is what ``_return_user_api_key_auth_obj`` resolves against ``litellm_usertable`` to derive the request's role; a non-admin rebinding their own key's ``user_id`` to a ``PROXY_ADMIN`` row promotes themselves. ``/key/update`` already enforces this inline; ``/key/regenerate`` did not. Sharing the check keeps both endpoints — and any future regenerate-style endpoint — consistent. Nmodel_fields_setrrz5Non-admin users cannot remove the user_id from a key.rzr?c|s|sy|jtjjk(ry|r|rt d|Dryt dddi)a Require PROXY_ADMIN when `allowed_routes` is present in the request body, unless the caller went through the `key_type` preset flow. Raw-body call sites pass `allowed_routes_was_provided="allowed_routes" in data.model_fields_set` so a caller that omits the field (model default flows through) is distinct from one that sends any explicit value. Post-`handle_key_type` call sites pass `allow_safe_presets=True` with the values derived by `handle_key_type`; those values are not from the request body, so `allowed_routes_was_provided` stays False and the safe-preset carve-out below accepts any list of tokens in `_NON_ADMIN_SAFE_ALLOWED_ROUTES_PRESETS`. Nc3,K|] }|tvywr|)r3).0rs r z:_check_allowed_routes_caller_permission..sT;;TsrrzjOnly proxy admins can set `allowed_routes` on a key. Use `key_type` to pick a preset route bucket instead.r)rrrrallr)r*rr>r?s r'_check_allowed_routes_caller_permissionrFs_, '~""&6&B&B&H&HH  T^T T  H  rcd|jv}|s |jsy|jtjj k(ryt dddi)z Require PROXY_ADMIN when `permissions` is present in the request body. Presence is detected via `data.model_fields_set` so a caller that omits the field (default flows through) is distinct from one that sends any explicit value. permissionsNrrz(Only proxy admins can set `permissions`.r)r6rHrrrrr)rrpermissions_in_requests r$_check_permissions_caller_permissionrJsZ%2T5J5J$J !$*:*:""&6&B&B&H&HH CD r budget_limitsdelegation_ceilingis_ui_session_team_keyc t|sytd|Dd}|tddd|jdi|jtj j k(ry|ry|jr|tdddiytfd |Dd}| tddd|jd d iy) a Enforce three invariants on `budget_limits`: - Every `budget_limits[*].max_budget` must be a finite number; applies to every caller including proxy admin. - A CLI session token caller may not set `budget_limits` on a personal key (one with no `team_id`); mirrors the scalar `max_budget` guard in `_common_key_generation_helper`. - Non-admin callers may not set a window above their delegation ceiling. Nc3`K|]&}tj|jr#|(ywr|)mathisfinite max_budgetrBws rrDz:_check_budget_limits_delegation_ceiling..sZAdmmALL>YaZs$..rrz budget_limits entry max_budget (z) must be a finite number.rzVbudget_limits cannot be set without specifying team_id when using a CLI session token.c3BK|]}|jkDs|ywr|rR)rBrTrLs rrDz:_check_budget_limits_delegation_ceiling..s^aALLK]<]^s-) cannot exceed the caller's own max_budget ().)nextrrRrrrris_session_token)rKrLrrMr non_finite over_ceilings ` r'_check_budget_limits_delegation_ceilingr]s" ZZ\`aJ @AVAV@WWqrt  ""&6&B&B&H&HH))j.@r  !^=^`deL6|7N7N6OPBBTAUUWY   rcK| tdd| tddtt|jd|id{}| tddy 7w) z[ Validate team_id is used in the request body for generating a service account key Nr[team_id is required for service account keys. Please specify `team_id` in the request body.rzgprisma_client is required for service account keys. Please specify `prisma_client` in the request body.rrz]team_id does not exist in the database. Please specify a valid `team_id` in the request body.T)rrre find_unique)rrteams r0validate_team_id_used_in_service_account_requestrcsp  |  &n]&CDPP'"QD |r   sAA! A A!)rR soft_budgetmax_parallel_requests tpm_limit rpm_limit fill_defaultsc |D]<}|\}}|tvs|tj|r*tdd|d|itj y|D]}|\}}t tj |d}|&||s+t|||9|dvr||kDsCtdd|d|d|i|d vs_t| }|d k(r td }n t| }||kDstdd|d|d|iy) z Enforce upperbound limits on key parameters. For key generation (fill_defaults=True): fills None values with upperbound defaults. For key update (fill_defaults=False): only validates explicitly provided values. Nrrz$ must be a finite number. Received: r)rRrerfrgz. is over max limit set in config - user_value=z ; max_value=)budget_durationdurationrk-1inf) _BUDGET_NUMERIC_KEYSrPrQrrupperbound_key_generate_paramsr8setattrr float)rrhelemkeyrupperbound_valueupperbound_duration user_durations r_enforce_upperbound_key_paramsrxs U & &5+<=='# ##u,PQVPW%XY --5! U"7#I#I3PTU  '} D#'78 //+(+ 'C50^_d^eeqsCrD*E$ ;;*=GW*X'}(-e (;U(K $'::+(+ 'C50^_d^eeqsCrD*E$9!rlitellm_changed_byc Kddlm}m}m}m}t ||||t |jt|j|jdur6|jtjjk7rtdddit!|d|d t#|d|d |jF|jj%d +|j&t)|j&| d{|j*}|j&} t,j.|D]} | \} } | G| d k7s| |j0vr4| dvr0t,j.j%| } | Ct3|| | Q| dk(r1| gk(r,t3|| t,j.j%| g| dk(s| ik(st3|| t,j.j%| it5|d|j&t6k(xr| du}|j8r@|jtjjk7r|s||tddd|di|j* |j*n|j8r| |j*nd}|jtjjk7r!|s||||kDrtddd|d|dit;|j<||||t?|| ddl m!}|||}|jJ}||jLtO|jL|jPxsi}|jS|jUd}tW|jXj[i||j\xs||j\xs|dd{}t_|dd}t`D]4}t_||dtc||t_|| te||6tfD]4}t_||dtc||t_|| te||6|jidd!}tk||}tm|j%d"|d#d$|vr|jod$d|d%<|||d<d |vr|jod d|d&<|j\|j\|d'<|j\|d(<d)|vrodd*lm}|dur+|d)&tqd+trjtj|j%d}|s d)|d)i|d<n |d)|dd)<|jod)|jtjjk(}tw|j%d,|||-d{}|||d,<ty|j%d,||.d{t{|j%d,||.d{t,j.t,j.j%d,nd}t}|t~r\|j%d,}|t||d,<n:t}|t~r*|jD]\}}|j||t||/d{}t|j%d0d1t|j%d0d|2d{t|jd{|jh|jjd3sMt|jd4kDr!|jdd5d6|jd7dnd6}tddd8|i|j3t|jtkrtddd9td:i|jdd;lm}mK} |r|jduxr'|jtjjk(}!|duxr)|jduxr|j|jk(}"|!s"|"s t||j|<d{t|j| |=d{}#|#tdd>|jt|#||?d{tdDd@d i|dAd id{}$|jL|$dB<tj|$}$|$j|$_Stjtj||$||C|$S7,#tD$r!}tGjHd|Yd}~@d}~wwxYw7777o777h7777w)ENr)litellm_proxy_admin_namerrr)rrrrTrrBOnly proxy admins can enable throttle_on_budget_exceeded on a key.rrtrexisting_metadatarentityservice_account_idrrrj)rRrrrerfrgrjrkrurrhrz max_budget (zJ) cannot be set without specifying team_id when using a CLI session token.rWrX)rKrLrrMrrr)&apply_enterprise_key_management_paramsz_litellm.proxy.proxy_server.generate_key_fn(): Enterprise key management params not applied - %s)rdmodel_max_budget exclude_none) created_by updated_byr budget_id object_data field_namerrrr*r*rr?rRkey_max_budgetkey_budget_durationrrtags)rz)Only premium users can add tags to keys. r r team_objris_proxy_adminr rr)r&rrr)rrsk-z****zIInvalid key format. LiteLLM Virtual Key must start with 'sk-'. Received: z9Invalid key format. LiteLLM Virtual Key must be at least  characters long.ruser_api_key_cacherorganization_idrorg_idrr+Organization not found for organization_id= org_tablerr request_type table_namerd)rresponserryr})Xlitellm.proxy.proxy_serverr{rrrr$rFrjrrthrottle_on_budget_exceededrrrrrr2r1rrrcrRrdefault_key_generate_paramsr6rqrxrrZr]rKrJFlitellm_enterprise.proxy.management_endpoints.key_management_endpointsrr!rdebugrrdLiteLLM_BudgetTablerjsonify_objectjsonr]rcreaterr81LiteLLM_ManagementEndpoint_MetadataFields_PremiumrCdelattr)LiteLLM_ManagementEndpoint_MetadataFieldsrr2rFr- ValueErrorCommonProxyErrorsnot_premium_userrPrQrR isinstanceritems setdefaultrM_validate_key_alias_format_enforce_unique_key_aliasrrt startswithlenrrr#_validate_caller_can_assign_key_orgr-_check_org_key_limitsgenerate_key_helper_fnGenerateKeyResponsemodel_validatetoken_idtokenasyncio create_taskr>async_key_generated_hook)%rrryrr{rrr_requested_max_budget_requested_team_idrsrtr default_valuerMrLrr# _budget_id budget_row new_budget_budgetfieldr& _metadata_is_proxy_admin_callernormalized_object_permission_default_object_permission_caller_object_permission _op_field_op_default_value_maskedr_is_proxy_admin_org_inherited_from_teamrrs% r_common_key_generation_helperrXsN + ! T112' 6 ''4/4E4O4OScSoSoSuSu4uab  2 +  5 +  }} T]]%6%67K%L%X]a]i]i]q>LL'   $(?? $ **6 UDJC --D  ,((-+5 ) +   6dJGJ T%5%5%A/((!228b *88VZ9[\ BRS`BaBgBgBnBn/77S;S/77S;SCoC = Wk48 C! 4 % 1 &  dE*  D% !;! 4 % 1 &  dE*  D% !dFIi0I, }}%56+y &/mmL$&G "#!+ + I%+4==9JD+Q '(  ,"3";"; ,"3";"; ,; t # &(9(EHIZIkIkIqIqHrst t$==4 %+Yv->$?Ij !,5f,=Ij !& ) f%6$?$?CSC_C_CeCe$e0U#--(;<#- 1+ $/)E %& 0#--(;<-  2#--(;<-   . . : ++//0CD  ,d3+4==9L+M! $ ,-12L-MI) * 14 80J0P0P0R S, ,)44Y@QR S-#I {D)IJ #-- T2#  $DHH --- xxDHH$7$7$>ADTXXQRARDHHRaL>dhhrsm_=X^hiphqrs   xxDHH 0I ITUnTopAB   'P  "++47V%//3C3O3O3U3UU  $&G..d:G((J,F,FF % #+C9&7$($8$8"/ &4++#5+& I  # #HI]I]H^_(#+   ,^^)^X]^^H"..H]"11(;H&&HN 88/1   OG  T  "" mop   = \+ . .H    _s#C5e17d#8A0e1)A e13e19Ee1<d& B+e16e7'e1Ee1e(e10e+11e1"e-#e1;e/JMll'$'!56N6R6RSXZ[6\5]]noxnyzKLWKXXcdCcD E "" / 5 5 7  E9+0H0L0LUTU0VYb0beu0u# #12J2N2NuVW2X1YYjktjuvGHSGTT_`p_qr-2M2Q2QRW2X/3044UA>JMll'$'!56N6R6RSXZ[6\5]]noxnyzKLWKXXcdCcD E #rc |3t|dkDr%td|D}td|D}nd}d}|j7|5|j|z|kDr#tdd|d|jd|d | |j9|6|j|z|kDr#tdd |d |jd|d | yyy)zw Generic function to check if a key is allocating rpm/tpm limits. Raises an error if we're overallocating. Nrc3NK|]}|j|jywr|)rfrBrts rrDz,_check_key_rpm_tpm_limits..WcS]]=VCMMW%%c3NK|]}|j|jywr|)rgrs rrDz,_check_key_rpm_tpm_limits..rrrrrrrrrrr)rsumrfrrg)rrrrr allocated_tpm allocated_rpms r_check_key_rpm_tpm_limitsrs# CIMWTWW WTWW    "  ( NN] *-= =)-8I$..IYYjkvjwxCDTCUV  "  ( NN] *-= =)-8I$..IYYjkvjwxCDTCUV   > ) #rc i}i}|jr8|jjdi}|jjdi}t|||j|j||dy)zs Check if the team key is allocating model specific limits. If so, raise an error if we're overallocating. rrrbrrrrrrrN)rrrrgrf)rrrrrs r$check_team_key_model_specific_limitsr6sx#%"$&0&9&9&=&=>OQS&T#&0&9&9&=&=>OQS&T#$  #--#--$?$?rcLt|||j|jdy)zl Check if the team key is allocating rpm/tpm limits. If so, raise an error if we're overallocating. rbrrrrrN)rrgrfrrrs rcheck_team_key_rpm_tpm_limitsrOs'  #--#-- rcK|jdk7r|jdk7rytt|j d|j id{}t |tr@|j4t|j}|Dcgc]}|j|k7s|}}t|||t|||y7qcc}ww)z Check if the team key is allocating guaranteed throughput limits. If so, raise an error if we're overallocating. Only runs check if tpm_limit_type or rpm_limit_type is "guaranteed_throughput" guaranteed_throughputNrr`r) tpm_limit_typerpm_limit_typerrgrrrUpdateKeyRequestrtrYrrr)rrrr hashed_keyrts r_check_team_key_limitsr `s 55$:M:MQh:h :=IJTT*,,-U D $()dhh.B1$((; #?syyJ'>??(   "   @s*ACC9CC $C ( C C_INHERITED_MODEL_SENTINELS project_idrc Kt|||d{}|tddd|i|jrbt|jdkDrJ|jD];}||jvs|tvstddd |d |jd |id}|j t |j d d}|j5|2|j|kDr"tddd |jd|d|iyyy7w)aB Validate that key's models and budget respect its project's limits. - Key models must be a subset of project models, except the all-team-models / all-proxy-models sentinels, which inherit a parent scope and are narrowed by the project at request time - Key max_budget must be <= project max_budget )r rrNrzProject not found, project_id=rrrzModel 'z:' not in project's allowed models. Project allowed models=z . Project: rRzKey max_budget (z ) exceeds project's max_budget (z ). Project: )r.rrurr litellm_budget_tabler8rR)r rrr project_objmproject_max_budgets r_check_project_key_limitsrsp 2#- K =j\JK   {{s;--.2 A ***q8R/R# #71#-ghshzhzg{|GHRGS"T ''3$[%E%E|UYZ "'9'E$//\nJn+DOO+<<\]o\pp|~H}IJ  Ko'E"9sDDAD/D8B Drc 0d}d}i}i}|j,|jj}|jj}|jr8|jj di}|jj di}t ||||||dy)z{ Check if the organization key is allocating model specific limits. If so, raise an error if we're overallocating. Nrr organizationr)rrgrfrrr)rrrrrrrs r#check_org_key_model_specific_limitsrs"$"$%%1$99CC$99CC&/&8&8&<&<=NPR&S#&/&8&8&<&<=NPR&S#$  ))$?$?"rcd}d}|j,|jj}|jj}t||||dy)zt Check if the organization key is allocating rpm/tpm limits. If so, raise an error if we're overallocating. Nrr)rrgrfr)rrrrrs rcheck_org_key_rpm_tpm_limitsrsW%%1$99CC$99CC  ))" rrcK|jttjdt t |j d|jiddid{}|r t|ddnd}|xsgDchc]}|j|j}}||vrttjd|y7bcc}ww) aReject ``/key/update`` requests that point a key at an organization the caller does not belong to. Mirrors the org-membership rule already enforced on ``/key/list`` in ``validate_key_list_check``. Proxy admins are checked at the call site. NzNCannot assign a key to an organization without a user_id on the caller's tokenrrorganization_membershipsTrincludez*Caller is not a member of organization_id=) rrrHTTP_403_FORBIDDENrrfrar8r)rrruser_row memberships membershipmember_org_idss rrrs  (11c  *.*GHTT+334+T2UHQY+EtL^bK6A6GR'1JLfLfLr ""Nn,11??PQ  - s*AC  C!C >CC&C C c\Kt|ddxs*|jr|jjddnd}t|ddxs*|jr|jjddnd}|dk7r|dk7rytt |j d|j id{}t|tr@|j4t|j}|Dcgc]}|j|k7s|}}t|||t|||y7qcc}ww)z Check if the organization key is allocating guaranteed throughput limits. If so, raise an error if we're overallocating. Only runs check if tpm_limit_type or rpm_limit_type is "guaranteed_throughput" rNrrrr`)rrr)r8rrrrgrrrrrtrYrrr)rrrrrrrrts rrrs/$D*:DA59]] *D1$D*:DA59]] *D100^G^5^:=IJTT )";";<U D $()dhh.B1$((; #?syyJ'>??'   !   @s*B1D,3D%49D,-D'D' D,'D,z /key/generatezkey management)r dependenciesresponse_modelzThe litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability) descriptioncK ddlm}ddlm}m}m}|1t tjd|jjitjdt|d{|jJtj |jr|jdkrt d dd |ji|j"Jtj |j"r|j"dkrt d dd |j"i|}|rt%j&|r||d{}n t)d |j+d d} |j+dd} | st tj,| t/|j0|d|j2vt5|||j6duxr'|j6t8j:jk(} | s=|j<1|j<|_tj>d|j<d} |j@- tC|j@|||jDdd{} tI| ||tJjL| tO| ||d{|jP!tS|jP|||d{tU|||| d{S777#tF$r=} tjd| | st d d|j@dYd} ~ d} ~ wwxYw77n7Y#tF$r&} tjVd| tY| d} ~ wwxYww)an& Generate an API key based on the provided data. Docs: https://docs.litellm.ai/docs/proxy/virtual_keys Parameters: - duration: Optional[str] - Specify the length of time the token is valid for. You can set duration as seconds ("30s"), minutes ("30m"), hours ("30h"), days ("30d"). - key_alias: Optional[str] - User defined key alias - key: Optional[str] - User defined key value. Must start with 'sk-' and be at least 16 characters long. If not set, a 16-digit unique sk-key is created for you. - team_id: Optional[str] - The team id of the key - user_id: Optional[str] - The user id of the key - agent_id: Optional[str] - The agent id associated with the key. - organization_id: Optional[str] - The organization id of the key. If not set, and team_id is set, the organization id will be the same as the team id. If conflict, an error will be raised. - project_id: Optional[str] - The project id of the key. When set, models and max_budget are validated against the project's limits. - budget_id: Optional[str] - The budget id associated with the key. Created by calling `/budget/new`. - models: Optional[list] - Model_name's a user is allowed to call. (if empty, key is allowed to call all models) - aliases: Optional[dict] - Any alias mappings, on top of anything in the config.yaml model list. - https://docs.litellm.ai/docs/proxy/virtual_keys#managing-auth---upgradedowngrade-models - config: Optional[dict] - any key-specific configs, overrides config in config.yaml - spend: Optional[int] - Amount spent by key. Default is 0. Will be updated by proxy whenever key is used. https://docs.litellm.ai/docs/proxy/virtual_keys#managing-auth---tracking-spend - send_invite_email: Optional[bool] - Whether to send an invite email to the user_id, with the generate key - max_budget: Optional[float] - Specify max budget for a given key. - budget_duration: Optional[str] - Budget is reset at the end of specified duration. If not set, budget is never reset. You can set duration as seconds ("30s"), minutes ("30m"), hours ("30h"), days ("30d"). - max_parallel_requests: Optional[int] - Rate limit a user based on the number of parallel requests. Raises 429 error, if user's parallel requests > x. - metadata: Optional[dict] - Metadata for key, store information for key. Example metadata = {"team": "core-infra", "app": "app2", "email": "ishaan@berri.ai" } - guardrails: Optional[List[str]] - List of active guardrails for the key - policies: Optional[List[str]] - List of policy names to apply to the key. Policies define guardrails, conditions, and inheritance rules. - disable_global_guardrails: Optional[bool] - Whether to disable global guardrails for the key. - throttle_on_budget_exceeded: Optional[bool] - When the key exceeds its max_budget, throttle its tpm/rpm to the global budget_exceeded_throttle_percentage instead of blocking the key entirely. - enable_prompt_caching: Optional[bool] - Auto-inject prompt caching breakpoints (Anthropic cache_control markers) on requests made with this key. Anthropic and Bedrock Claude models only. - permissions: Optional[dict] - key-specific permissions. Currently just used for turning off pii masking (if connected). Example - {"pii": false} - model_max_budget: Optional[Dict[str, BudgetConfig]] - Model-specific budgets {"gpt-4": {"budget_limit": 0.0005, "time_period": "30d"}}}. IF null or {} then no model specific budget. - budget_fallbacks: Optional[Dict[str, List[str]]] - Per-model fallback chain tried in order when that model's own `model_max_budget` is exceeded, e.g. {"gpt-4o": ["gpt-4o-mini"]}. - model_rpm_limit: Optional[dict] - key-specific model rpm limit. Example - {"text-davinci-002": 1000, "gpt-3.5-turbo": 1000}. IF null or {} then no model specific rpm limit. - model_tpm_limit: Optional[dict] - key-specific model tpm limit. Example - {"text-davinci-002": 1000, "gpt-3.5-turbo": 1000}. IF null or {} then no model specific tpm limit. - default_estimated_output_tokens: Optional[int] - Proxy admin only. Expected output tokens reserved for TPM limiting when a request omits max_tokens. Positive integer. Falls back to the team setting, then to the built-in estimate. - default_estimated_output_tokens_per_model: Optional[dict] - Proxy admin only. Per-model override of the above. Example - {"gpt-4": 4096, "gpt-3.5-turbo": 1024}. Takes precedence over the key-wide value. - mcp_rpm_limit: Optional[dict] - key-specific per-MCP-server rpm limit, keyed by MCP server name (alias if set, else the configured name). Example - {"github": 100, "slack": 200}. IF null or {} then no MCP-specific rpm limit. - tag_rpm_limit: Optional[dict] - key-specific per-request-tag rpm limit, keyed by request tag. Example - {"cell-1": 1000, "cell-2": 500}. Each tag gets an independent counter; requests whose tag is absent fall back to the key-level rpm limit. - tpm_limit_type: Optional[str] - Type of tpm limit. Options: "best_effort_throughput" (no error if we're overallocating tpm), "guaranteed_throughput" (raise an error if we're overallocating tpm), "dynamic" (dynamically exceed limit when no 429 errors). Defaults to "best_effort_throughput". - rpm_limit_type: Optional[str] - Type of rpm limit. Options: "best_effort_throughput" (no error if we're overallocating rpm), "guaranteed_throughput" (raise an error if we're overallocating rpm), "dynamic" (dynamically exceed limit when no 429 errors). Defaults to "best_effort_throughput". - allowed_cache_controls: Optional[list] - List of allowed cache control values. Example - ["no-cache", "no-store"]. See all values - https://docs.litellm.ai/docs/proxy/caching#turn-on--off-caching-per-request - blocked: Optional[bool] - Whether the key is blocked. - rpm_limit: Optional[int] - Specify rpm limit for a given key (Requests per minute) - tpm_limit: Optional[int] - Specify tpm limit for a given key (Tokens per minute) - soft_budget: Optional[float] - Specify soft budget for a given key. Will trigger a slack alert when this soft budget is reached. - tags: Optional[List[str]] - Tags for [tracking spend](https://litellm.vercel.app/docs/proxy/enterprise#tracking-spend-for-custom-tags) and/or doing [tag-based routing](https://litellm.vercel.app/docs/proxy/tag_routing). - prompts: Optional[List[str]] - List of prompts that the key is allowed to use. - enforced_params: Optional[List[str]] - List of enforced params for the key (Enterprise only). [Docs](https://docs.litellm.ai/docs/proxy/enterprise#enforce-required-params-for-llm-requests) - prompts: Optional[List[str]] - List of prompts that the key is allowed to use. - allowed_routes: Optional[list] - List of allowed routes for the key. Store the actual route or store a wildcard pattern for a set of routes. Example - ["/chat/completions", "/embeddings", "/keys/*"] - allowed_passthrough_routes: Optional[list] - List of allowed pass through endpoints for the key. Store the actual endpoint or store a wildcard pattern for a set of endpoints. Example - ["/my-custom-endpoint"]. Use this instead of allowed_routes, if you just want to specify which pass through endpoints the key can access, without specifying the routes. If allowed_routes is specified, allowed_pass_through_endpoints is ignored. - object_permission: Optional[LiteLLM_ObjectPermissionBase] - key-specific object permission. Example - {"vector_stores": ["vector_store_1", "vector_store_2"], "agents": ["agent_1", "agent_2"], "agent_access_groups": ["dev_group"]}. IF null or {} then no object permission. - key_type: Optional[str] - Type of key that determines default allowed routes. Options: "llm_api" (can call LLM API routes), "management" (can call management routes), "read_only" (can only call info/read routes), "default" (uses default allowed routes). Defaults to "default". - prompts: Optional[List[str]] - List of allowed prompts for the key. If specified, the key will only be able to use these specific prompts. - auto_rotate: Optional[bool] - Whether this key should be automatically rotated (regenerated) - rotation_interval: Optional[str] - How often to auto-rotate this key (e.g., '30s', '30m', '30h', '30d'). Required if auto_rotate=True. - allowed_vector_store_indexes: Optional[List[dict]] - List of allowed vector store indexes for the key. Example - [{"index_name": "my-index", "index_permissions": ["write", "read"]}]. If specified, the key will only be able to use these specific vector store indexes. Create index, using `/v1/indexes` endpoint. - router_settings: Optional[UpdateRouterConfig] - key-specific router settings. Example - {"model_group_retry_policy": {"gpt-4": {"RateLimitErrorRetries": 5}}}. IF null or {} then no router settings. - access_group_ids: Optional[List[str]] - List of access group IDs to associate with the key. Access groups define which models a key can access. Example - ["access_group_1", "access_group_2"]. - budget_limits: Optional[list] - List of concurrent budget windows for the key. Each window specifies a budget_limit, time_period, and optional budget_duration. Example - [{"budget_limit": 10.0, "time_period": "1d"}, {"budget_limit": 50.0, "time_period": "7d"}]. Examples: 1. Allow users to turn on/off pii masking ```bash curl --location 'http://0.0.0.0:4000/key/generate' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{ "permissions": {"allow_pii_controls": true} }' ``` Returns: - key: (str) The generated api key - expires: (datetime) Datetime object for when key expires. - user_id: (str) Unique user id - used for tracking spend across multiple keys for same user id. rrrruser_custom_key_generateNrrentered /key/generaterr;max_budget must be a non-negative finite number. Received: zrzt&D D !OPP$jjT:H#ZZ 3]^G#0I0IRYZZ/../(8D%,MMM(M)M,M6-M0M3K55 L;>3L61M6L;;MMM M3 !M..M33M6z/key/service-account/generate)rr"cKddlm}ddlm}m}m}|1t tjd|jjit|d{t|j|d|jv t|| t!|j"| d{t%j&d |}|rt)j*|r||d{}n t-d |j/dd} |j/dd} | st tj0| d} |j"- t3|j"|||j4dd{} | t9| ||d{t;| ||t<j>d|_ tC|||| d{S7n7!77_#t6$r"} t%j&d| d} Yd} ~ d} ~ wwxYw7w7>w)a Generate a Service Account API key based on the provided data. This key does not belong to any user. It belongs to the team. Why use a service account key? - Prevent key from being deleted when user is deleted. - Apply team limits, not team member limits to key. Docs: https://docs.litellm.ai/docs/proxy/virtual_keys Parameters: - duration: Optional[str] - Specify the length of time the token is valid for. You can set duration as seconds ("30s"), minutes ("30m"), hours ("30h"), days ("30d"). - key_alias: Optional[str] - User defined key alias - key: Optional[str] - User defined key value. Must start with 'sk-' and be at least 16 characters long. If not set, a 16-digit unique sk-key is created for you. - team_id: Optional[str] - The team id of the key - user_id: Optional[str] - [NON-FUNCTIONAL] THIS WILL BE IGNORED. The user id of the key - budget_id: Optional[str] - The budget id associated with the key. Created by calling `/budget/new`. - models: Optional[list] - Model_name's a user is allowed to call. (if empty, key is allowed to call all models) - aliases: Optional[dict] - Any alias mappings, on top of anything in the config.yaml model list. - https://docs.litellm.ai/docs/proxy/virtual_keys#managing-auth---upgradedowngrade-models - config: Optional[dict] - any key-specific configs, overrides config in config.yaml - spend: Optional[int] - Amount spent by key. Default is 0. Will be updated by proxy whenever key is used. https://docs.litellm.ai/docs/proxy/virtual_keys#managing-auth---tracking-spend - send_invite_email: Optional[bool] - Whether to send an invite email to the user_id, with the generate key - max_budget: Optional[float] - Specify max budget for a given key. - budget_duration: Optional[str] - Budget is reset at the end of specified duration. If not set, budget is never reset. You can set duration as seconds ("30s"), minutes ("30m"), hours ("30h"), days ("30d"). - max_parallel_requests: Optional[int] - Rate limit a user based on the number of parallel requests. Raises 429 error, if user's parallel requests > x. - metadata: Optional[dict] - Metadata for key, store information for key. Example metadata = {"team": "core-infra", "app": "app2", "email": "ishaan@berri.ai" } - guardrails: Optional[List[str]] - List of active guardrails for the key - permissions: Optional[dict] - key-specific permissions. Currently just used for turning off pii masking (if connected). Example - {"pii": false} - model_max_budget: Optional[Dict[str, BudgetConfig]] - Model-specific budgets {"gpt-4": {"budget_limit": 0.0005, "time_period": "30d"}}}. IF null or {} then no model specific budget. - budget_fallbacks: Optional[Dict[str, List[str]]] - Per-model fallback chain tried in order when that model's own `model_max_budget` is exceeded, e.g. {"gpt-4o": ["gpt-4o-mini"]}. - model_rpm_limit: Optional[dict] - key-specific model rpm limit. Example - {"text-davinci-002": 1000, "gpt-3.5-turbo": 1000}. IF null or {} then no model specific rpm limit. - model_tpm_limit: Optional[dict] - key-specific model tpm limit. Example - {"text-davinci-002": 1000, "gpt-3.5-turbo": 1000}. IF null or {} then no model specific tpm limit. - default_estimated_output_tokens: Optional[int] - Proxy admin only. Expected output tokens reserved for TPM limiting when a request omits max_tokens. Positive integer. Falls back to the team setting, then to the built-in estimate. - default_estimated_output_tokens_per_model: Optional[dict] - Proxy admin only. Per-model override of the above. Example - {"gpt-4": 4096, "gpt-3.5-turbo": 1024}. Takes precedence over the key-wide value. - mcp_rpm_limit: Optional[dict] - key-specific per-MCP-server rpm limit, keyed by MCP server name (alias if set, else the configured name). Example - {"github": 100, "slack": 200}. IF null or {} then no MCP-specific rpm limit. - tpm_limit_type: Optional[str] - TPM rate limit type - "best_effort_throughput", "guaranteed_throughput", or "dynamic" - rpm_limit_type: Optional[str] - RPM rate limit type - "best_effort_throughput", "guaranteed_throughput", or "dynamic" - allowed_cache_controls: Optional[list] - List of allowed cache control values. Example - ["no-cache", "no-store"]. See all values - https://docs.litellm.ai/docs/proxy/caching#turn-on--off-caching-per-request - blocked: Optional[bool] - Whether the key is blocked. - rpm_limit: Optional[int] - Specify rpm limit for a given key (Requests per minute) - tpm_limit: Optional[int] - Specify tpm limit for a given key (Tokens per minute) - soft_budget: Optional[float] - Specify soft budget for a given key. Will trigger a slack alert when this soft budget is reached. - tags: Optional[List[str]] - Tags for [tracking spend](https://litellm.vercel.app/docs/proxy/enterprise#tracking-spend-for-custom-tags) and/or doing [tag-based routing](https://litellm.vercel.app/docs/proxy/tag_routing). - enforced_params: Optional[List[str]] - List of enforced params for the key (Enterprise only). [Docs](https://docs.litellm.ai/docs/proxy/enterprise#enforce-required-params-for-llm-requests) - allowed_routes: Optional[list] - List of allowed routes for the key. Store the actual route or store a wildcard pattern for a set of routes. Example - ["/chat/completions", "/embeddings", "/keys/*"] - object_permission: Optional[LiteLLM_ObjectPermissionBase] - key-specific object permission. Example - {"vector_stores": ["vector_store_1", "vector_store_2"], "agents": ["agent_1", "agent_2"], "agent_access_groups": ["dev_group"]}. IF null or {} then no object permission. Examples: - allowed_vector_store_indexes: Optional[List[dict]] - List of allowed vector store indexes for the key. Example - [{"index_name": "my-index", "index_permissions": ["write", "read"]}]. If specified, the key will only be able to use these specific vector store indexes. Create index, using `/v1/indexes` endpoint. 1. Allow users to turn on/off pii masking ```bash curl --location 'http://0.0.0.0:4000/key/generate' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{ "permissions": {"allow_pii_controls": true} }' ``` Returns: - key: (str) The generated api key - expires: (datetime) Datetime object for when key expires. - user_id: (str) Unique user id - used for tracking spend across multiple keys for same user id. rr&r'Nrrr*r*r/rrr)r,r-Trr.r0r3r5rr7)"r8rrrrr(rrr9r:rr:rFr*r6r@rcrrrr;r<rrrr/r1r!r rr=KEY_GENERATE_SERVICE_ACCOUNTrr) rrryrrrr(r@rAr-rrr#s rgenerate_service_account_key_fnrEs`7 ==.EEKKL  ,>O PPP+**+$48M8M$M 0 + ; #  67]u+  & &'? @":4"@@FKL L **Z6I/YZF,E,EgV V48J || . +#5!2!C!C"  J$!'   + !>> DL. +-  wQA  & &'Y[\ ]J    sAG?GAG?%G&=G?#G $AG?'G +G ,G 0G?G;:G?>G=?G?G? G? G G8G3.G?3G88G?=G?non_default_valuesr~c~t|jdd|vr|j|d<tt|d}t D]9}|j|}|| ||vr|||k7rt d|d|||<;|jdd} |jD]T\}}|tvr)t|tr|j||<n|||<|tvs@dd lm} |r| ||||<V t'||d<|S#t $r } t#j$d | Yd} ~ 4d} ~ wwxYw) zu Check LiteLLM_ManagementEndpoint_MetadataFields (proxy/_types.py) for fields that are allowed to be updated rNrz8 is immutable once set and cannot be changed via update.rTrr)_premium_user_checkzLlitellm.proxy.proxy_server.prepare_metadata_fields(): Exception occured - %s)rrcopyrr LiteLLM_Reserved_Metadata_Fieldsrrrrrr isoformatrlitellm.proxy.utilsrHr!rr?r7) rrFr~casted_metadatareserved_fieldexisting_valuer&kvrHr#s rprepare_metadata_fieldsrRsy((:(>(>z(JK++):)?)?)A:&!$(::(FGO; 9*..~>  !   " o -/.2QUc2c())ab +9' 9.2__4^b_-cI OO% 'DAq==a*)*OA&)*OA&EEC'*%&" '$&;?%Kz"   && Z\]   sAD+D D<D77D<c K|jd}|jdd|jdd|jdd|jB|jjd'|jxs |j t dd i}t D](}t||dt||t|| *|jD]\}}|tvs|t vr|||<d |vr|jd }||d k(rd|d <na|r_t|trOt|dkDrAt|}tj t"j$t'|z} | |d <d|vrU|jd} | d|d<d|d<n7t| tr't| dkDrddlm} | | } | |d<| |d<d|vr|d} | rxddlm} g}| D]R}t|t,r|n|j}| |dj/|d<|j1|Tt3j4||d<nt3j4d|d<d|vrt7||d{}|jxsi}d|vrt9|dd|vr|dt;|d|d<t=|||}|S7Pw)NTrrtnew_key grace_periodrrr_rrrkrmexpiresrrlrrjbudget_reset_atr;rjrKreset_atr )r&r4rrouter_settings)rrFr~)rr-rrrrrr8rCrrrrrr rrr rr)litellm.proxy.common_utils.timezone_utilsr<rrKappendrdumps _handle_update_object_permissionvalidate_model_max_budgetr!rR)rr4r&rFrrPrQrk duration_srVrjr< key_reset_at raw_windowsinitialized_windowswindowrTrs rprepare_key_update_datares."__4_@I MM% MM)T" MM.$' ! MM  2 3 ? \\ 5-55 >p  C 4 % 1 &  dE* !"1 9 9QBs=s  !1" '',00<  x4/,0 y ) :h4#h-!:K 3X FJ%\\(,,7)J:WWG,3 y )..!3!7!78I!J  "48 0 148 0 1  -#o2F2J W"7"XL4@ 0 14C 0 1,,/@  W)+ % .(6FFQSW=X+ YEZ  # ($44..   > 22,,   7D#M27i{I.Qi718D 4yA~async_key_updated_hookhasattrrrr-)r}rryrrr~rrr4rAr-rrrF_datarupdated_key_infos r_process_single_key_updatersD+667( + !?$(('"   5 *33+  (XX/%00'-1    )  & &'= >"89K"LLFIJ J **Z6I/YZF,E,EgV V##5UK37H!!-(&..'1     M$=(#'+  0CST  E   !ST '  1!     7=LLALLL1L2A L?L ,L,L -*LLBL8L;L>LLLL L LLrrLiteLLM_TeamTableCachedObjrcK|}|-|jr!t|j||dd{}t|j}|jduxs|j|jk(}t |||||r |jndd{} t |||d{t |||d{| S7747 7 w)zEValidate MCP servers in object_permission against the effective team.NTr)r rrrexisting_key_object_permissionr)rr/rr rPrQrR) rrr4rrreffective_team_objobject_permission_dictteam_unchangedrs r$_validate_mcp_servers_for_key_updater} s"!&6&>&>#2$,,'1 $   %?t?U?U$V LLD0\DLLDTD\D\4\N0U0##%M['7'I'Iae 1+  10#%  20#%  ('3 + sF-CCA#CCC)C *C?C CC C Cc Kt|jt|j|jt j jk(}t|j|d|jvt||t||t|||t|||j||t!j"|t$j&|||d{|j(duxr|j(|j(k7xs|jduxsd|jv}t+|d d} t-| t.r| j1d nd} |j2d ur| d ur|st5d d dit7|t-| t.r| nd|dt9|t-| t.r| nd|d|jduxr6t+|dd|jk(xrt+|dd|jk(} t+|dddu} | xs| xr| } |s,|*| s(|j:}t=|||||rdndd{d}|j>xs t+|dd}|ZtA|||d d{}|)|j>|st5dd|j>d|tC|||d{t!jD|||jFt+|ddxs t+|dd}|/|jH |j(tK||||d{t+|d d}|jL1|jL|k7r"|s tO||jL|!d{|jLxs|}|jLduxs>|jPduxs.|jRduxs|jTduxs|jVdu}|@|r>tY|||"d{}|t5dd#|t[|||$d{t]||%r9|t5dd d&i|t5d'd d(it_||||)d{|j`-tc||||||*d{}|ted+i||_0yyy77Z7'77{74777T71w),z4Validate permissions and constraints for key update.r*r/rrr4r)rrrrrrNrKrrTrrr|rrtr}rrrz/key/update (max_budget/spend) /key/updaterrxrrrrrr4z8. Non-admin users cannot set keys to non-existent teams.r5rr r6rrrrrrjrrrr)rrr4rrrr})3rGspendrFrjrrrrrFr*r6r@rJr=r$rrSrr=rrRr8rrrrrr2r1r_check_key_admin_accessrr/r rrrurrrrfrgrrr-rrkrr rLiteLLM_ObjectPermissionBase)rr4rrrrrr_is_budget_change_existing_metadata_existing_throttlecaller_is_creator_key_is_team_keycan_skip_admin_checkrr_team_id_to_check_project_id_to_check_existing_org_id_org_id_to_check_throughput_fields_changedrrs r_validate_update_key_datar s$**%T112.88> % + >> % +   d * +   d * #(B!/#1'"   DEUDVW $'   d5EF  E   !ST '  1!     )4X-'1* 5 / $ ( 3%A%aD`%aD " 4*Kl       ( / sC#S%R(&E+SR+5SR.AS R1 A.S9R4:A SR7A7S;R:<'S#R<$AS)R>*$SSS+S.S1S4S7S:S<S>SSrrequestc Kddlm}m}m}m}m}m}  |jJtj|jr|jdkrtddd|jit|j||jd{} t|| } | |_ t|| ||||| d{| } | rt!j"| r| |d{} n t%d | j'd d }| j'dd}|stt(j*|t-|dt/|| d{}|j'dd}|| jk7r t1|t3|j'dd|| j4d{t7||j'dd|j'd| ji|d| i}| t9d|j;| |d{}t=t?| ||d{tA|t?| || d{|jByddlm"}dt?| }|jFjI||jBd |jJ1 |jJjM||jBd d{tSjTtWjX|| |||"| t%d#d$| i|d%S77l7F777777]#t8$r!}tOjPd!||Yd}~d}~wwxYw#t8$r}tOjZd&|t]|trPt_ta|d'd(|d)tbjdta|d*d+ta|d,t(jf-t]|t^r|t_d.ti|ztbjdta|d*d+t(jf-d}~wwxYww)/a Update an existing API key's parameters. Parameters: - key: Optional[str] - The key to update. Either key or key_alias must be provided. - key_alias: Optional[str] - User-friendly key alias. If key is omitted, also identifies the key to update (must match exactly one key, same as /key/delete's key_aliases) - user_id: Optional[str] - User ID associated with key - team_id: Optional[str] - Team ID associated with key - agent_id: Optional[str] - The agent id associated with the key. - organization_id: Optional[str] - The organization id of the key. - budget_id: Optional[str] - The budget id associated with the key. Created by calling `/budget/new`. - models: Optional[list] - Model_name's a user is allowed to call - tags: Optional[List[str]] - Tags for organizing keys (Enterprise only) - prompts: Optional[List[str]] - List of prompts that the key is allowed to use. - enforced_params: Optional[List[str]] - List of enforced params for the key (Enterprise only). [Docs](https://docs.litellm.ai/docs/proxy/enterprise#enforce-required-params-for-llm-requests) - spend: Optional[float] - Amount spent by key - max_budget: Optional[float] - Max budget for key - model_max_budget: Optional[Dict[str, BudgetConfig]] - Model-specific budgets {"gpt-4": {"budget_limit": 0.0005, "time_period": "30d"}} - budget_fallbacks: Optional[Dict[str, List[str]]] - Per-model fallback chain tried in order when that model's own `model_max_budget` is exceeded, e.g. {"gpt-4o": ["gpt-4o-mini"]}. - budget_duration: Optional[str] - Budget reset period ("30d", "1h", etc.) - soft_budget: Optional[float] - [TODO] Soft budget limit (warning vs. hard stop). Will trigger a slack alert when this soft budget is reached. - max_parallel_requests: Optional[int] - Rate limit for parallel requests - metadata: Optional[dict] - Metadata for key. Example {"team": "core-infra", "app": "app2"} - tpm_limit: Optional[int] - Tokens per minute limit - rpm_limit: Optional[int] - Requests per minute limit - model_rpm_limit: Optional[dict] - Model-specific RPM limits {"gpt-4": 100, "claude-v1": 200} - mcp_rpm_limit: Optional[dict] - Per-MCP-server RPM limits, keyed by MCP server name {"github": 100, "slack": 200} - tag_rpm_limit: Optional[dict] - Per-request-tag RPM limits, keyed by request tag {"cell-1": 1000, "cell-2": 500}. Each tag gets an independent counter; absent tags fall back to the key-level rpm limit. - model_tpm_limit: Optional[dict] - Model-specific TPM limits {"gpt-4": 100000, "claude-v1": 200000} - default_estimated_output_tokens: Optional[int] - Proxy admin only. Expected output tokens reserved for TPM limiting when a request omits max_tokens. Positive integer. - default_estimated_output_tokens_per_model: Optional[dict] - Proxy admin only. Per-model override of the above {"gpt-4": 4096, "gpt-3.5-turbo": 1024} - tpm_limit_type: Optional[str] - TPM rate limit type - "best_effort_throughput", "guaranteed_throughput", or "dynamic" - rpm_limit_type: Optional[str] - RPM rate limit type - "best_effort_throughput", "guaranteed_throughput", or "dynamic" - allowed_cache_controls: Optional[list] - List of allowed cache control values - duration: Optional[str] - Key validity duration ("30d", "1h", etc.), null to never expire, or "-1" to never expire (deprecated, use null) - permissions: Optional[dict] - Key-specific permissions - send_invite_email: Optional[bool] - Send invite email to user_id - guardrails: Optional[List[str]] - List of active guardrails for the key - policies: Optional[List[str]] - List of policy names to apply to the key. Policies define guardrails, conditions, and inheritance rules. - disable_global_guardrails: Optional[bool] - Whether to disable global guardrails for the key. - throttle_on_budget_exceeded: Optional[bool] - When the key exceeds its max_budget, throttle its tpm/rpm to the global budget_exceeded_throttle_percentage instead of blocking the key entirely. - enable_prompt_caching: Optional[bool] - Auto-inject prompt caching breakpoints (Anthropic cache_control markers) on requests made with this key. Anthropic and Bedrock Claude models only. - prompts: Optional[List[str]] - List of prompts that the key is allowed to use. - blocked: Optional[bool] - Whether the key is blocked - aliases: Optional[dict] - Model aliases for the key - [Docs](https://litellm.vercel.app/docs/proxy/virtual_keys#model-aliases) - config: Optional[dict] - [DEPRECATED PARAM] Key-specific config. - temp_budget_increase: Optional[float] - Temporary budget increase for the key (Enterprise only). - temp_budget_expiry: Optional[str] - Expiry time for the temporary budget increase (Enterprise only). - allowed_routes: Optional[list] - List of allowed routes for the key. Store the actual route or store a wildcard pattern for a set of routes. Example - ["/chat/completions", "/embeddings", "/keys/*"] - allowed_passthrough_routes: Optional[list] - List of allowed pass through routes for the key. Store the actual route or store a wildcard pattern for a set of routes. Example - ["/my-custom-endpoint"]. Use this instead of allowed_routes, if you just want to specify which pass through routes the key can access, without specifying the routes. If allowed_routes is specified, allowed_passthrough_routes is ignored. - prompts: Optional[List[str]] - List of allowed prompts for the key. If specified, the key will only be able to use these specific prompts. - object_permission: Optional[LiteLLM_ObjectPermissionBase] - key-specific object permission. Example - {"vector_stores": ["vector_store_1", "vector_store_2"], "agents": ["agent_1", "agent_2"], "agent_access_groups": ["dev_group"]}. IF null or {} then no object permission. - auto_rotate: Optional[bool] - Whether this key should be automatically rotated - rotation_interval: Optional[str] - How often to rotate this key (e.g., '30d', '90d'). Required if auto_rotate=True - allowed_vector_store_indexes: Optional[List[dict]] - List of allowed vector store indexes for the key. Example - [{"index_name": "my-index", "index_permissions": ["write", "read"]}]. If specified, the key will only be able to use these specific vector store indexes. Create index, using `/v1/indexes` endpoint. - router_settings: Optional[UpdateRouterConfig] - key-specific router settings. Example - {"model_group_retry_policy": {"gpt-4": {"RateLimitErrorRetries": 5}}}. IF null or {} then no router settings. - access_group_ids: Optional[List[str]] - List of access group IDs to associate with the key. Access groups define which models a key can access. Example - ["access_group_1", "access_group_2"]. - budget_limits: Optional[list] - List of concurrent budget windows for the key. Each window specifies a budget_limit, time_period, and optional budget_duration. Example - [{"budget_limit": 10.0, "time_period": "1d"}, {"budget_limit": 50.0, "time_period": "7d"}]. Example: ```bash curl --location 'http://0.0.0.0:4000/key/update' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{ "key": "sk-1234", "key_alias": "my-key", "user_id": "user-1234", "team_id": "team-1234", "max_budget": 100, "metadata": {"any_key": "any-val"}, }' ``` r)rrrr~rrNrrr+r)rrrrj)rr4rrrrrrr-Trr.Frrr)rrexisting_key_tokenrr)rrNot connected to DB!rrr)spend_counter_cache spend:key:<rtrttlzFailed to update spend counter %s in Redis after key spend update: %s. Budget checks may use stale value until counter expires.rrrtrzBlitellm.proxy.proxy_server.update_key_fn(): Exception occured - %srzAuthentication Error()rNonerrAuthentication Error, )5rrrrr~rrrRrPrQrrzrtrr|rr;r<rrrrrxrerrrrr!rr+rYrKrrin_memory_cache set_cache redis_cacheasync_set_cacherrrrr>rr?rrr8r auth_errorrwr)rrrryrrrr~rrr4rtcustom_key_update_hookrAr-rrF new_key_aliasrrr counter_key redis_errr#s r update_key_fnr sdjC ?? & doo0NRVRaRadeRe#^_c_n_n^o!pq  )G(('nn) #  .4JZ['-/!%'1   `v ! -**+AB& *G,s1v5 ++!Wf-,,    sQA;M+L&-M+=L)>(M+&L,'A.M+L/AM+2L23A'M+L5M+9L8:M+L:AM+3+L>L<L>#AM+%Q&M+)M+,M+/M+2M+5M+8M+:M+<L>> M(M#M+#M((M++ Q4C P>>QQz/key/bulk_updatec Kddlm}m}m}m}m}|j tjjk7rtdddi|tddd i|jstd dd id}t|j|kDr)td dd |d t|jdig} g} |jD]} t| j| j| j | j"| j$} t'| |||||||d{} | j)t+| j| tKt|j| | S7M#t,$rX}t/j0d| j|t3|trD|j4}t3|t6r|j9dt;|}n4t;|}n(t3|t<r |j>}n t;|}d} |jA| jddd{7}|MtC|dr|jE}ntC|dr|j7}|r|jGddn#t,$rYnwxYw| j)tI| j||Yd}~ d}~wwxYww)a Bulk update multiple keys at once. This endpoint allows updating multiple keys in a single request. Each key update is processed independently - if some updates fail, others will still succeed. Parameters: - keys: List[BulkUpdateKeyRequestItem] - List of key update requests, each containing: - key: str - The key identifier (token) to update - budget_id: Optional[str] - Budget ID associated with the key - max_budget: Optional[float] - Max budget for key - team_id: Optional[str] - Team ID associated with key - tags: Optional[List[str]] - Tags for organizing keys Returns: - total_requested: int - Total number of keys requested for update - successful_updates: List[SuccessfulKeyUpdate] - List of successfully updated keys with their updated info - failed_updates: List[FailedKeyUpdate] - List of failed updates with key_info and failed_reason Example request: ```bash curl --location 'http://0.0.0.0:4000/key/bulk_update' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{ "keys": [ { "key": "sk-1234", "max_budget": 100.0, "team_id": "team-123", "tags": ["production", "api"] }, { "key": "sk-5678", "budget_id": "budget-456", "tags": ["staging"] } ] }' ``` rrrr~rrrrz.Only proxy admins can perform bulk key updatesrNrrorzNo keys provided for updateMaximum $ keys can be updated at once. Found z keys.)rtrrRrr)r}rryrrr~rrrtkey_infozFailed to update key %s: %srtrarr query_typerrrrtr failed_reasontotal_requestedsuccessful_updatesfailed_updates)&rrrr~rrrrrrrrrrrtrrRrrrr\ror!rr?rrrrrrrget_datarrr-rnrl)rrryrrr~rrMAX_BATCH_SIZErrkey_update_itemr}rr# error_detail error_messagerr4s rbulk_update_keysr sp""&6&B&B&H&HHMN  56  99:;   N 499~&x'77[\_`d`i`i\j[kkqrs  <>35N99@? !1#'')33*55'//$)) " &@#5"3#5+#5"3%'= &    % %#'++- )@D !DII-% s $%  * *+H/J]J]_` a!]+ xx lD1$0$4$4Wc!f$EM$' $5MA~. ! #A H )6)?)?)--$,*@*$$ $//>#3#>#>#@ !16:#3#8#8#: Wd3    ! !'++%"/  ?% suCK AE2"E0#*E2 #K0E22 KAJK JKJ*K KKKr?ct|trD|j}t|tr|j dt |}n4t |}n(t|t r |j}n t |}d}|Mt|dr|j}nt|dr|j}|r|jddt|||S)zKNormalize an exception from the per-key update loop into a FailedKeyUpdate.rNrrrr) rrrrrrrrrrr-rn)rr?r4rrrs r_build_failed_team_key_updater, s )]+!(( fd #"JJwI?MKM I~ .!)) I )-H# #\ 2'224H %v .',,.H  LL$ ' ux} UUrz/team/key/bulk_updatec Kddlm}m}m}m}m}|t dddi|jst ddd id}|jAt|j|kDr)t ddd |d t|jd i|jrtjtj} tt!|j#|jd ddiddigid ddidd| iigigdddi|dzd{} t| |kDr#t ddd|jd|d|dit%d| D cgc]} | j&c} } n|jt|jdk(rt dddig} g} t)}|jD]E}t+|}||vr|j-|| j/|| j/|Gtt!|j#|jd| idd{} |j0t2j4j6k7rO| r| dnt9d |jg!}t;j<|t>j@|||"d{tC|jD|#| st d$dd%|ji| D cic]} | j&| }} |jDjGd&'}g}g}| D]}t+|} ||vrt d$dd(|jitHjK||jd)|}tM||||||||||* d{}|j/tO||+t[t| ||/S7cc} w77(cc} w7L#tP$r\}tSjTd,|dd-|j||j/tW|||jY|.Yd}~d}~wwxYww)0at Apply one update payload to many keys inside a single team. Pass `team_id` plus either `key_ids` or `all_keys_in_team=True`. The `update_fields` payload is broadcast to every selected key. Per-key failures are returned in `failed_updates` rather than aborting the batch. Callable by proxy admins, or by team admins with `KEY_UPDATE` permission. rrNrrrorrzteam_id is requiredrrz key_ids.ORblockedFrVgt)rANDrascrt)rorderrszTeam z has more than z- keys. Use `key_ids` to update in batches of .z list[str]z7key_ids must be provided when all_keys_in_team is Falsein)rrr`__team_scope_auth_check__)rrrurrr zNo keys found for team TrzKey not found in team )rtr) r}rryrrr~rrr4rz)Failed to update key %s... in team %s: %s )rr?r4r).rrrr~rrrrkey_idsrall_keys_in_teamrrr rrrgrrrr9rYaddr\rrrrr)rSrr=rr@ update_fieldsrrrrror!rr?rrrl)rrryrrr~rrrr existing_keysrowrequested_tokenshashed_key_ids seen_hashesrPh auth_anchorexisting_by_tokenupdate_field_dictrrrdb_tokenr}rr#s rbulk_update_team_keysrI s056  <<23   N ||C $5$F8N#33WX[\`\h\hXiWjjst   \\(,,/+,G ,VWaa<<Y.D0ABCY- D#;/GHIE"!#b    }  .uT\\N/.AQQ~@NOOPQ   }=#))=  << 3t||#4#9!Z[   " U  %A%a(AK OOA   # #A &  ! !! $  %,,G ,VWaa"lldN5KLb  ""&6&B&B&H&HH ! *1  )XX/%00'(1    0T5G5G[lm 6t||nEF  ;HH3 3HH#11<<4<P;=35N!((/& 00# ##'=dll^%LM "2!@!@ #||(" &@#5"3#5+#5"3%'=!28!< &    % %&9eN^&_ `;(T !,--% o  &>&  $ I.   * *+VX`adbdXegkgsgsuv w  ! !-%6%:%:8%D   sDQ O ?Q O CQ0O 1A5Q&O'=Q$O82Q+AO O O*QQQQO P=!AP82Q8P==Qrtrbrc NKt|jdkDrE|jD]6}|tjjk(r!t |||d{8|j |j rN|j |j kDr5tdd|jd|j d|j d |jrZ|jrN|j|jkDr5tdd|jd |jd |jd ttt||j }|j*|s(tdd |jd|jd |jt j"jk(sKt%||s>t'j(|tt|t*j,jrytdd |jd|jd 7ɭw)a< Validate that a key can be moved to a new team. - The team must have access to the key's models - The key's user_id must be a member of the team - The key's tpm/rpm limit must be less than the team's tpm/rpm limit - The person initiating the change must be either Proxy Admin or Team Admin r)r team_objectrNrzKey=z has a tpm_limit=z, which is greater than the team's tpm_limit=rrz has a rpm_limit=z, which is greater than the team's rpm_limit=rrz is not a member of the team=z&. Check team members via `/team/info`.rrrz- is not a Proxy Admin or Team Admin for team=z\. Please ask your Proxy Admin to allow this action under 'Member Permissions' for this team.)rruSpecialModelNamesall_team_modelsrr,rfrrrgrrrrrrrrrBrSrr=r)rtrbrrr member_objects rrr s1 3::ZZ E)99???' %    }} >>cmmdnn<cii[(9#--HtuyvDvDuEEFG  >>cmm 0Ncii[(9#--HtuyvDvDuEEFG  -=WY]8^hkhshstM {{s{{m+HV|}  %%)9)E)E)K)KK 1  & T T,6=%0066 .6677deieqeqdrsOP  W sAH%H"G H%z /key/deletec K ddlm}m}| td|t |t sd}t jd|jd}g}|jrFt|j|||d{\}}t|j}|j}n^|jrGt|j||||d{\}}t|j}|j}n td|+td t j"d t$j& t jd | |t|k(sJ t jd|j*j,t/j0t3j4|||||d|iS787#t$rt)d dd|d|iwxYw#t$r&} t j6d| t9| d} ~ wwxYww)a Delete a key from the key management system. Parameters:: - keys (List[str]): A list of keys or hashed keys to delete. Example {"keys": ["sk-QWrxEynunsNpV1zT48HIrw", "837e17519f44683334df5291321d97b8bf1098cd490e49e215f6fea935aa28be"]} - key_aliases (List[str]): A list of key aliases to delete. Can be passed instead of `keys`.Example {"key_aliases": ["alias1", "alias2"]} Returns: - deleted_keys (List[str]): A list of deleted keys. Example {"deleted_keys": ["sk-QWrxEynunsNpV1zT48HIrw", "837e17519f44683334df5291321d97b8bf1098cd490e49e215f6fea935aa28be"]} Example: ```bash curl --location 'http://0.0.0.0:4000/key/delete' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{ "keys": ["sk-QWrxEynunsNpV1zT48HIrw"] }' ``` Raises: HTTPException: If an error occurs during key deletion. rrNrzuser_api_key_dict.user_role: %stokensrrry) key_aliasesrrrryzInvalid request typezFFailed to delete keys got None response from delete_verification_tokenrrz/key/delete - deleted_keys=%srrzNot all keys passed in were deleted. This probably means you don't have access to delete all the keys passed in. Keys passed in=z, Deleted keys =rz%/keys/delete - cache after delete: %s)rkeys_being_deletedrryr deleted_keyszBlitellm.proxy.proxy_server.delete_key_fn(): Exception occured - %s)rrrr!rrrrrrdelete_verification_tokensrrdelete_key_aliasesrrrinternal_server_errorrr9rr cache_dictrrr>async_key_deleted_hookr?rZ) rrryrrnum_keys_to_be_deletedrnumber_deleted_keys_keys_being_deletedr#s r delete_key_fnr G sHBI+P  23 3  )*=OQT2U!%  ""#DFWFaFab!" 99=Wyy#5"3#5 >8 4 !4 &)^ "99L   =O ,,+#5"3#5 >8 4 !4&))9)9%: "++L34 4  & `$::::   ""#BDWX )S->> >> "" 35G5W5W5b5b   # : :#6"3#5,    --m88.  `aw`xxHI\H]^  . +&&'kmno'**+shH A5G9F1:AG F4 A7GF6AG0H 1G4G6GG H!!HHH  api_key_hashrcXKttj|||d{S7w)N)r entity_idrcache)r?r(KEYr rrs r_build_model_max_budget_usager s1 .&**)   s !*(*z /v2/key/info)rr"include_in_schemacKddlm}m} | td|t t j ddi|jrt|jng}|jrttt|jdd |jiid d i d{}|Dcgc]}|js|j}}|j||s|jgd S|j|ddd{}|s|jgd Sg} |D]} t!|| j| d{s$ | j#} | j'dd} | j)dxsi} | j)d xsi}| s%t+|t$r|j)dxsi} | r%| r#t-| | |j.d{| d<| j1| |j| d S7_cc}w77#t$r| j%} YwxYw7U#t$r}t3|d}~wwxYww)a  Retrieve information about a list of keys. **New endpoint**. Currently admin only. Parameters: keys: Optional[list] = body parameter representing the key(s) in the request user_api_key_dict: UserAPIKeyAuth = Dependency representing the user's API key Returns: Dict containing the key and its associated information Example Curl: ``` curl -X GET "http://0.0.0.0:4000/key/info" -H "Authorization: Bearer sk-1234" -d {"keys": ["sk-1", "sk-2", "sk-3"]} ``` rmodel_max_budget_limiterrNDatabase not connected. Connect a database to your proxy - https://docs.litellm.ai/docs/simple_proxy#managing-auth---virtual-keysrz%Malformed request. No keys passed in.rrrrTrrtinfortfind_allrrrtrrrrmodel_max_budget_usage)rrrr!rrHTTP_422_UNPROCESSABLE_ENTITYrlistrrrgrrextendr_can_user_query_key_inforrr-rrr dual_cacher\rZ)rrrrtokens_to_query alias_rowsr alias_tokensrfiltered_key_inforPk_dict k_token_hashr budget_tabler#s rinfo_key_fn_v2r) sf6 9+  T  <"@@!#JK  59IIdii2   &34OP]4^&_&i&i"T4+;+;$<=/6'j'!J9C"Pcii399"PL"P  " "< 099b1 1 - 6 6_Y^ku 6 vv99b1 1#% -A1"3GG  ""::gt4L%zz*<=C !::&<=CL# <(F#/#3#34F#G#M2 L9V!-%5'?'J'J:4/0  $ $V ,1 -2yy*;< H,(H:H#H,+I,H,HH,I"H,;H <H,H BH,H*(H,=I>H,H, H, H'$H,&H''H,, I5 IIIz /key/infozKey in the request parameters)defaultr$cKddlm}m} | td|xs |j}|}| t |}t t|jd|iddi d{}|+td tjd tj t||| d{dur(ttj d|j" |j%}|j)d}|j+dxsi}|j+dxsi}|s%t-|t&r|j+dxsi}|r%|r#t/|||j0d{|d<t3||d{}||dS7%7#t$r|j'}YwxYw7D7/#t$r} t5| d} ~ wwxYww)a Retrieve information about a key. Parameters: - key: str | None (query parameter) - The key to look up. Accepts the plaintext key or its hash. Defaults to the key in the Authorization header. Returns: - key: str - The key that was looked up, echoed back as it was passed in - info: dict - The key's row, minus the hashed token - key_alias: str | None - User-friendly key alias - spend: float - Amount spent by the key. When budget_duration is set this covers only the current budget window, not the key's lifetime - max_budget: float | None - Max budget for the key, enforced against spend - budget_duration: str | None - Budget reset period ("30d", "1h", etc.) - budget_reset_at: datetime | None - When the current budget window ends and spend is next reset to 0, not when it was last reset. Reset times snap to standard boundaries in the configured timezone (30d and 1mo land on the 1st of the month, 7d on Monday, 1h on the hour), so subtracting budget_duration from it does not give the window's start - model_max_budget: dict - Per-model budgets, e.g. {"gpt-4": {"budget_limit": 0.0005, "time_period": "30d"}} - model_max_budget_usage: dict | None - Current-window spend per model, present only when the key has per-model budgets - models: list - Model_name's the key is allowed to call - tpm_limit / rpm_limit: int | None - Tokens and requests per minute limits - metadata: dict - Metadata for the key, e.g. {"team": "core-infra"} - blocked: bool | None - Whether the key is blocked - expires: datetime | None - When the key stops authenticating requests - last_active: datetime | None - When the key was last used - object_permission: dict | None - Resolved vector store / MCP permissions when the key has an object_permission_id Example Curl: ``` curl -X GET "http://0.0.0.0:4000/key/info?key=sk-test-example-key-123" -H "Authorization: Bearer sk-1234" ``` Example Curl - if no key is passed, it will use the Key Passed in Authorization Header ``` curl -X GET "http://0.0.0.0:4000/key/info" -H "Authorization: Bearer sk-test-example-key-123" ``` rrNrrprrTrzKey not found in databasertrr9You are not allowed to access this key's info. Your role=rrrrr)rrrr!api_keyrYrrgrarrrurrvr rrrrrr-rrrr!rNrZ) rtrrrrrkey_token_hashrr(r#s r info_key_fnr/sb ;+  T  .&..!$ ?.S9J&'B='QR^^J'+T2_     3$44..  +"3!     "55RSdSnSnRop   '**,H!) W 5#<<(:;Ar&ll+ABHb J|T$B+//0BCIr  7T+!1#;#F#F82H- .:(MRRH--]   '}}H '2S +'**+s GAF2%F &AF2(F ).F2F(BF2)F.*F2F0F2 G F2 F2F+(F2*F++F20F22 G ; GG  Gruc||y|D]O}|j|s|rttjddtj j iy)z if is_model_access_group is True + is_wildcard_route is True, check if user is a premium user Return True if user is a premium user, False otherwise T)model_access_grouprz`Setting a model access group on a wildcard model is only available for LiteLLM Enterprise users.r))_is_model_access_group_for_wildcard_routerrrrrr)rurrrs rr"r"s ~+  ? ?SX ? Y# & 9 9$DEVEgEgEmEmDn"o r insert_datar)rrtrkaliasesconfigrrrrrdrrjragent_idrrrerfrgr)r4rupdate_key_valuesallowed_cache_controlsrHbudget_fallbacksrr mcp_rpm_limit tag_rpm_limit guardrailspoliciespromptsteamsr)rtrsend_invite_emailrrr( sso_user_idrhrZrc84Kddlm}8m}9|9 td| !||} ndt j t } |d}:n;t|};tjtjt|;z}:|d}|7rng}?|7D]R}@t|@ts t@ni@}At|Adj!|Ad<|?j#|ATt%j&|?}>t%j&|}Bt%j&|}Ct%j&|}D|5 t)|5n t)i}E| |xsi}| |d <|! |xsi}|!|d <|" |xsi}|"|d <|# |xsi}|#|d <|$ |xsi}|$|d <|% |xsi}|%|d<|& |xsi}|&|d<t+|}t%j&|}Ft-|t%j&|}Gt%j&|xsi}H|}|}|}|} id| d|d|d|d|d|(d|d|d|dFd|d|d|d| d|=d|d|0d |1i}I|'|'Id!<|rGId"<id#| d$|d%|:d|d&Bd'Cd|d|d|d|d(|d)|)d|dFd|d|d|id|<d|d*Dd"Gd+Hd|(d,|d-| d.|>d/|,d0|-d1|.xsgd2|/d |1d3Ed4|6xsg}Jt/|J|3xsd5|46t1d7d5d8urnt3| 9Jd:<t5j6J}Kt|Kd&t8rt%j:Kd&|Kd&<tKd't8rt%j:Kd'|Kd'<tKdt8rt%j:Kd|Kd<tKd*t8r1d;Kd*vr|8d8ur t=d<t%j:Kd*|Kd*<tKd"t8rt%j:Kd"|Kd"<t?tdzKjAd3}5|5)t|5t8r tCjD|5Kd3<KjAd%d)tKd%trKd%j!|Kd%<|9|*|*d=k(r|d>k(rkt?d?|9jIId=@d{}L|L tdAtKLjLdkDrBtKJddk(r1LjLJd<n!|dBk(r|9jOId=|Cd{}L|*|*d=k(rIStQjRdDiJd#tU| Ei|9jI|JdF@d{}MtW|Md#dJdG<tW|Md#d}Nt|Nt8rtY|9Nd|6Hd{tWMdIdJdI<tW|MdJd|JdJ<tW|MdKd|JdK<|JjAd3}O|O)tOt8r tCjDOJd3<|Jd,<|d=k(rJjgIJS#tBjF$r iKd3<YwxYw77>77#tBjF$riJd3<Y`wxYw#t$rq}PtQjZdLPtQjRt]j^t|Pt`rPtatbjddMdNiOd}P~PwwxYww)PNr)rrz]Connect Proxy to database to generate keys - https://docs.litellm.ai/docs/proxy/virtual_keys rrrXrjrYrrr;r<r=r>r?rRrrrrrrrrurrerfrgrWr9rBrhr@rrrrVr5r6r7r rHr:rrrKrrr*r(rZrF)rrrDISABLE_KEY_NAMETr-key_nameget_spend_routeszJget_spend_routes permission is only available for LiteLLM Enterprise usersrr4z&prisma_models.LiteLLM_UserTable | None)rrzFailed to create userr)rrr8zprisma_client: Creating Key= %srprtrrrprevious_access_group_idsupdated_access_group_idsr created_at updated_atzKlitellm.proxy.proxy_server.generate_key_helper_fn(): Exception occured - %srzInternal Server Error.r)4rrrr!secrets token_urlsaferr rrr rrr<rrrKr\rr]r!r7r_rrjr0rIdeepcopyrloadsrrryaml safe_load YAMLErrorr4rrurrrr*r8rIr traceback format_excrrr9r)Qrrkrur5r6rrrrrdrRrrjrrtrrrr7rrrerrfrgrr8rr9rHrr:rrr;r<r=r>r?r@rr rrArrr*r(rBrhr rrrZrrKrrrVduration_secondsrarYbudget_limits_jsonrcrdrT aliases_json config_jsonpermissions_jsonrouter_settings_json metadata_jsonmodel_max_budget_jsonbudget_fallbacks_json user_datakey_data saved_tokenrcreate_key_responsecreated_token_hashrouter_settings_valuer#sQ rrrs vGwxx } ?E'//0OPQRE#6h"?,,x||,yAQ/RR" ,=PQ (I&*%'# *F$.vt$<V *V*A1!DUBVWaacAjM  & &q ) *"ZZ(;<**W-LF+K"jj5APA\*_"=blmobp">r&5"#">r&5"# >r$1! >r$1!>r!+>r'>r%$X.H::h/M./#'::.>#?#'::.>.D"#EIII3d  * *  w  *  w       U  f     $%:        x %& #$8?" @ 3A" B  0 6BC" J !#,u/  )5 1T 9 #5e#DHZ !]]84 k),c 2%)ZZ I0F%GK " k(+S 1$(JJ{8/D$EK ! k*-s 3&*jjZ1H&IK # k-0# 6![%??LX\D\ !mnn)-K 4N)OK & k"45s ;.2jjEW9X.YK* +td{KOO%>&#)*;&?& H %**>!  ! & &1>8>Wju&=> 0=/H/Hhch/H/i)i #*+>#NHZ (/0CWd(S ,c26"/0.2-=  077JLbdh/iH+ ,%,-@,PT%UH\ "%,-@,PT%UH\ ",4<<8I+J !$0Z@UWZ5[526..AV2WH./&H[v " O[>> 413 -. 4[  *j ~~524H./5  ""#prst""9#7#7#9: a 'G==56   sH \#H+ZY'A&Z Y3 A*Z8Y69 Z\|}|j;|?| D]:}|j(tA||j(|jBdd{<| |d|fScc}w7S777]cc} wcc}w7cc}wcc} w#t.$rD} t1j2d| t1j4t7j8| d} ~ wwxYw7w)a Helper that deletes the list of tokens from the database - check if user is proxy admin - check if user is team admin and key is a team key Args: tokens: List of tokens to delete user_id: Optional user_id to filter by Returns: Tuple[Optional[Dict], List[LiteLLM_VerificationToken]]: Optional[Dict]: - Number of deleted tokens List[LiteLLM_VerificationToken]: - List of keys being deleted, this contains information about the key_alias, token, and user_id being deleted, this is passed down to the KeyManagementEventHooks to delete the keys from the secret manager and handle audit logs rrrpzlist[LiteLLM_VerificationToken]rrr`Nrz No keys foundrrrrrz)You are not authorized to delete this keyrrrry)r'DB not connected. prisma_client is NonezOlitellm.proxy.proxy_server.delete_verification_tokens(): Exception occured - %srH)r failed_tokens)"rrrYrrrgrrrrrvrrrrrkr\r$_persist_deleted_verification_tokens delete_datarrgatherr!rr?rrTrU delete_cacher*rrIr)rrrryrrprt hashed_tokensr authorized_keysdeleted_tokensrdeletion_tasksr#rx deleted_keys rrrKsL09M< [a.bTW/D3/O.bM.b"FJN1#$? $NOYY"T=$9:ZK &'1,# & 9 9#_5 !**.>.J.J.P.PP"5"$. C:!$+=*;&3  (..s3+(.(A(A$+-X#Y 7$+"3#5   !**.>.J.J.P.PP'4'@'@'@'O!O!-#n2EV2T8>$^u%~B]U$^M$^bq(r[^)B)B399+)B)V(r(rnnn5557F!G#))!G!G~&#f+58>$^u%~B]U$^M$^EF F6'',!$sC.1 '' 5 6'    (2+%++*5*F*F)-   '&  Y/c  "P$^(r5!G$^ && ]_`  ""9#7#7#9:   s L"KJ)5KJ. A6KJ1AKJ4AKJ7!K< J:J: K$J?5K K KK(K K K K!AL"5&L"L  L")K1K4K7K: K K L?LLL"c |sgStjtj}g}|D]}|j }t j i|||j|j|d}|j }|jdd} | | |d<dD](} | |vs|| tj|| || <*dD]} |j| d|j||S)zOTransform verification tokens into deleted token records ready for persistence.) deleted_at deleted_bydeleted_by_api_keyryrNr)r5r6rHr model_spendrr:rZ)rlitellm_organization_tabler idrK) rrr rr LiteLLM_DeletedVerificationTokenrrr-r-rr]r\) rrryr{recordsrt key_payloaddeleted_recordrecord org_id_value json_fieldrel_keys r1_transform_verification_tokens_to_deleted_recordsrs"   X\\2JG(nn& 9HH  (/77&7&?&?&8    **, &zz(D9  #(4F$ %  DJV#z(:(F%)ZZz0B%Cz" D  &G JJw % & vQ(T Nrrtxz Prisma | NonecK|sy|%|jj|d{yt|j|d{y7)7w)zSave deleted verification token records to the database. ``tx`` runs the write on that transaction's connection instead of a fresh one, so a caller batching this with other writes gets one all-or-nothing commit. Nr) litellm_deletedverificationtoken create_manyrrrrs r(_save_deleted_verification_token_recordsrsY  ~11==7=KKK +M : F FG F TTT LTs!%AA#A A AAcXKt|||}t|||d{y7w)zKPersist deleted verification token records by transforming and saving them.)rrryrN)rr)rrrryrrs rrqrqs9G +-G 3#  s *(*rcKtt|jdd|iid{}|Dcgc]}|j}}t ||||d{S74cc}w7 w)Nrrr`r)rrgrrr)rrrrryr rtrs rrrs(55PQ^5_'`'j'jT;/0(k("+>>3SYY>F>+-+-   "? s,,A,A#A,A% A,A*A,%A,current_master_keynew_master_keyc Kddl}ddlm} tdt t |j d{}|r{|j|}tjdt|g}|D]w} ttd&i| |||dd{} | s'| jd } |j| d | d <|j| d | d <|j!| ytjd |j"j%4d{} | } | j&j)d{tjdt|| j&j+|d{dddd{t-t/dd{ t1|j d{}|r i}|D]}|j2dk(s|j4} |r^|j7|}|j9||}|r7t1|j;ddid|j|id{ t=||j>xst@|d{ tG||d{ tI||d{ tK||d{ tM|j d{}|rddl'm(}|D]} |jS|}||||}|jd }d |vr|j|d |d <d!|vr|j|d!|d!<tM|j;d"|jTii|d#|j>id{tjd%t|yy7#t$rd}YwxYw7H777\7O#1d{7swY`xYw7K7,#t$rd}Y8wxYw77#t$r*}tjBdtE|Yd}~d}~wwxYw7#t$r*}tjBdtE|Yd}~d}~wwxYw7#t$r*}tjBdtE|Yd}~d}~wwxYw7#t$r*}tjBdtE|Yd}~(d}~wwxYw7#t$rd}YwxYw7v#t$r,}tjVd$|jT|Yd}~Ld}~wwxYww)'aR Rotate the master key 1. Get the values from the DB - Get models from DB - Get config from DB 2. Decrypt the values - ModelTable - [{"model_name": "str", "litellm_params": {}}] - ConfigTable 3. Encrypt the values with the new master key 4. Update the values in the DB rN) proxy_configz list[object]) new_modelsz2ABLE TO DECRYPT MODELS - len(decrypted_models): %sF) model_paramsrrnew_encryption_keyshould_create_model_in_dbTrlitellm_params model_infozResetting proxy model tablezCreating %s modelsrr)r object_typeenvironment_variables)r)rr param_name param_valuerr)r touched_byrz+Failed to rotate MCP server credentials: %s)rrz)Failed to rotate MCP user credentials: %sz&Failed to rotate MCP user env vars: %sz,Failed to rotate SSO identity assertions: %s)update_db_credential) db_credential updated_patchrcredential_valuescredential_infocredential_namerz&Failed to re-encrypt credential %s: %sz>,d.B.BC$$&7&?&?? 0 ""#acfgrcst7K\   :       s@ ( \$$%RTWXYTZ[[\   Z$$%PRUVWRXYYZ   W$$%MsSTvVVW   ]$$%SUXYZU[\\] J  $ $**+SUYUiUiklm sY U+OO OAUO!U!BU'O$(U+ O0 O' AO0O*O0 UO-U;P<UP P P "U U P PUPU!P$$ Q-Q UQUQ R&R U RUR S S>US  U S TS=7U=TUT TUTUT U&!U U UUcddlm}|jtjj k7r#t dd|jj iy)Nrr&rrr)r8rrrrrrnot_allowed_access)rrs r_require_proxy_adminrsK6""&6&B&B&H&HH.AAGGH  Irz/credentials/migrate-encryptionzcredential managementz5If true, scan and report without writing any changes.dry_runcKddlm}ddlm}ddlm}t ||#tdd|jji|||| d{}d ||jd S7w) uC Re-encrypt all at-rest credentials into the AES-256-GCM (``v2:gcm:``) format. Admin only. Requires ``general_settings.encryption_algorithm: aes-256-gcm``. Idempotent and resumable — re-running skips already-migrated values. Pass ``dry_run=true`` for a non-mutating scan (equivalent to ``--check``). rr&)migrate_encryptionrNrrr)rrrsuccess)rrreport) r8r7litellm.proxy.management_endpoints.credential_migrationrrrrrr:ras_dict)rrrrrrs rmigrate_encryption_endpointrs~&79*+.EEKKL  -#+F  Gv~~?O PP sAA.A,A.z%/credentials/migrate-encryption/checkcKddlm}ddlm}ddlm}t ||#tdd|jji||d{}d |jd S7w) z Read-only residual scan for compliance attestation. Reports how many at-rest values are still in the legacy format. ``residual_legacy == 0`` attests no legacy ciphertext remains. Admin only; performs no writes. rr&)check_encryptionrNrrrr)rr) r8rrrrrrrr:rr)rrrrrs rcheck_encryption_endpointrsp79*+.EEKKL  +GGF6>>+; <<HsAA+A)A+cK|r|jt|jd{|jjdsttj ddit |jtkr%ttj ddtdi|j}|Sdtjt}|S7w)NrrzNew key must start with 'sk-'. This is to distinguish a key hash (used by litellm for logging / internal logic) from the actual key.rzNew key must be at least r) rTrrrrrwrrrMrNr)r new_tokens r get_new_tokenrs  (' 555||&&u-"77d  t|| 8 8"77#<=V B+C>ACCC*C>+C  C> C  C>C C;C61C>6C;;C> key_in_dbhashed_api_keyc tKddlm} t|||||jut |dd} |j duxr'|j t jjk(} |j| k7r"| s t||j|d{|Ot |dd} t|t| tr| nd|d t|t| tr| nd|d t| d{} | | }t| }||d }i}|dt!|d t#||d{}|j%d}||j&k7r t)|t+j,d||j/||j1| }t3||||r |j4ndd{t7t9|j/d|it;|d{}| t|ni}| |d<|j=d|d<|s|rt?tA|||d{tC|||||d{tDjG|}tIjJtMjN||||||S777t777m7Ww)zEGenerate new token, update DB, invalidate cache, and return response.r)r*rNrrrrtr}rrE)rrFFrrjrrznon_default_values: %s)rrrrUrrrr)rprevious_key_token new_key_tokenrr4r)(rr*r=rr8rrrrrr2rrr1rr0rxrerrrrrrrrrUrrgrLr-r+rYrJrrrrr>async_key_rotated_hook)rrrrtrrryrr~r*rr_existing_key_metadatarrnew_token_key_namerrFrjsonified_update_data updated_tokenupdated_token_dictrs r!_execute_virtual_key_regenerationrls6. "+ D00<"))5F"M  ' 't 3 R!++/?/K/K/Q/QQ    #3 3O5"3 $ 4 4+    (/ :t(L58BCY[_8`4fj/  98BCY[_8`4fj/  +55I&y1N 29 E*8JKK &t5A#:W`#aa155kB I// / & ?""#;=OP)*9F9U9U[f9U9g !#%%*.T&&D  DQ#M2D f' %&; < >M KXJc4 3Fik )u%7%;%;G%Dz"&.s31/    8#)$ "  *889KLH 66&/1   Og *6b> sBJ8J'A$J8:J*;>J89J-:B J8J07J8;J2= 0r3z reset_to (z) must be <= current spend (rrRz) must be <= budget () rintrrrrrwrrRrr8)rr current_spendrRbudget_max_budgets r_validate_reset_spend_valuers3 he -3378  XH!|3345  %??1cM-33z(3OP]^_`a  %%J%%1#*9+I+I.is(w]gz*d;AVAVAXXws,.)rrrrPtuple)rKrbs r_budget_limit_windowsr [s7 6@PS6TM2ZgK wkvw wwrrdc|jd}t|tr|s|Stjt j tt|z}i|d|jiS)aRestart one budget window from now, by advancing its `reset_at`. `window_start` is derived elsewhere as `reset_at - budget_duration` (`get_budget_window_start`), so `reset_at` must be set to `now + budget_duration` -- a window floating from THIS moment -- to make `window_start` land at `now` and exclude the historical spend that triggered the block. Reusing `get_budget_reset_time`/ `ResetBudgetJob._reset_expired_window`'s calendar-standardized boundary (e.g. "next midnight") would not do that: for a "1d" window `next midnight - 1d` is simply the START of the calendar day already in progress, which still covers that spend. That reuse is only safe for the scheduled job, which runs right as `reset_at` naturally elapses, so the elapsed boundary it computes is already close to "now". A manual reset can happen at any point mid-window, so it needs the floating form instead. A window with no `budget_duration` is returned unchanged. rjrrY) rrrrrr rrr rK)rdrk new_reset_ats r_advance_one_key_budget_windowr lsl"zz+,H h $H ",,x||4yI\]eIf7ggL   L**, rcKt|}|sytd|D}dtj|ti}t |j jd|i|d{|D]D}|jd}t|ts%|s(d|d |}t|d d{Fy7N7 w) aForce-expire every one of a key's own `budget_limits` windows (extra time-windowed caps layered on top of the lifetime max_budget, e.g. a daily limit) so a manual spend reset also clears them, not just the lifetime counter. Persists the advanced `reset_at` boundaries BEFORE zeroing any window's Redis counter, not after: a window counter reading zero is only durable once every reader recomputing its floor from the DB sees the new boundary too (`get_current_spend` re-derives a window counter from real `LiteLLM_SpendLogs` rows inside `[window_start, now)` on every read below max_budget, see its `is_window` branch). Zeroing first would let a request racing the DB write compute `window_start` from the stale pre-reset boundary, re-sum the unchanged historical spend, and put the counter right back where it was before the write ever landed. Nc32K|]}t|ywr|)r rSs rrDz,_reset_key_budget_windows..s Tq!?!B TsrK)r*rrrjrz:window:r3rr) r r rr]rrgrrrrr) rrrKwindows reset_windows reset_payloadrdrkrs r_reset_key_budget_windowsrs(+=9G  TG TTM,TZZ s-STM %m 4 : : A A'  B   b::/0 h $&~&6hxjIK=+]`a a a b  bs0A)B>+B:,*B>B>B>2B<3B><B>z/key/{key:path}/reset_spendcK ddlm}m}m}m}|t t jddid|vr|}n||}tt|jd|idd i d{} | !t t jdd |d i| jxsd } t|j| } t| |||d{tt|j!d|id| id{} | t t jddid|} t#| | d{t%||| j&d{t)|||d{| j*}| j,}|| | ||dS7%777a7C7/#t $rt.$r&}t1j2d|t5|d}~wwxYww)Nr)r*rr~rrrorrrrTrrrr3)rrrrrrzFailed to update key spendrr)rrrKr)key_hashrprevious_spendrRrWzError resetting key spend: %s)rr*rr~rrrr9rrgrarvrrrrrrrrKr+rRrWr!rr?rZ)rtrrryr*rr~rrrrr updated_key _counter_keyrRrWr#s rreset_key_spend_fnrsFX+    "AA!JK  s? N'_N"/0KM0Z"["g"gN++T2#h#    "554uK!89  *//63 5dmmZP0 /'1    $11L]1[#\#c#cN+8$$d$   "AA!=> !+>*:; 9lZbccc'')$22   ''1/   (22 !,!/9K9d9dZ +5J & &Z C !R$66'..   FS+M:Gk)AH   -$66 ..   0H/0 *  '"55RSdSnSnRop  Y:FZ A   -$66 ..   * s[A:J <I=C(J %I 81J *)III>J J 1J  J I5JJ rc,K| |jsgStdt|jj dd|jiid{}|gS|Dcgc]%}t j |j'c}S7=cc}ww)zEFetch team objects for all teams a user belongs to (single DB query).NzSequence[BaseModel] | Nonerrr`)r@rrerrLiteLLM_TeamTablerr)rrr@rbs r_fetch_user_team_objectsr#|s !);)A)A /3$]+11;;9tUgUmUmNnBo;pp0E } LQ RD  , ,T__-> ? RR q Ss$A BB B *B BB team_objectsc\|Dcgc]}t||s|jc}Scc}w)z8Filter team objects to those where the user is an admin.r)rBrrr$rbs r _get_admin_team_ids_from_objectsr's1 ". 1DWhsw1x   s))c|Dcgc]A}t||s2t||tjjr |j Cc}Scc}w)aFilter team objects to non-admin teams where the caller has /key/list permission via team_member_permissions. These teams should grant the caller full key visibility (same as a team admin), so other members' keys and service account keys (user_id=NULL) are returned.r)rr permission)rBrDr=KEY_LISTrrr&s r3_get_team_ids_with_key_list_permission_from_objectsr+sQ!  "5FQUV '/*3399     sAAc~|Dcgc],}tfd|jDr |j.c}Scc}w)zCFilter team objects to those where the user is a member (any role).c3pK|]-}|jduxr|jjk(/ywr|)r)rBrrs rrDz4_get_member_team_ids_from_objects..s:  NN$ & V6>>=N=V=V+V V s36)anyrrr&s` r!_get_member_team_ids_from_objectsr/sD!    11     s1:cNKt||d{}t||S7w)z,Get all team IDs where the user is an admin.N)r#r'rrrr$s rget_admin_team_idsr2s, !99K] [[L +,=| LL\ %#%cNKt||d{}t||S7w)z Get all team IDs where the user is a member (any role, including admin). Used to determine which teams' service accounts (keys with user_id=NULL) a regular team member can see. N)r#r/r1s rget_member_team_idsr5s,!99K] [[L ,-> MM\r3activeexpiredVALID_EXPIRES_FILTER_VALUESz /key/listrtz Page number)r$ge z Page sized)r$r9lezFilter keys by user ID. Exact match by default; set substring_matching=true (admin only) for case-insensitive substring matching.zFilter keys by team IDzFilter keys by organization IDzFilter keys by key hashzFilter keys by key alias. Exact match by default; set substring_matching=true (admin only) for case-insensitive substring matching.zReturn full key objectz4Include all keys for teams that user is an admin of.z Include keys created by the userz9Column to sort by (e.g. 'user_id', 'created_at', 'spend')desczSort order ('asc' or 'desc')z$Expand related objects (e.g. 'user')z!Filter by status (e.g. 'deleted')zFilter keys by project IDzFilter keys by access group IDzFilter keys by agent IDaIf true (proxy admins only), match user_id/key_alias as case-insensitive substrings instead of exact values. Defaults to false: /key/list matched these exactly before substring search was added, and an exact user_id/key_alias filter must never return another user's keys.zFilter keys by expiration. 'expired' returns keys whose expires is in the past; 'active' returns keys that never expire or expire in the future. Omit to return keys regardless of expiration.pagesizereturn_full_objectinclude_team_keysinclude_created_by_keyssort_by sort_orderexpandraccess_group_idsubstring_matchingrVc vK ddlm}tjd| tjdt d||dk7rt ddd i t|tr|tvrt ddd i t||||||| d{}| s| r#t|| d{}t||}ng}d}| r,t||}t||}|rth||}nd}|j t"j$j&t"j(j&fv}|xr|}|s|s |j*}t-d.id|d|d|d|d|d|d|d| d|d|d|d| d| d| d|d|d|d |d!|d"|d#t|tr|ndd{}tjd$|S7/77!#t $r}tj.d%|t|t rZt1t3|d&d'|d(t4j6t3|d)d*t3|d+t8j:j<,t|t0r|t1d-t|zt4j6t3|d)d*t8j:j<,d}~wwxYww)/a List all keys for a given user / team / organization. Parameters: expand: Optional[List[str]] - Expand related objects (e.g. 'user' to include user information) status: Optional[str] - Filter by status. Currently supports "deleted" to query deleted keys. Returns: { "keys": List[str] or List[UserAPIKeyAuth], "total_count": int, "current_page": int, "total_pages": int, } When expand includes "user", each key object will include a "user" field with the associated user object. Note: When expand=user is specified, full key objects are returned regardless of the return_full_object parameter. rrzEntering list_keys functionNrodeletedrrzr?rrrrr@radmin_team_idsmember_team_idsrBrCrDrErr rFr7use_substring_matchingexpires_filterzSuccessfully prepared responsezError in list_keys: %srerror(rrrrrrr})rrrrrr!rrrr8r r#r/r'r+rrrrrPROXY_ADMIN_VIEW_ONLYr_list_key_helperr?rr8rrfastapirr9)rrr>r?rrrrrr@rArBrCrDrErr rFr7rGrVrrr$rKrJlist_permission_team_idsrrLrr#s r list_keysrSsi|} <""#@A  & &'? @45 5  &I"5!_`  gs #7R(R!YZ  +B/+'+ %   7!9#5+"L@"3)O L"O ="3)N/b"3)/ $(!%&R&R9Q&R!S!N 1 ; ;  ( ( . .  2 2 8 8@ ! );(M~~'//G 0! '! ! !  !  !  ! !  2! ,! *! ,! %<! ! "! ! !! ""#! $,%! &'! ($:)! *'1#&>7D+!  0 ""#CDk% \ 8  &&'?C a ' 8vaS];$::a&1Q w~~/\/\]   > *G,s1v5 66!Wf->>    saJ9BG GG ,G-C9G &G'G J9G G G J6CJ11J66J9 query_params where_partschKg}|jr8j|j|jdtg}|jrKtt |j d|jid{}|t |dgxsg}|rRdjfdtt|D}j||jd|d |r%|jd d j|d y|jd y7w) zAppend SQL scope conditions so non-admin users only see aliases for keys they own or keys belonging to teams they are members of.z user_id = $rr`Nr@, c3FK|]}dt|zdzyw)$rtN)r)rBirTs rrDz/_apply_non_admin_alias_scope..s),mQRq\1BQ1F1J0K-L,ms!z team_id IN (r(z OR FALSE) rr\rrrfrar8joinranger)rrrTrUscope_conditions user_teamsrteam_placeholderss ` r_apply_non_admin_alias_scoperbs-*,  -556+c,.?-@ ABJ  -n].K L X X/778!Y!     7B7=2J#'99,mV[\_`j\kVl,m#mJ',/@.A CDQv{{+;<=Q?@ 7# sBD2 D0 B%D2z /key/aliases)r9r$2)r9r<r$z3Search key aliases (case-insensitive partial match)z-Filter aliases to keys belonging to this teamsearchc K ddlm}tjd| tjdt dt g}gd}|jtjjtjjfv}|st||||d{|r2|jd|d|jdt||r.|j||jd t|d j|} d | } |j j"| g|d{} | rt%| dd nd} |||d z |zgz} t| d z }t| }d| d|d|}|j j"|g| d{}|Dcgc]}|j'ds|d}}| dkDr| |z nd}tjd|||| ||| |||dS7c77]cc}w#t $r}tj(d|t+|t,rPt/t1|dd|dt2j4t1|ddt1|dt6j8t+|t.r|t/dt;|zt2j4t1|ddt6j8d}~wwxYww)a\ Lists key aliases with pagination and optional search. Non-admin users only see aliases for keys they own or keys belonging to their teams. Returns: { "aliases": List[str], "total_count": int, "current_page": int, "total_pages": int, "size": int, } rrzEntering key_aliases functionNro)zkey_alias IS NOT NULLzkey_alias != ''z"(team_id IS NULL OR team_id != $1)%zkey_alias ILIKE $z team_id = $z AND z@SELECT COUNT(*) AS count FROM "LiteLLM_VerificationToken" WHERE countrtz8SELECT key_alias FROM "LiteLLM_VerificationToken" WHERE z ORDER BY key_alias ASC LIMIT $z OFFSET $rzHkey_aliases: page=%s, size=%s, search=%r, total_count=%s, total_pages=%s)r5 total_count current_page total_pagesr?zError in key_aliases: %srrNrrrrrr)rrrrrr!rrrrrrOrbr\rr]r query_rawrrr?rrrr8rrrr9r)rr>r?rdrrrTrUr where_sql count_sql count_rowsrhaliases_params limit_idx offset_idx aliases_sqlr#rr5rjr#s rrrs8[ <""#BC  & &'? @45 5.F,F  !2 ; ;  ( ( . .  2 2 8 8@ ! ./@-Q]_jk k k    !F81 .   !23|3D2EF G     (   S->,?@ A"<< 4 ]^g]hi ?Y}?O?O?Y?YZc?sfr?s9s *G,s1v5 66!Wf-66    szK)BHH BH>H?A*H)H*H2H  H 1HK)HHH H K&C K!!K&&K)ci}|ygd}||vr!tddddj|i|jdvrtdddi|j||<|S) N)rrRrKrLrrrrz%Invalid sort column. Must be one of: rWr)rr=z+Invalid sort order. Must be 'asc' or 'desc')rr]lower)rCrDorder_by valid_columnss r_validate_sort_paramsrw1s&(HMm#DTYY}E]D^_`  0JK  #((*HW OrrMrc@|dk(rddddiidd|iigiSdddidd|iigiS)Nr7rrVnotltrgter})rMrs r_build_expires_where_clauser|QsJ"UDM2Ys 4LMNN It$y5#,&?@ AArexclude_team_idrJrKrLci}|jtg}i}|r t|tr| r |dd|d<n||d<|rt|trd|i|d<|rt|tr||d<|r|j ||rU|rS|>|r"|j dd |id dd |iiddigigin-|j dd |iddigin|j d |i|r|j dd |ii|r5|Dcgc] }||xsgvs |}}|r|j ddd |iiddigit |d kDr d|d |igi}n"t |d k(r|j|d g|rt|tr| rd|ddind|ifnd|rt|trd|ifnd|rt|trd|ifnd| rd| ifnd| rdd| giifnd| rt| trd| ifnd| 6| t vr.t| tjtjfnd}|rd|g|in|}tjd||Scc}w)aBuild filter conditions for key listing. Visibility rules: - Users always see their own keys (user_id match) - Team admins see ALL keys for their admin teams (via admin_team_ids) - Regular team members see only service accounts (user_id=NULL) for their teams (via member_team_ids). This prevents leaking other members' spend data. - created_by visibility is scoped to teams the user currently belongs to, so former members cannot see service accounts they created after leaving. insensitive)containsmoderryrrNrrrrrtrrr}rr rhasSomer7zFilter conditions: %s)r._get_condition_to_filter_out_ui_session_tokensrrr\rr8r|rrr rrr)rrrrrr}rJrKrBr rFr7rLrMr or_conditionsuser_conditiontidmember_only_team_idsglobal_filterscombined_wheres r_build_key_filter_conditionsrWs%6 "E LL?AB57M02N:gs+ !#%)N9 % )0N9 %:os;%*O$<y!:os;,;()^,7  &$$)73 $%.0G$H%.$5'"   $$e|W.E SWGX-Y%Z[  ,!8 9i$)?@A6E&ksUcUigiIjs&k&k   "T+?$@A"D)  =A} 567 ] q  ]1%&<Z 37*9mLM!9-  <%-Hc1JGX  PR<&-GS1IIw  !r<,6L* % '2<FU _,= > ? AZ\<(0Jx4MJ ! #SU<")n@[.[)hll9S T V%<N*Xf55:R>:R2SkpN6G U'ls 9 IIcKt||||||| | | |||||}|dz |z}tjd||| t| tr t | |nd}|dk(}|r;t |jj||||r|nddiddig d{}n=t|jj||||r|nddiddigd d i d{}tjd t||r$t|j|d{}n,tt|j|d{}tjd|| |z }ttdztf}|rd|vr|Dcgc]}|j s|j }}|Dcgc]}|j"s|j"} }t%t'|| z}!|!rAt)|jdd|!iid{}"|"D#cic]}#|#j |#}}#g}$|D]8} |j+}%|st/|%|d{}%|rd|vr|j r/|j |vr! ||j j+|%d<|j"rD|j"|vr6||j"}&|&j |&j0|&j2d|%d<| d us|rGd|vrC|r%|$j5t6j9|%|$j5t;di|% |%j=d}'|$j5t?t|';tA|$|||S777j7@cc}wcc}w7cc}#w#t,$r|j}%YpwxYw7c#t,$r$||j j|%d<YLwxYww)a8 Helper function to list keys Args: page: int size: int user_id: Optional[str] team_id: Optional[str] key_alias: Optional[str] exclude_team_id: Optional[str] # exclude a specific team_id return_full_object: bool # when true, will return UserAPIKeyAuth objects instead of just the token admin_team_ids: Optional[List[str]] # list of team IDs where the user is an admin member_team_ids: Optional[List[str]] # list of team IDs where user is a member (for service account visibility) Returns: KeyListResponseObject { "keys": List[str] or List[UserAPIKeyAuth], # Updated to reflect possible return types "total_count": int, "current_page": int, "total_pages": int, } )rrrrrr}rJrKrBr rFr7rLrMrtzPagination: skip=%s, take=%sNrIrKr=r)rskiprsrr T)rrrsrrzFetched %s keysr`zTotal count of keys: %srrr)rrrcreated_by_user)rrhrirjr})!rrrrrrwrcrrrgrrrgrrryrrrr9rrr!rNrrr\rrUserAPIKeyAuthrrKeyListResponseObject)(rr>r?rrrrrr}r@rJrKrBrCrDrErr rFr7rLrMrrruuse_deleted_tablerrhrjuser_maprtuser_idscreated_by_idsall_idsusersrkey_listkey_dictr_tokens( rrPrPsC^0''%' 7'5%E$!8t#D=tTJ7>6IjY`beNfgz2lp &27 FLLVV"6*f%W   1?EEOO"6*f% )$/P   0#d)<=mLRRY^R__ )*Em*TU[[bg[hh 8+F(<4/0KC$J ,-/H &F"26F3#++3;;FF;? RC3>> R Rc(^";<= 9D]9S9]9] 4/2:^:4E8==t d*=H=VXH$/ "~~'H !=h VVH f&{{s{{h6D'/ '<'G'G'IHV$~~#..H"<"*3>>":.66"1"<"<"1"<"</*+  %&Vv5E  @ O OPX YZ".X.\\'*F OODf- .I$/L !   }    &`hG R4> "xxzH " W!D'/ '<'A'A'CHV$DsBO.M==O.NAO.N,O.NAO. N N ,O.2NN=O.NO.N, O.7NO.N;$O.> N>C O.O.O.O. O.O.N84O.7N88O.>)O+'O.*O++O.c"dddiddtiigiS)z3 Condition to filter out UI session tokens rrNry)rr}rrrrs,    89 :  rrxc K|jtjjk(ryt t |j d|id{}|tddd|i|jrGt|j||d d{}|$t|| ryt|| d{rytd dd |d |jd|ji77X75w)a Check that the caller has admin privileges for the target key. Allowed callers: - Proxy admin - Team admin for the key's team - Org admin for the key's team's organization Raises HTTPException(403) if the caller is not authorized. Nrr`r rzKey not found: rTrrrz7Only proxy admins, team admins, or org admins can call z . user_role=z , user_id=) rrrrrrgrarrr/rBrAr)rrxrrrtarget_key_rowrs rrrs,$""&6&B&B&H&HH#00KM0Z"["g"g %#h#N|n=>   /"**'1 !    "5FQYZ0CT_ghhh  NugV*445Z@Q@Y@Y?Z\  / is7AC2C,AC2C.$C2:C0;2C2.C20C2 /key/block http_requestcZKddlm}m}ddlm}m}m}m} m} m } | $ttjjt|js+t!dt"j$dt&j(|jj+dr||j } n |j} t-|| | | d d{t/t1| j3d | i d{} | +t!dt"j4dt&j6|rt9j:|t=t?tAjBtEjFtHjJ|||||jLtNjP| dd| jS t/t1| jUd | itWddid{}tY| | | d{|S7R7'7"7w)a Block an Virtual key from making any requests. Parameters: - key: str - The key to block. Can be either the unhashed key (sk-...) or the hashed key value Example: ```bash curl --location 'http://0.0.0.0:4000/key/block' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{ "key": "sk-Fn8Ej39NxjAXrvpUGKghGw" }' ``` Note: This is an admin-only endpoint. Only proxy admins, team admins, or org admins can block keys. rget_audit_log_changed_byis_audit_logging_enabledcreate_audit_log_for_updater*r{rr~rNInvalid key format.rtrrrprrrr`rqryrr{r{} rrL changed_bychanged_by_api_keyr object_idactionupdated_values before_value request_dataTrr-+litellm.proxy.management_helpers.audit_logsrrrrr*r{rr~rr!rr:rr[rtrrrrrwrrrrgrarurvrrLiteLLM_AuditLogsrruuid4rrr rr-LitellmTableNamesKEY_TABLE_NAMEmodel_dump_jsonrrLr+rrrryrrrr*r{rr~rrxexisting_recordrs r block_keyrs :,CCIIJLL DHH %) 22,,    xx5!!1 xx  "+!#-  $11L]1[#\#h#h %$i$O$ 00**    ! '.4::<('||HLL97+=*;1I  (9'@'@0??*$#'!0!@!@!B  (((CM(RSZZ % %y$&7 8[F #!-+  Mk@ IC H+H!-H+=H$>DH+H'H+H)H+$H+'H+)H+ /key/unblockcZKddlm}m}ddlm}m}m}m} m} m } | $ttjjt|js+t!dt"j$dt&j(|jj+dr||j } n |j} t-|| | | d d{t/t1| j3d | i d{} | +t!dt"j4dt&j6|rt9j:|t=t?tAjBtEjFtHjJ|||||jLtNjP| dd| jS t/t1| jUd | itWddid{}tY| | | d{|S7R7'7"7w)a Unblock a Virtual key to allow it to make requests again. Parameters: - key: str - The key to unblock. Can be either the unhashed key (sk-...) or the hashed key value Example: ```bash curl --location 'http://0.0.0.0:4000/key/unblock' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{ "key": "sk-Fn8Ej39NxjAXrvpUGKghGw" }' ``` Note: This is an admin-only endpoint. Only proxy admins, team admins, or org admins can unblock keys. rrrNrrtrrrprrrr`rqr unblockedrrrrFrrrrs r unblock_keyrAs :,CCIIJLL DHH %) 22,,    xx5!!1 xx  "+!#-  $11L]1[#\#h#h %$i$O$ 00**    ! '.4::<('||HLL97+=*;1I  (9'@'@0??*&#'!0!@!@!B  (((CM(RSZZ % %y%&8 9[F #!-+  Mk@ rz /key/healthc xK |j}tdd}|rDd|vr@t||t|dd{}||d<|j ddk(rd|d <tdi|S7-#t $r>}t d |tjt|d d tj d}~wwxYww)aS Check the health of the key Checks: - If key based logging is configured correctly - sends a test log Usage Pass the key in the request header ```bash curl -X POST "http://localhost:4000/key/health" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" ``` Response when logging callbacks are setup correctly: ```json { "key": "healthy", "logging_callbacks": { "callbacks": [ "gcs_bucket" ], "status": "healthy", "details": "No logger exceptions triggered, system is healthy. Manually check if logs were sent to ['gcs_bucket']" } } ``` Response when logging callbacks are not setup correctly: ```json { "key": "unhealthy", "logging_callbacks": { "callbacks": [ "gcs_bucket" ], "status": "unhealthy", "details": "Logger exceptions triggered, system is unhealthy: Failed to load vertex credentials. Check to see if credentials containing partial/invalid information." } } ``` healthyN)rtlogging_callbackslogging)rr key_loggingrr unhealthyrtzKey health check failed: rrrr}) rKeyHealthResponsetest_key_loggingr6rr!rrrr8rr9)rr key_metadata health_statuslogging_statusesr#s r key_healthrsr /88 2C"3 I5,<"31,? J-'  2BM- . ##H-<'2 e$ 1=11'  /s3 66!Wf-66    s:B:.T.T.Z.ZZ  $ $ +   088 8+EE/%      sBBBBrcKddl}ddlm}ddlm}ddlm}m}g}|D]2} | jd|j| d)td|} |j| } | j|j|j} | j|  dd d d gd } || |||| d{} d| d<t!j"di| d{t)j*dd{| j-}| j/| |rt'|dd|St'|dd|dS77i#t$$r}t'|dd|cYd}~Sd}~wwxYw7uw)a3 Test the key-based logging - Test that key logging is correctly formatted and all args are passed correctly - Make a mock completion call -> user can check if it's correctly logged - Check if any logger.exceptions were triggered -> if they were then returns it to the user client side rN)StringIO)add_litellm_data_to_request)general_settingsr callback_namez(callback_name is required in key_loggingzopenai/litellm-key-health-testrzQHello, this is a test from litellm /key/health. No LLM API call was made for this)rcontent)rmessages)rrrrrz test response mock_responserzLogging test failed: ) callbacksrdetailsrrz2Logger exceptions triggered, system is unhealthy: rzWNo logger exceptions triggered, system is healthy. Manually check if logs were sent to  r})rior$litellm.proxy.litellm_pre_call_utilsrrrrrr\r StreamHandlersetLevelERROR getLogger addHandlerr acompletionr!LoggingCallbackStatusrsleepgetvalue removeHandler)rrrrrrrrrcallbacklog_capture_stringchloggerrr# log_contentss rrr%sPI*,I << ( 4  $ $Xo%> ?GH H I !) %%&89BKK %%'F b 5#r 1/%-   !0_!!)D))) -- -557L $'HW  %'mnnAABC  9  *  $'+A3/   sgB&E9)EE !E$E%E)E9E7A E9 EE E4E/)E4*E9/E44E9z1^[a-zA-Z0-9][a-zA-Z0-9_\-/\.@]{0,253}[a-zA-Z0-9]$_KEY_ALIAS_PATTERNc|y t|t j sytj|stdtjddy#t$rtdtjddwxYw)u( Validate the format of the key_alias. A baseline validation always runs, regardless of ``litellm.enable_key_alias_format_validation``. The remaining charset/length rules are gated behind ``litellm.enable_key_alias_format_validation`` (default **False**). When disabled, only the baseline validation above is performed, so existing workflows are not broken. Rules (when enabled): - None is OK (no alias). - Otherwise must be 2–255 chars - start/end with alphanumeric - only allow a-zA-Z0-9_-/.@ NzInvalid key_aliasrrrzqInvalid key_alias format. Must be 2-255 characters, start/end with alphanumeric, and only contain a-zA-Z0-9_-/.@.) rirrrrr"enable_key_alias_format_validationrmatchrs rrrts$ #I.  5 5  # #I .H 22    /  ' 22    s A'A;rcK|n|kd|i}|rd|i|d<tt|j|d{}|/td|dtj dt jyyy78w) a( Helper to enforce unique key aliases across all keys. Args: key_alias (Optional[str]): The key alias to check prisma_client (Any): Prisma client instance existing_key_token (Optional[str]): ID of existing key being updated, to exclude from uniqueness check (The Admin UI passes key_alias, in all Edit key requests. So we need to be sure that if we find a key with the same alias, it's not the same key we're updating) Raises: ProxyException: If key alias already exists on a different key NrrNOTr`zKey with alias 'zB' already exists. Unique key aliases across all keys are required.r)rrg find_firstrrrrrw)rrr where_clause existing_keys rrrs"!:2=y1I #*,>"?L *+F}+UVaahtauu  # *9+5wx$66!00   $"; vs9A6A49A6c |yt|dk(ry|ddlm}m}|dur"t d|j j |jD]^\}}t|tsJt|dr|jn t|}d|vrt|d|d<td i|`yy#t$r}t d|d d}~wwxYw) z Validate the model_max_budget is GenericBudgetConfigType + enforce user has an enterprise license Raises: Exception: If model_max_budget is not a valid GenericBudgetConfigType Nr)rrTz=You must have an enterprise license to set model_max_budget. r budget_limitzInvalid model_max_budget: zM. Example of valid model_max_budget: https://docs.litellm.ai/docs/proxy/usersr})rrrrrrrrrrrrrrrrqr!)rrr_model _budget_info_infor#s rr_r_s  #   A %   ' R4' STeTvTvT|T|S}~)9(>(>(@ &$ !&#...6=\<5X //1^bco^p!U*,1%2G,HE.)%u% & (  (+x y   s"B7B7B!B77 CCCr|)T)NN)NFNNNFN)NFNNFNr=NNNNNFN(PrrrIr;rrPrrerMrTcollections.abcrrrrrrr typingr r r r rrrrrQrQrrrrrrrrlitellm._loggingr litellm._uuidrlitellm.caching.dual_cacherrjrrrr*litellm.litellm_core_utils.duration_parserr *litellm.litellm_core_utils.safe_json_dumpsr!litellm.models.credentialsr")litellm.proxy._experimental.mcp_server.dbr#r$r%Olitellm.proxy._experimental.mcp_server.outbound_credentials.sso_assertion_storer&r8r(r)r*litellm.proxy.auth.auth_checksr+r,r-r.r/litellm.proxy.auth.auth_utilsr0r1r2$litellm.proxy.auth.user_api_key_authr39litellm.proxy.common_utils.auth_cache_invalidation_pubsubr45litellm.proxy.common_utils.callback_config_validationr5)litellm.proxy.common_utils.callback_utilsr6r7-litellm.proxy.common_utils.config_sync_pubsubr8r9%litellm.proxy.common_utils.rbac_utilsr:r[r<-litellm.proxy.common_utils.user_api_key_cacher=.litellm.proxy.hooks.key_management_event_hooksr>,litellm.proxy.hooks.model_max_budget_limiterr?/litellm.proxy.management_endpoints.common_utilsr@rArBrCrDrErFrG=litellm.proxy.management_endpoints.model_management_endpointsrH6litellm.proxy.management_helpers.access_group_key_syncrIrJrK3litellm.proxy.management_helpers.key_settings_auditrL8litellm.proxy.management_helpers.object_permission_utilsrMrNrOrPrQrR>litellm.proxy.management_helpers.team_member_permission_checksrS&litellm.proxy.management_helpers.utilsrT1litellm.proxy.spend_tracking.spend_tracking_utilsrU7litellm.proxy.ui_crud_endpoints.proxy_setting_endpointsrVrLrWrXrYrZr[$litellm.repositories.base_repositoryr\&litellm.repositories.budget_repositoryr]&litellm.repositories.config_repositoryr^r_+litellm.repositories.credentials_repositoryr`%litellm.repositories.model_repositoryra%litellm.repositories.prisma_protocolsrb'litellm.repositories.table_repositoriesrcrd$litellm.repositories.team_repositoryre$litellm.repositories.user_repositoryrf2litellm.repositories.verification_token_repositoryrglitellm.routerrh+litellm.secret_managers.base_secret_managerrilitellm.secret_managers.mainrjAlitellm.types.proxy.management_endpoints.key_management_endpointsrkrlrmrnrolitellm.types.routerrplitellm.types.utilsrqrrrsrrtru prisma_models BaseModelrvryrrrrrrrrrrGenerateKeyRequestrrMemberrrrboolrrrr=rrrrr rrrrrrrrr$r%rr2 frozensetr3r=rFGenerateRequestBaserJBudgetLimitEntryrrr]rcrorxrrrrrrrr rrrall_proxy_modelsr rLiteLLM_OrganizationTablerrrrpostrBrErRRegenerateKeyRequestrer^rkrmrzr|rrrrrr!rrr"r KeyRequestr rr)rr/r"rrgrkr rrrrqrrrrrrrrrrrrr r rResetSpendRequestrrr r#r'r+r/r2r5r8rrSrbrrwr|rrPrrBlockKeyRequestrrrrr rrcompilerrrr_r}rrr6s%   BB22XXX UUU10 KA5 #ZZ C`TKIRU    YOL@CPMA>@?"S3, ./yA080"22 !( !01#$CCCC FFFF /|/ \0J/l|N7S 2E  cDj  T  $),EE$"<sTzV\_cVc 5C 5H 5&&* " " " Tz" d "  " J% 4Z4Z 4+Dj+*+&+3 +  +\ /A TXY\T]`dTd #*#%# #  #L % :TA  X3d:XD XnL^8$^*T1$^%$^ $^  $^  $^NF'#v+2F2MFRVF  %  / /     4Z   T] F ,$$1:;K]:[0\&\+ d + /+ &+  + d).$ (4K(%("& (  (  (V % ,0 ()D00  0 &0 ! 0 +T1 0  0 f 4Z$&>!!qr ; / /;; ;|n n%nd n+T1 n  nb D , -D / /DDjDDj D "&c3h D "&c3h DD DN# , -# / /# Dj# Dj #  #  # L , -* / / 2 , -* / / "!*! / /! ! !H%.&&,,.?.P.P.V.VW%E / / / //  / ( /  / d , -( / / B , -( / / 2 %      @((( / /( ( (V  +,-&   )00A(B%+ t&M+ M+%M+d M+ M+`#  +,-  )00A(B%+ t&W W%Wd W  Wt0)00Z^0cg0fZ 1 1Z/Zz/ 04,4@Y4^b4 UT\ d $TXD :D&2T&9DFIDjDDN "#3 "G` "eh "*/39=n(n%nd n $& n ( n $ n n%tOn0$6n #v+nb%( %(34%(0%( $& %( ( %(  %(D %(P{b {b/{b&{b {b  {b  {b({b {b|]"2!37K\C]B^_)00A(B%+ t& _ _ _ &_ d _ `_ D  +,-(   )00A(B%+ t&[ [%[d [ [|V VV0$6V V:  +,-(   )00A(B%+ t&n #n%nd n nbC "C C (C  C L]"2!37K\C]B^_)00A(B%+ t&h+ h+%h+d h+`h+V  c73;#778 "D(  #tCK !   +,-  #(/0A(BS+ t S+%S+  S+lK/0HY@Z?[\#gmmD>]^(/0A(Bo+ to+%o+]o+dd3i$&6FTMaejqrvjw0 #'&*" $#"& !! (,  8E%) *,!$&$(#'#'!%!%" "&!04%)!!"&"'+=A#$(#')-!%st-(tDjt t t  t  tDLtttt|tt tD[t4Zt :t   t"4Z#t$d %t&4Z't(Dj)t*d +t,Tz-t.:/t0Tk1t2Tz3t4Tz5t6457t8d{9t:Tz;t<!4K=t>?t@TkAtBTkCtDD[EtFD[GtH$;ItJ$;KtLt MtNTkOtPD[QtR $;StT4ZUtVd WtX &-YtZd{[t\d ]t^d _t`4KatbDjctdtetf*gth4d:itjktlTzmtnD[otp3i$&qtr$;stn #%#'# #( #LD'D'D&D D  DV&* l l'l&ld l  4$;67 78 ld&*5 , -5%5d 5 $sF{  5vU gc6k* +UU U U.&*  , -&d     2&* c' &  d   4$;67 78 (YuYu%YuYu Yu  Yux N t % ! "+,-  )00A(B K Q% Q  Q  QF+ ! "+,-  )00A(B=%=  =22T9c,: !: : : * :  : zss)s s s  % s&sd s(s$ssl  +,-    +,-  (,(/0A(B%+ t& F+ tF+  %F+&F+d F+4F+  F+R(% (   :#&#=V#[`#Lv3vuvY]vDx&)9C)?$)Fx5QXY\^dYdQegjQjKkx"73;+?GCQWKDX6&b&b&bF#c)D0&b &bR!  +,-  )00A(B%+ t& a+ a+ a+&a+d a+ #s(^a+  a+H_%_ 4Z_4Z_4Z _ Tz _ Dj _ __DS)D0SS S$%() #Y%() #Y( % ()  #Y M)D0M%M M #Y M N)D0 N% N  N #Y N&/)/D%EUE  +,-  )00A(Ba]q9bkaC@ X 2JK"':Z"[ 3LM! Z %U8PQ#E7mn$)%=_$`OF8VW$T7]^t1TU"45PQ"':Z"[ 3LM$ f   UCu u %u  u   u 4Z u 4Zu 4Zu Dju Tzu !u "#u $"%u &4Z'u ./u 0 I 1u 2 $J3u 4d 5u 64Z7u 8Dj9u :;u B4ZCu JKu   u p$%$$v,$c $  $D  +,-  (/0A(BaA=9bQ3K@t1fg2ab q %q q  q  $J q 4Z q  #s(^ q   q h3:34S>TXCX@BB(BtCQWKGXB)-$)!"&#(!% 4Z 4Z4ZTz  Dj  4Z I$#Y%"d 4ZDj!$J S&[V#'$'+ $)#!"&#(!%/qq q q4Z q 4Z q 4Z qTzqDjq4ZqqI$q#Y  q"q4Zq !q" I #q$ $J%q&d 'q(4Z)q*Dj+q,!-q.$J/q01qh V 8L 3%3*3 $&3( 3  3  3l\!1 2'J[B\A]^)00A(B%+ t& m mm&md m%m_m`^#3"4GL]D^C_`)00A(B%+ t& m mm&md mam`  +,-$   )00A(BP P %P  P f% t( 0I %I I '#s(+,I  I X'BJJ'[\E\( #*( ( \&*Tz$&d  B t   r