API Reference¶
Packages¶
auth.litellm.ai/v1alpha1¶
Package v1alpha1 contains API Schema definitions for the auth v1alpha1 API group
Resource Types¶
- Team
- TeamList
- TeamMemberAssociation
- TeamMemberAssociationList
- User
- UserList
- VirtualKey
- VirtualKeyList
CRDRef¶
Appears in: - TeamMemberAssociationSpec
| Field | Description | Default | Validation |
|---|---|---|---|
name string |
|||
namespace string |
ConnectionRef¶
ConnectionRef defines how to connect to a LiteLLM instance
Appears in: - TeamMemberAssociationSpec - TeamSpec - UserSpec - VirtualKeySpec
| Field | Description | Default | Validation |
|---|---|---|---|
secretRef SecretRef |
SecretRef references a secret containing connection details | ||
instanceRef InstanceRef |
InstanceRef references a LiteLLM instance |
InstanceRef¶
InstanceRef references a LiteLLM instance
Appears in: - ConnectionRef
| Field | Description | Default | Validation |
|---|---|---|---|
name string |
Name is the name of the LiteLLM instance | ||
namespace string |
Namespace is the namespace of the LiteLLM instance (defaults to the same namespace as the Team) |
SecretKeys¶
SecretKeys defines the keys in a secret for connection details
Appears in: - SecretRef
| Field | Description | Default | Validation |
|---|---|---|---|
masterKey string |
MasterKey is the key in the secret containing the master key | ||
url string |
URL is the key in the secret containing the LiteLLM URL |
SecretRef¶
SecretRef references a secret containing connection details
Appears in: - ConnectionRef
| Field | Description | Default | Validation |
|---|---|---|---|
name string |
Name is the name of the secret | ||
keys SecretKeys |
Keys defines the keys in the secret that contain connection details |
Team¶
Team is the Schema for the teams API
Appears in: - TeamList
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
auth.litellm.ai/v1alpha1 |
||
kind string |
Team |
||
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
||
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec TeamSpec |
|||
status TeamStatus |
TeamList¶
TeamList contains a list of Team
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
auth.litellm.ai/v1alpha1 |
||
kind string |
TeamList |
||
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
||
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
||
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
items Team array |
TeamMemberAssociation¶
TeamMemberAssociation is the Schema for the teammemberassociations API
Appears in: - TeamMemberAssociationList
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
auth.litellm.ai/v1alpha1 |
||
kind string |
TeamMemberAssociation |
||
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
||
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec TeamMemberAssociationSpec |
|||
status TeamMemberAssociationStatus |
TeamMemberAssociationList¶
TeamMemberAssociationList contains a list of TeamMemberAssociation
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
auth.litellm.ai/v1alpha1 |
||
kind string |
TeamMemberAssociationList |
||
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
||
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
||
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
items TeamMemberAssociation array |
TeamMemberAssociationSpec¶
TeamMemberAssociationSpec defines the desired state of TeamMemberAssociation
Appears in: - TeamMemberAssociation
| Field | Description | Default | Validation |
|---|---|---|---|
connectionRef ConnectionRef |
ConnectionRef defines how to connect to the LiteLLM instance | Required: {} |
|
maxBudgetInTeam string |
MaxBudgetInTeam is the maximum budget for the user in the team | ||
role string |
Role is the role of the user - one of "admin" or "user" | Enum: [admin user] Required: {} |
|
teamRef CRDRef |
TeamRef is a reference to the team | Required: {} |
|
userRef CRDRef |
UserRef is a reference to the user | Required: {} |
TeamMemberAssociationStatus¶
TeamMemberAssociationStatus defines the observed state of TeamMemberAssociation
Appears in: - TeamMemberAssociation
| Field | Description | Default | Validation |
|---|---|---|---|
teamAlias string |
TeamAlias is the alias of the team | ||
teamID string |
TeamID is the ID of the team | ||
userEmail string |
UserEmail is the email of the user | ||
userID string |
UserID is the ID of the user | ||
teamExists boolean |
|||
userExists boolean |
|||
associationIsValid boolean |
|||
conditions Condition array |
TeamMemberWithRole¶
Appears in: - TeamStatus
| Field | Description | Default | Validation |
|---|---|---|---|
userID string |
UserID is the ID of the user | ||
userEmail string |
UserEmail is the email of the user | ||
role string |
Role is the role of the user - one of "admin" or "user" |
TeamSpec¶
TeamSpec defines the desired state of Team
Appears in: - Team
| Field | Description | Default | Validation |
|---|---|---|---|
connectionRef ConnectionRef |
ConnectionRef defines how to connect to the LiteLLM instance | Required: {} |
|
blocked boolean |
Blocked is a flag indicating if the team is blocked or not - will stop all calls from keys with this team_id | ||
budgetDuration string |
BudgetDuration - 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"), months ("1mo"). | ||
guardrails string array |
Guardrails are guardrails for the team | ||
maxBudget string |
MaxBudget is the maximum budget for the team | ||
metadata object (keys:string, values:string) |
Refer to Kubernetes API documentation for fields of metadata. |
||
modelAliases object (keys:string, values:string) |
ModelAliases are model aliases for the team | ||
models string array |
Models is the list of models that are associated with the team. All keys for this team_id will have at most, these models. If empty, assumes all models are allowed. | ||
organizationID string |
OrganizationID is the ID of the organization that the team belongs to. If not set, the team will be created with no organization. | ||
rpmLimit integer |
RPMLimit is the maximum requests per minute limit for the team - all keys associated with this team_id will have at max this RPM limit | ||
tags string array |
Tags for tracking spend and/or doing tag-based routing. Requires Enterprise license | ||
teamAlias string |
TeamAlias is the alias of the team | Required: {} |
|
teamID string |
TeamID is the ID of the team. If not set, a unique ID will be generated. | ||
teamMemberPermissions string array |
TeamMemberPermissions is the list of routes that non-admin team members can access. Example: ["/key/generate", "/key/update", "/key/delete"] | ||
tpmLimit integer |
TPMLimit is the maximum tokens per minute limit for the team - all keys with this team_id will have at max this TPM limit |
TeamStatus¶
TeamStatus defines the observed state of Team
Appears in: - Team
| Field | Description | Default | Validation |
|---|---|---|---|
observedGeneration integer |
ObservedGeneration is the most recent generation observed for this Team. It corresponds to the Team's generation, which is updated on mutation by the API Server. |
||
blocked boolean |
Blocked is a flag indicating if the team is blocked or not | ||
budgetDuration string |
BudgetDuration - Budget is reset at the end of specified duration. If not set, budget is never reset. | ||
budgetResetAt string |
BudgetResetAt is the date and time when the budget will be reset | ||
createdAt string |
CreatedAt is the date and time when the team was created | ||
liteLLMModelTable string |
LiteLLMModelTable is the model table for the team | ||
maxBudget string |
MaxBudget is the maximum budget for the team | ||
maxParallelRequests integer |
MaxParallelRequests is the maximum number of parallel requests allowed | ||
membersWithRole TeamMemberWithRole array |
MembersWithRole is the list of members with role | ||
modelID string |
ModelID is the ID of the model | ||
models string array |
Models is the list of models that are associated with the team. All keys for this team_id will have at most, these models. | ||
organizationID string |
OrganizationID is the ID of the organization that the team belongs to | ||
rpmLimit integer |
RPMLimit is the maximum requests per minute limit for the team - all keys associated with this team_id will have at max this RPM limit | ||
spend string |
Spend is the current spend of the team | ||
tags string array |
Tags for tracking spend and/or doing tag-based routing. Requires Enterprise license | ||
teamAlias string |
TeamAlias is the alias of the team | ||
teamID string |
TeamID is the ID of the team | ||
teamMemberPermissions string array |
TeamMemberPermissions is the list of routes that non-admin team members can access | ||
tpmLimit integer |
TPMLimit is the maximum tokens per minute limit for the team - all keys with this team_id will have at max this TPM limit | ||
updatedAt string |
UpdatedAt is the date and time when the team was last updated | ||
conditions Condition array |
User¶
User is the Schema for the users API
Appears in: - UserList
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
auth.litellm.ai/v1alpha1 |
||
kind string |
User |
||
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
||
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec UserSpec |
|||
status UserStatus |
UserList¶
UserList contains a list of User
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
auth.litellm.ai/v1alpha1 |
||
kind string |
UserList |
||
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
||
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
||
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
items User array |
UserSpec¶
UserSpec defines the desired state of User
Appears in: - User
| Field | Description | Default | Validation |
|---|---|---|---|
connectionRef ConnectionRef |
ConnectionRef defines how to connect to the LiteLLM instance | Required: {} |
|
aliases object (keys:string, values:string) |
Aliases is the model aliases for the user | ||
allowedCacheControls string array |
AllowedCacheControls is the list of allowed cache control values | ||
autoCreateKey boolean |
AutoCreateKey is whether to automatically create a key for the user | ||
blocked boolean |
Blocked is whether the user is blocked | ||
budgetDuration string |
BudgetDuration - 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"), months ("1mo"). | ||
duration string |
Duration is the duration for the key auto-created on /user/new | ||
guardrails string array |
Guardrails is the list of active guardrails for the user | ||
keyAlias string |
KeyAlias is the optional alias of the key if autoCreateKey is true | ||
maxBudget string |
MaxBudget is the maximum budget for the user | ||
maxParallelRequests integer |
MaxParallelRequests is the maximum number of parallel requests for the user | ||
metadata object (keys:string, values:string) |
Refer to Kubernetes API documentation for fields of metadata. |
||
modelMaxBudget object (keys:string, values:string) |
ModelMaxBudget is the model specific maximum budget | ||
modelRPMLimit object (keys:string, values:string) |
ModelRPMLimit is the model specific maximum requests per minute | ||
modelTPMLimit object (keys:string, values:string) |
ModelTPMLimit is the model specific maximum tokens per minute | ||
models string array |
Models is the list of models that the user is allowed to use | ||
permissions object (keys:string, values:string) |
Permissions is the user-specific permissions | ||
rpmLimit integer |
RPMLimit is the maximum requests per minute for the user | ||
sendInviteEmail boolean |
SendInviteEmail is whether to send an invite email to the user - NOTE: the user endpoint will return an error if email alerting is not configured and this is enabled, but the user will still be created. | ||
softBudget string |
SoftBudget - alert when user exceeds this budget, doesn't block requests | ||
spend string |
Spend is the amount spent by user | ||
ssoUserID string |
SSOUserID is the id of the user in the SSO provider | ||
teams string array |
Teams is the list of teams that the user is a member of | ||
tpmLimit integer |
TPMLimit is the maximum tokens per minute for the user | ||
userAlias string |
UserAlias is the alias of the user | ||
userEmail string |
UserEmail is the email of the user | Required: {} |
|
userID string |
UserID is the ID of the user. If not set, a unique ID will be generated. | ||
userRole string |
UserRole is the role of the user - one of "proxy_admin", "proxy_admin_viewer", "internal_user", "internal_user_viewer" | Enum: [proxy_admin proxy_admin_viewer internal_user internal_user_viewer] |
UserStatus¶
UserStatus defines the observed state of User
Appears in: - User
| Field | Description | Default | Validation |
|---|---|---|---|
allowedCacheControls string array |
AllowedCacheControls is the list of allowed cache control values | ||
allowedRoutes string array |
AllowedRoutes is the list of allowed routes | ||
aliases object (keys:string, values:string) |
Aliases is the model aliases for the user | ||
blocked boolean |
Blocked is whether the user is blocked | ||
budgetDuration string |
BudgetDuration - Budget is reset at the end of specified duration | ||
budgetID string |
BudgetID is the ID of the budget | ||
config object (keys:string, values:string) |
Config is the user-specific config | ||
createdAt string |
CreatedAt is the date and time when the user was created | ||
createdBy string |
CreatedBy is the user who created this user | ||
duration string |
Duration is the duration for the key | ||
enforcedParams string array |
EnforcedParams is the list of enforced parameters | ||
expires string |
Expires is the date and time when the user will expire | ||
guardrails string array |
Guardrails is the list of active guardrails | ||
keyAlias string |
KeyAlias is the alias of the key | ||
keyName string |
KeyName is the name of the key | ||
keySecretRef string |
KeySecretRef is the reference to the secret containing the user key | ||
litellmBudgetTable string |
LiteLLMBudgetTable is the budget table name | ||
maxBudget string |
MaxBudget is the maximum budget for the user | ||
maxParallelRequests integer |
MaxParallelRequests is the maximum number of parallel requests | ||
modelMaxBudget object (keys:string, values:string) |
ModelMaxBudget is the model specific maximum budget | ||
modelRPMLimit object (keys:string, values:string) |
ModelRPMLimit is the model specific maximum requests per minute | ||
modelTPMLimit object (keys:string, values:string) |
ModelTPMLimit is the model specific maximum tokens per minute | ||
models string array |
Models is the list of models that the user is allowed to use | ||
permissions object (keys:string, values:string) |
Permissions is the user-specific permissions | ||
rpmLimit integer |
RPMLimit is the maximum requests per minute | ||
spend string |
Spend is the amount spent by user | ||
tags string array |
Tags for tracking spend and/or doing tag-based routing. Requires Enterprise license | ||
teams string array |
Teams is the list of teams that the user is a member of | ||
token string |
Token is the user's token | ||
tpmLimit integer |
TPMLimit is the maximum tokens per minute | ||
updatedAt string |
UpdatedAt is the date and time when the user was last updated | ||
updatedBy string |
UpdatedBy is the user who last updated this user | ||
userAlias string |
UserAlias is the alias of the user | ||
userEmail string |
UserEmail is the email of the user | ||
userID string |
UserID is the unique user id | ||
userRole string |
UserRole is the role of the user | ||
observedGeneration integer |
ObservedGeneration represents the .metadata.generation that the condition was set based upon | ||
conditions Condition array |
VirtualKey¶
VirtualKey is the Schema for the virtualkeys API
Appears in: - VirtualKeyList
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
auth.litellm.ai/v1alpha1 |
||
kind string |
VirtualKey |
||
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
||
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec VirtualKeySpec |
|||
status VirtualKeyStatus |
VirtualKeyList¶
VirtualKeyList contains a list of VirtualKey
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
auth.litellm.ai/v1alpha1 |
||
kind string |
VirtualKeyList |
||
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
||
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
||
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
items VirtualKey array |
VirtualKeySpec¶
VirtualKeySpec defines the desired state of VirtualKey
Appears in: - VirtualKey
| Field | Description | Default | Validation |
|---|---|---|---|
connectionRef ConnectionRef |
ConnectionRef defines how to connect to the LiteLLM instance | Required: {} |
|
aliases object (keys:string, values:string) |
Aliases maps additional aliases for the key | ||
allowedCacheControls string array |
AllowedCacheControls defines allowed cache control settings | ||
allowedRoutes string array |
AllowedRoutes defines allowed API routes | ||
blocked boolean |
Blocked indicates if the key is blocked | ||
budgetDuration string |
BudgetDuration specifies the duration for budget tracking | ||
budgetID string |
BudgetID is the identifier for the budget | ||
config object (keys:string, values:string) |
Config contains additional configuration settings | ||
duration string |
Duration specifies how long the key is valid | ||
enforcedParams string array |
EnforcedParams lists parameters that must be included in requests | ||
guardrails string array |
Guardrails defines guardrail settings | ||
key string |
Key is the actual key value | ||
keyAlias string |
KeyAlias is the user defined key alias | Required: {} |
|
maxBudget string |
MaxBudget sets the maximum budget limit | ||
maxParallelRequests integer |
MaxParallelRequests limits concurrent requests | ||
metadata object (keys:string, values:string) |
Refer to Kubernetes API documentation for fields of metadata. |
||
modelMaxBudget object (keys:string, values:string) |
ModelMaxBudget sets budget limits per model | ||
modelRPMLimit object (keys:string, values:integer) |
ModelRPMLimit sets RPM limits per model | ||
modelTPMLimit object (keys:string, values:integer) |
ModelTPMLimit sets TPM limits per model | ||
models string array |
Models specifies which models can be used | ||
permissions object (keys:string, values:string) |
Permissions defines key permissions | ||
rpmLimit integer |
RPMLimit sets global RPM limit | ||
sendInviteEmail boolean |
SendInviteEmail indicates whether to send an invite email | ||
softBudget string |
SoftBudget sets a soft budget limit | ||
spend string |
Spend tracks the current spend amount | ||
tags string array |
Tags for tracking spend and/or doing tag-based routing. Requires Enterprise license | ||
teamID string |
TeamID identifies the team associated with the key | ||
tpmLimit integer |
TPMLimit sets global TPM limit | ||
userID string |
UserID identifies the user associated with the key |
VirtualKeyStatus¶
VirtualKeyStatus defines the observed state of VirtualKey
Appears in: - VirtualKey
| Field | Description | Default | Validation |
|---|---|---|---|
aliases object (keys:string, values:string) |
Aliases maps additional aliases for the key | ||
allowedCacheControls string array |
AllowedCacheControls defines allowed cache control settings | ||
allowedRoutes string array |
AllowedRoutes defines allowed API routes | ||
blocked boolean |
Blocked indicates if the key is blocked | ||
budgetDuration string |
BudgetDuration is the duration of the budget | ||
budgetID string |
BudgetID is the identifier for the budget | ||
budgetResetAt string |
BudgetResetAt is the date and time when the budget will reset | ||
config object (keys:string, values:string) |
Config contains additional configuration settings | ||
createdAt string |
CreatedAt is the date and time when the key was created | ||
createdBy string |
CreatedBy tracks who created the key | ||
duration string |
Duration specifies how long the key is valid | ||
enforcedParams string array |
EnforcedParams lists parameters that must be included in requests | ||
expires string |
Expires is the date and time when the key will expire | ||
guardrails string array |
Guardrails defines guardrail settings | ||
keyAlias string |
KeyAlias is the user defined key alias | ||
keyID string |
KeyID is the generated ID of the key | ||
keyName string |
KeyName is the redacted secret key | ||
keySecretRef string |
KeySecretRef is the reference to the secret containing the key | ||
liteLLMBudgetTable string |
LiteLLMBudgetTable is the budget table reference | ||
maxBudget string |
MaxBudget is the maximum budget for the key | ||
maxParallelRequests integer |
MaxParallelRequests limits concurrent requests | ||
models string array |
Models specifies which models can be used | ||
permissions object (keys:string, values:string) |
Permissions defines key permissions | ||
rpmLimit integer |
RPMLimit sets global RPM limit | ||
spend string |
Spend tracks the current spend amount | ||
tags string array |
Tags for tracking spend and/or doing tag-based routing. Requires Enterprise license | ||
teamID string |
TeamID identifies the team associated with the key | ||
token string |
Token contains the actual API key | ||
tokenID string |
TokenID is the unique identifier for the token | ||
tpmLimit integer |
TPMLimit sets global TPM limit | ||
updatedAt string |
UpdatedAt is the date and time when the key was last updated | ||
updatedBy string |
UpdatedBy tracks who last updated the key | ||
userID string |
UserID identifies the user associated with the key | ||
observedGeneration integer |
ObservedGeneration tracks the generation observed by the controller | ||
conditions Condition array |