# API Reference > API Reference > For the complete documentation index, see [llms.txt](https://deploy-preview-156--docs-projectcapsule.netlify.app/llms.txt). > The HTML version of this page is at https://deploy-preview-156--docs-projectcapsule.netlify.app/docs/proxy/reference/. Packages: - [capsule.clastix.io/v1beta1](#capsuleclastixiov1beta1) # capsule.clastix.io/v1beta1 Resource Types: - [GlobalProxySettings](#globalproxysettings) - [ProxySetting](#proxysetting) ## GlobalProxySettings GlobalProxySettings is the Schema for the globalproxysettings API. | **Name** | **Type** | **Description** | **Required** | | :---- | :---- | :----------- | :-------- | | **apiVersion** | string | capsule.clastix.io/v1beta1 | true | | **kind** | string | GlobalProxySettings | true | | **[metadata](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)** | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true | | **[spec](#globalproxysettingsspec)** | object | GlobalProxySettingsSpec defines the desired state of GlobalProxySettings. | false | | **[status](#globalproxysettingsstatus)** | object | GlobalProxySettingsStatus defines the observed state of GlobalProxySettings. | false | ### GlobalProxySettings.spec GlobalProxySettingsSpec defines the desired state of GlobalProxySettings. | **Name** | **Type** | **Description** | **Required** | | :---- | :---- | :----------- | :-------- | | **[rules](#globalproxysettingsspecrulesindex)** | []object | Subjects that should receive additional permissions.
The subjects are selected based on the oncoming requests. They don't have to relate to an existing tenant.
However they must be part of the capsule-user groups. | true | ### GlobalProxySettings.spec.rules[index] | **Name** | **Type** | **Description** | **Required** | | :---- | :---- | :----------- | :-------- | | **[subjects](#globalproxysettingsspecrulesindexsubjectsindex)** | []object | Subjects that should receive additional permissions.
The subjects are selected based on the oncoming requests. They don't have to relate to an existing tenant.
However they must be part of the capsule-user groups. | true | | **[clusterResources](#globalproxysettingsspecrulesindexclusterresourcesindex)** | []object | Cluster Resources for tenant Owner. | false | ### GlobalProxySettings.spec.rules[index].subjects[index] | **Name** | **Type** | **Description** | **Required** | | :---- | :---- | :----------- | :-------- | | **kind** | enum | Kind of tenant owner. Possible values are "User", "Group", and "ServiceAccount".
*Enum*: User, Group, ServiceAccount
| true | | **name** | string | Name of tenant owner. | true | ### GlobalProxySettings.spec.rules[index].clusterResources[index] ClusterResource Specification | **Name** | **Type** | **Description** | **Required** | | :---- | :---- | :----------- | :-------- | | **apiGroups** | []string | APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against any resource listed will be allowed. '*' represents all resources. Empty string represents v1 api resources. | true | | **resources** | []string | Resources is a list of resources this rule applies to. '*' represents all resources. | true | | **[selector](#globalproxysettingsspecrulesindexclusterresourcesindexselector)** | object | Select all cluster scoped resources with the given label selector.
Defining a selector which does not match any resources is considered not selectable (eg. using operation NotExists). | true | | **operations** | []enum | Operations which can be executed on the selected resources. Only GET and
LIST are supported. When omitted, both operations are enabled. LIST also
enables GET for backward compatibility with existing v1beta1 rules.
*Enum*: List, Get
*Default*: [List Get]
| false | ### GlobalProxySettings.spec.rules[index].clusterResources[index].selector Select all cluster scoped resources with the given label selector. Defining a selector which does not match any resources is considered not selectable (eg. using operation NotExists). | **Name** | **Type** | **Description** | **Required** | | :---- | :---- | :----------- | :-------- | | **[matchExpressions](#globalproxysettingsspecrulesindexclusterresourcesindexselectormatchexpressionsindex)** | []object | matchExpressions is a list of label selector requirements. The requirements are ANDed. | false | | **matchLabels** | map[string]string | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed. | false | ### GlobalProxySettings.spec.rules[index].clusterResources[index].selector.matchExpressions[index] A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. | **Name** | **Type** | **Description** | **Required** | | :---- | :---- | :----------- | :-------- | | **key** | string | key is the label key that the selector applies to. | true | | **operator** | string | operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. | true | | **values** | []string | values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch. | false | ### GlobalProxySettings.status GlobalProxySettingsStatus defines the observed state of GlobalProxySettings. | **Name** | **Type** | **Description** | **Required** | | :---- | :---- | :----------- | :-------- | | **[conditions](#globalproxysettingsstatusconditionsindex)** | []object | Conditions contains the reconciliation conditions for this GlobalProxySettings. | false | | **observedGeneration** | integer | ObservedGeneration is the most recent generation observed by the controller.
*Format*: int64
| false | ### GlobalProxySettings.status.conditions[index] Condition contains details for one aspect of the current state of this API Resource. | **Name** | **Type** | **Description** | **Required** | | :---- | :---- | :----------- | :-------- | | **lastTransitionTime** | string | lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
*Format*: date-time
| true | | **message** | string | message is a human readable message indicating details about the transition.
This may be an empty string. | true | | **reason** | string | reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty. | true | | **status** | enum | status of the condition, one of True, False, Unknown.
*Enum*: True, False, Unknown
| true | | **type** | string | type of condition in CamelCase or in foo.example.com/CamelCase. | true | | **observedGeneration** | integer | observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
*Format*: int64
*Minimum*: 0
| false | ## ProxySetting ProxySetting is the Schema for the proxysettings API. | **Name** | **Type** | **Description** | **Required** | | :---- | :---- | :----------- | :-------- | | **apiVersion** | string | capsule.clastix.io/v1beta1 | true | | **kind** | string | ProxySetting | true | | **[metadata](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)** | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true | | **[spec](#proxysettingspec)** | object | ProxySettingSpec defines the additional Capsule Proxy settings for additional users of the Tenant.
Resource is Namespace-scoped and applies the settings to the belonged Tenant. | false | | **[status](#proxysettingstatus)** | object | ProxySettingStatus defines the observed state of ProxySetting. | false | ### ProxySetting.spec ProxySettingSpec defines the additional Capsule Proxy settings for additional users of the Tenant. Resource is Namespace-scoped and applies the settings to the belonged Tenant. | **Name** | **Type** | **Description** | **Required** | | :---- | :---- | :----------- | :-------- | | **[subjects](#proxysettingspecsubjectsindex)** | []object | Subjects that should receive additional permissions. | true | ### ProxySetting.spec.subjects[index] | **Name** | **Type** | **Description** | **Required** | | :---- | :---- | :----------- | :-------- | | **kind** | enum | Kind of tenant owner. Possible values are "User", "Group", and "ServiceAccount"
*Enum*: User, Group, ServiceAccount
| true | | **name** | string | Name of tenant owner. | true | | **[clusterResources](#proxysettingspecsubjectsindexclusterresourcesindex)** | []object | Deprecated: ClusterResources cannot be granted through a namespaced
ProxySetting. Use administrator-managed GlobalProxySettings instead.
This field is retained to decode existing objects, but is ignored by the
proxy and must be omitted or empty in new settings. | false | | **[proxySettings](#proxysettingspecsubjectsindexproxysettingsindex)** | []object | Deprecated: Use Global Proxy Settings instead (https://projectcapsule.dev/docs/proxy/proxysettings/#globalproxysettings)

Proxy settings for tenant owner. | false | ### ProxySetting.spec.subjects[index].clusterResources[index] ClusterResource Specification | **Name** | **Type** | **Description** | **Required** | | :---- | :---- | :----------- | :-------- | | **apiGroups** | []string | APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against any resource listed will be allowed. '*' represents all resources. Empty string represents v1 api resources. | true | | **resources** | []string | Resources is a list of resources this rule applies to. '*' represents all resources. | true | | **[selector](#proxysettingspecsubjectsindexclusterresourcesindexselector)** | object | Select all cluster scoped resources with the given label selector.
Defining a selector which does not match any resources is considered not selectable (eg. using operation NotExists). | true | | **operations** | []enum | Operations which can be executed on the selected resources. Only GET and
LIST are supported. When omitted, both operations are enabled. LIST also
enables GET for backward compatibility with existing v1beta1 rules.
*Enum*: List, Get
*Default*: [List Get]
| false | ### ProxySetting.spec.subjects[index].clusterResources[index].selector Select all cluster scoped resources with the given label selector. Defining a selector which does not match any resources is considered not selectable (eg. using operation NotExists). | **Name** | **Type** | **Description** | **Required** | | :---- | :---- | :----------- | :-------- | | **[matchExpressions](#proxysettingspecsubjectsindexclusterresourcesindexselectormatchexpressionsindex)** | []object | matchExpressions is a list of label selector requirements. The requirements are ANDed. | false | | **matchLabels** | map[string]string | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed. | false | ### ProxySetting.spec.subjects[index].clusterResources[index].selector.matchExpressions[index] A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. | **Name** | **Type** | **Description** | **Required** | | :---- | :---- | :----------- | :-------- | | **key** | string | key is the label key that the selector applies to. | true | | **operator** | string | operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist. | true | | **values** | []string | values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch. | false | ### ProxySetting.spec.subjects[index].proxySettings[index] | **Name** | **Type** | **Description** | **Required** | | :---- | :---- | :----------- | :-------- | | **kind** | enum |
*Enum*: Nodes, StorageClasses, IngressClasses, PriorityClasses, RuntimeClasses, PersistentVolumes
| true | | **operations** | []enum |
*Enum*: List, Update, Delete
| true | ### ProxySetting.status ProxySettingStatus defines the observed state of ProxySetting. | **Name** | **Type** | **Description** | **Required** | | :---- | :---- | :----------- | :-------- | | **[conditions](#proxysettingstatusconditionsindex)** | []object | Conditions contains the reconciliation conditions for this ProxySetting. | false | | **observedGeneration** | integer | ObservedGeneration is the most recent generation observed by the controller.
*Format*: int64
| false | ### ProxySetting.status.conditions[index] Condition contains details for one aspect of the current state of this API Resource. | **Name** | **Type** | **Description** | **Required** | | :---- | :---- | :----------- | :-------- | | **lastTransitionTime** | string | lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
*Format*: date-time
| true | | **message** | string | message is a human readable message indicating details about the transition.
This may be an empty string. | true | | **reason** | string | reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty. | true | | **status** | enum | status of the condition, one of True, False, Unknown.
*Enum*: True, False, Unknown
| true | | **type** | string | type of condition in CamelCase or in foo.example.com/CamelCase. | true | | **observedGeneration** | integer | observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
*Format*: int64
*Minimum*: 0
| false | --- Last modified October 12, 2026: feat(docs): publish markdown renditions content negotiation for agents (#159) (e13616c)