----------- # Endpoints v1 Group | Version | Kind ------------ | ---------- | ----------- Core | v1 | Endpoints Endpoints is a collection of endpoints that implement the actual service. Example: Name: "mysvc", Subsets: [ { Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] }, { Addresses: [{"ip": "10.10.3.3"}], Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}] }, ] Field | Description ------------ | ----------- 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds metadata
*[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata subsets
*[EndpointSubset](#endpointsubset-v1) array* | The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service. ### EndpointsList v1 Field | Description ------------ | ----------- 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources items
*[Endpoints](#endpoints-v1) array* | List of endpoints. 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds metadata
*[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds ## Write Operations See supported operations below... ## Create >bdocs-tab:kubectl `kubectl` Command ```bdocs-tab:kubectl_shell Coming Soon ``` >bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) ```bdocs-tab:curl_shell Coming Soon ``` >bdocs-tab:kubectl Output ```bdocs-tab:kubectl_json Coming Soon ``` >bdocs-tab:curl Response Body ```bdocs-tab:curl_json Coming Soon ``` create Endpoints ### HTTP Request `POST /api/v1/namespaces/{namespace}/endpoints` ### Path Parameters Parameter | Description ------------ | ----------- namespace | object name and auth scope, such as for teams and projects ### Query Parameters Parameter | Description ------------ | ----------- pretty | If 'true', then the output is pretty printed. ### Body Parameters Parameter | Description ------------ | ----------- body
*[Endpoints](#endpoints-v1)* | ### Response Code | Description ------------ | ----------- 200
*[Endpoints](#endpoints-v1)* | OK ## Replace >bdocs-tab:kubectl `kubectl` Command ```bdocs-tab:kubectl_shell Coming Soon ``` >bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) ```bdocs-tab:curl_shell Coming Soon ``` >bdocs-tab:kubectl Output ```bdocs-tab:kubectl_json Coming Soon ``` >bdocs-tab:curl Response Body ```bdocs-tab:curl_json Coming Soon ``` replace the specified Endpoints ### HTTP Request `PUT /api/v1/namespaces/{namespace}/endpoints/{name}` ### Path Parameters Parameter | Description ------------ | ----------- name | name of the Endpoints namespace | object name and auth scope, such as for teams and projects ### Query Parameters Parameter | Description ------------ | ----------- pretty | If 'true', then the output is pretty printed. ### Body Parameters Parameter | Description ------------ | ----------- body
*[Endpoints](#endpoints-v1)* | ### Response Code | Description ------------ | ----------- 200
*[Endpoints](#endpoints-v1)* | OK ## Patch >bdocs-tab:kubectl `kubectl` Command ```bdocs-tab:kubectl_shell Coming Soon ``` >bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) ```bdocs-tab:curl_shell Coming Soon ``` >bdocs-tab:kubectl Output ```bdocs-tab:kubectl_json Coming Soon ``` >bdocs-tab:curl Response Body ```bdocs-tab:curl_json Coming Soon ``` partially update the specified Endpoints ### HTTP Request `PATCH /api/v1/namespaces/{namespace}/endpoints/{name}` ### Path Parameters Parameter | Description ------------ | ----------- name | name of the Endpoints namespace | object name and auth scope, such as for teams and projects ### Query Parameters Parameter | Description ------------ | ----------- pretty | If 'true', then the output is pretty printed. ### Body Parameters Parameter | Description ------------ | ----------- body
*[Patch](#patch-unversioned)* | ### Response Code | Description ------------ | ----------- 200
*[Endpoints](#endpoints-v1)* | OK ## Delete >bdocs-tab:kubectl `kubectl` Command ```bdocs-tab:kubectl_shell Coming Soon ``` >bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) ```bdocs-tab:curl_shell Coming Soon ``` >bdocs-tab:kubectl Output ```bdocs-tab:kubectl_json Coming Soon ``` >bdocs-tab:curl Response Body ```bdocs-tab:curl_json Coming Soon ``` delete Endpoints ### HTTP Request `DELETE /api/v1/namespaces/{namespace}/endpoints/{name}` ### Path Parameters Parameter | Description ------------ | ----------- name | name of the Endpoints namespace | object name and auth scope, such as for teams and projects ### Query Parameters Parameter | Description ------------ | ----------- pretty | If 'true', then the output is pretty printed. gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. ### Body Parameters Parameter | Description ------------ | ----------- body
*[DeleteOptions](#deleteoptions-v1)* | ### Response Code | Description ------------ | ----------- 200
*[Status](#status-unversioned)* | OK ## Delete Collection >bdocs-tab:kubectl `kubectl` Command ```bdocs-tab:kubectl_shell Coming Soon ``` >bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) ```bdocs-tab:curl_shell Coming Soon ``` >bdocs-tab:kubectl Output ```bdocs-tab:kubectl_json Coming Soon ``` >bdocs-tab:curl Response Body ```bdocs-tab:curl_json Coming Soon ``` delete collection of Endpoints ### HTTP Request `DELETE /api/v1/namespaces/{namespace}/endpoints` ### Path Parameters Parameter | Description ------------ | ----------- namespace | object name and auth scope, such as for teams and projects ### Query Parameters Parameter | Description ------------ | ----------- pretty | If 'true', then the output is pretty printed. fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. timeoutSeconds | Timeout for the list/watch call. watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. ### Response Code | Description ------------ | ----------- 200
*[Status](#status-unversioned)* | OK ## Read Operations See supported operations below... ## Read >bdocs-tab:kubectl `kubectl` Command ```bdocs-tab:kubectl_shell Coming Soon ``` >bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) ```bdocs-tab:curl_shell Coming Soon ``` >bdocs-tab:kubectl Output ```bdocs-tab:kubectl_json Coming Soon ``` >bdocs-tab:curl Response Body ```bdocs-tab:curl_json Coming Soon ``` read the specified Endpoints ### HTTP Request `GET /api/v1/namespaces/{namespace}/endpoints/{name}` ### Path Parameters Parameter | Description ------------ | ----------- name | name of the Endpoints namespace | object name and auth scope, such as for teams and projects ### Query Parameters Parameter | Description ------------ | ----------- pretty | If 'true', then the output is pretty printed. exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace' export | Should this value be exported. Export strips fields that a user can not specify. ### Response Code | Description ------------ | ----------- 200
*[Endpoints](#endpoints-v1)* | OK ## List >bdocs-tab:kubectl `kubectl` Command ```bdocs-tab:kubectl_shell Coming Soon ``` >bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) ```bdocs-tab:curl_shell Coming Soon ``` >bdocs-tab:kubectl Output ```bdocs-tab:kubectl_json Coming Soon ``` >bdocs-tab:curl Response Body ```bdocs-tab:curl_json Coming Soon ``` list or watch objects of kind Endpoints ### HTTP Request `GET /api/v1/namespaces/{namespace}/endpoints` ### Path Parameters Parameter | Description ------------ | ----------- namespace | object name and auth scope, such as for teams and projects ### Query Parameters Parameter | Description ------------ | ----------- pretty | If 'true', then the output is pretty printed. fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. timeoutSeconds | Timeout for the list/watch call. watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. ### Response Code | Description ------------ | ----------- 200
*[EndpointsList](#endpointslist-v1)* | OK ## List All Namespaces >bdocs-tab:kubectl `kubectl` Command ```bdocs-tab:kubectl_shell Coming Soon ``` >bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) ```bdocs-tab:curl_shell Coming Soon ``` >bdocs-tab:kubectl Output ```bdocs-tab:kubectl_json Coming Soon ``` >bdocs-tab:curl Response Body ```bdocs-tab:curl_json Coming Soon ``` list or watch objects of kind Endpoints ### HTTP Request `GET /api/v1/endpoints` ### Query Parameters Parameter | Description ------------ | ----------- fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. pretty | If 'true', then the output is pretty printed. resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. timeoutSeconds | Timeout for the list/watch call. watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. ### Response Code | Description ------------ | ----------- 200
*[EndpointsList](#endpointslist-v1)* | OK ## Watch >bdocs-tab:kubectl `kubectl` Command ```bdocs-tab:kubectl_shell Coming Soon ``` >bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) ```bdocs-tab:curl_shell Coming Soon ``` >bdocs-tab:kubectl Output ```bdocs-tab:kubectl_json Coming Soon ``` >bdocs-tab:curl Response Body ```bdocs-tab:curl_json Coming Soon ``` watch changes to an object of kind Endpoints ### HTTP Request `GET /api/v1/watch/namespaces/{namespace}/endpoints/{name}` ### Path Parameters Parameter | Description ------------ | ----------- name | name of the Endpoints namespace | object name and auth scope, such as for teams and projects ### Query Parameters Parameter | Description ------------ | ----------- fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. pretty | If 'true', then the output is pretty printed. resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. timeoutSeconds | Timeout for the list/watch call. watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. ### Response Code | Description ------------ | ----------- 200
*[Event](#event-versioned)* | OK ## Watch List >bdocs-tab:kubectl `kubectl` Command ```bdocs-tab:kubectl_shell Coming Soon ``` >bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) ```bdocs-tab:curl_shell Coming Soon ``` >bdocs-tab:kubectl Output ```bdocs-tab:kubectl_json Coming Soon ``` >bdocs-tab:curl Response Body ```bdocs-tab:curl_json Coming Soon ``` watch individual changes to a list of Endpoints ### HTTP Request `GET /api/v1/watch/namespaces/{namespace}/endpoints` ### Path Parameters Parameter | Description ------------ | ----------- namespace | object name and auth scope, such as for teams and projects ### Query Parameters Parameter | Description ------------ | ----------- fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. pretty | If 'true', then the output is pretty printed. resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. timeoutSeconds | Timeout for the list/watch call. watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. ### Response Code | Description ------------ | ----------- 200
*[Event](#event-versioned)* | OK ## Watch List All Namespaces >bdocs-tab:kubectl `kubectl` Command ```bdocs-tab:kubectl_shell Coming Soon ``` >bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) ```bdocs-tab:curl_shell Coming Soon ``` >bdocs-tab:kubectl Output ```bdocs-tab:kubectl_json Coming Soon ``` >bdocs-tab:curl Response Body ```bdocs-tab:curl_json Coming Soon ``` watch individual changes to a list of Endpoints ### HTTP Request `GET /api/v1/watch/endpoints` ### Query Parameters Parameter | Description ------------ | ----------- fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. pretty | If 'true', then the output is pretty printed. resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. timeoutSeconds | Timeout for the list/watch call. watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. ### Response Code | Description ------------ | ----------- 200
*[Event](#event-versioned)* | OK