kubernetes reference import k8s io api discovery v1 EndpointSlice represents a subset of the endpoints that implement a service apiVersion discovery k8s io v1 title EndpointSlice kind EndpointSlice contenttype apireference apimetadata weight 3 autogenerated true

Answer:
---
api_metadata:
  apiVersion: "discovery.k8s.io/v1"
  import: "k8s.io/api/discovery/v1"
  kind: "EndpointSlice"
content_type: "api_reference"
description: "EndpointSlice represents a subset of the endpoints that implement a service."
title: "EndpointSlice"
weight: 3
auto_generated: true
---

`apiVersion: discovery.k8s.io/v1`

`import "k8s.io/api/discovery/v1"`

## EndpointSlice {#EndpointSlice}

EndpointSlice represents a subset of the endpoints that implement a service. For a given service there may be multiple EndpointSlice objects, selected by labels, which must be joined to produce the full set of endpoints.

- **apiVersion**: discovery.k8s.io/v1

- **kind**: EndpointSlice

- **metadata** (ObjectMeta)

  Standard object's metadata.

- **addressType** (string), required

  addressType specifies the type of address carried by this EndpointSlice. All addresses in this slice must be the same type. This field is immutable after creation. The following address types are currently supported: * IPv4: Represents an IPv4 Address. * IPv6: Represents an IPv6 Address. * FQDN: Represents a Fully Qualified Domain Name.

- **endpoints** ([]Endpoint), required

  *Atomic: will be replaced during a merge*

  endpoints is a list of unique endpoints in this slice. Each slice may include a maximum of 1000 endpoints.

  *Endpoint represents a single logical "backend" implementing a service.*

  - **endpoints.addresses** ([]string), required

    *Set: unique values will be kept during a merge*

    addresses of this endpoint. The contents of this field are interpreted according to the corresponding EndpointSlice addressType field. Consumers must handle different types of addresses in the context of their own capabilities. This must contain at least one address but no more than 100. These are all assumed to be fungible and clients may choose to only use the first element. Refer to: https://issue.k8s.io/106267

  - **endpoints.conditions** (EndpointConditions)

    conditions contains information about the current status of the endpoint.

    *EndpointConditions represents the current condition of an endpoint.*

    - **endpoints.conditions.ready** (boolean)

      ready indicates that this endpoint is prepared to receive traffic, according to whatever system is managing the endpoint. A nil value indicates an unknown state. In most cases consumers should interpret this unknown state as ready. For compatibility reasons, ready should never be "true" for terminating endpoints, except when the normal readiness behavior is being explicitly overridden, for example when the associated Service has set the publishNotReadyAddresses flag.

    - **endpoints.conditions.serving** (boolean)

      serving is identical to ready except that it is set regardless of the terminating state of endpoints. This condition should be set to true for a ready endpoint that is terminating. If nil, consumers should defer to the ready condition.

    - **endpoints.conditions.terminating** (boolean)

      terminating indicates that this endpoint is terminating. A nil value indicates an unknown state. Consumers should interpret this unknown state to mean that the endpoint is not terminating.

  - **endpoints.deprecatedTopology** (map[string]string)

    deprecatedTopology contains topology information part of the v1beta1 API. This field is deprecated, and will be removed when the v1beta1 API is removed (no sooner than kubernetes v1.24).  While this field can hold values, it is not writable through the v1 API, and any attempts to write to it will be silently ignored. Topology information can be found in the zone and nodeName fields instead.

  - **endpoints.hints** (EndpointHints)

    hints contains information associated with how an endpoint should be consumed.

    *EndpointHints provides hints describing how an endpoint should be consumed.*

    - **endpoints.hints.forZones** ([]ForZone)

      *Atomic: will be replaced during a merge*

      forZones indicates the zone(s) this endpoint should be consumed by to enable topology aware routing.

      *ForZone provides information about which zones should consume this endpoint.*

      - **endpoints.hints.forZones.name** (string), required

        name represents the name of the zone.

  - **endpoints.hostname** (string)

    hostname of this endpoint. This field may be used by consumers of endpoints to distinguish endpoints from each other (e.g. in DNS names). Multiple endpoints which use the same hostname should be considered fungible (e.g. multiple A values in DNS). Must be lowercase and pass DNS Label (RFC 1123) validation.

  - **endpoints.nodeName** (string)

    nodeName represents the name of the Node hosting this endpoint. This can be used to determine endpoints local to a Node.

  - **endpoints.targetRef** (ObjectReference)

    targetRef is a reference to a Kubernetes object that represents this endpoint.

  - **endpoints.zone** (string)

    zone is the name of the Zone this endpoint exists in.

- **ports** ([]EndpointPort)

  *Atomic: will be replaced during a merge*

  ports specifies the list of network ports exposed by each endpoint in this slice. Each port must have a unique name. When ports is empty, it indicates that there are no defined ports. When a port is defined with a nil port value, it indicates "all ports". Each slice may include a maximum of 100 ports.

  *EndpointPort represents a Port used by an EndpointSlice*

  - **ports.port** (int32)

    port represents the port number of the endpoint. If this is not specified, ports are not restricted and must be interpreted in the context of the specific consumer.

  - **ports.protocol** (string)

    protocol represents the IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.

  - **ports.name** (string)

    name represents the name of this port. All ports in an EndpointSlice must have a unique name. If the EndpointSlice is derived from a Kubernetes service, this corresponds to the Service.ports[].name. Name must either be an empty string or pass DNS_LABEL validation: * must be no more than 63 characters long. * must consist of lower case alphanumeric characters or '-'. * must start and end with an alphanumeric character. Default is empty string.

  - **ports.appProtocol** (string)

    The application protocol for this port. This is used as a hint for implementations to offer richer behavior for protocols that they understand. This field follows standard Kubernetes label syntax. Valid values are either:

    * Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names).

    * Kubernetes-defined prefixed names:
      * 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-
      * 'kubernetes.io/ws'  - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
      * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455

    * Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol.

## EndpointSliceList {#EndpointSliceList}

EndpointSliceList represents a list of endpoint slices

- **apiVersion**: discovery.k8s.io/v1

- **kind**: EndpointSliceList

- **metadata** (ListMeta)

  Standard list metadata.

- **items** ([]EndpointSlice), required

  items is the list of endpoint slices

## Operations {#Operations}

### `get` read the specified EndpointSlice

#### HTTP Request

GET /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the EndpointSlice

- **namespace** (*in path*): string, required

  namespace

- **pretty** (*in query*): string

  pretty

#### Response

200 (EndpointSlice): OK

401: Unauthorized

### `list` list or watch objects of kind EndpointSlice

#### HTTP Request

GET /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices

#### Parameters

- **namespace** (*in path*): string, required

  namespace

- **allowWatchBookmarks** (*in query*): boolean

  allowWatchBookmarks

- **continue** (*in query*): string

  continue

- **fieldSelector** (*in query*): string

  fieldSelector

- **labelSelector** (*in query*): string

  labelSelector

- **limit** (*in query*): integer

  limit

- **pretty** (*in query*): string

  pretty

- **resourceVersion** (*in query*): string

  resourceVersion

- **resourceVersionMatch** (*in query*): string

  resourceVersionMatch

- **sendInitialEvents** (*in query*): boolean

  sendInitialEvents

- **timeoutSeconds** (*in query*): integer

  timeoutSeconds

- **watch** (*in query*): boolean

  watch

#### Response

200 (EndpointSliceList): OK

401: Unauthorized

### `list` list or watch objects of kind EndpointSlice

#### HTTP Request

GET /apis/discovery.k8s.io/v1/endpointslices

#### Parameters

- **allowWatchBookmarks** (*in query*): boolean

  allowWatchBookmarks

- **continue** (*in query*): string

  continue

- **fieldSelector** (*in query*): string

  fieldSelector

- **labelSelector** (*in query*): string

  labelSelector

- **limit** (*in query*): integer

  limit

- **pretty** (*in query*): string

  pretty

- **resourceVersion** (*in query*): string

  resourceVersion

- **resourceVersionMatch** (*in query*): string

  resourceVersionMatch

- **sendInitialEvents** (*in query*): boolean

  sendInitialEvents

- **timeoutSeconds** (*in query*): integer

  timeoutSeconds

- **watch** (*in query*): boolean

  watch

#### Response

200 (EndpointSliceList): OK

401: Unauthorized

### `create` create an EndpointSlice

#### HTTP Request

POST /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices

#### Parameters

- **namespace** (*in path*): string, required

  namespace

- **body**: EndpointSlice, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **pretty** (*in query*): string

  pretty

#### Response

200 (EndpointSlice): OK

201 (EndpointSlice): Created

202 (EndpointSlice): Accepted

401: Unauthorized

### `update` replace the specified EndpointSlice

#### HTTP Request

PUT /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the EndpointSlice

- **namespace** (*in path*): string, required

  namespace

- **body**: EndpointSlice, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **pretty** (*in query*): string

  pretty

#### Response

200 (EndpointSlice): OK

201 (EndpointSlice): Created

401: Unauthorized

### `patch` partially update the specified EndpointSlice

#### HTTP Request

PATCH /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the EndpointSlice

- **namespace** (*in path*): string, required

  namespace

- **body**: Patch, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **force** (*in query*): boolean

  force

- **pretty** (*in query*): string

  pretty

#### Response

200 (EndpointSlice): OK

201 (EndpointSlice): Created

401: Unauthorized

### `delete` delete an EndpointSlice

#### HTTP Request

DELETE /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the EndpointSlice

- **namespace** (*in path*): string, required

  namespace

- **body**: DeleteOptions

- **dryRun** (*in query*): string

  dryRun

- **gracePeriodSeconds** (*in query*): integer

  gracePeriodSeconds

- **pretty** (*in query*): string

  pretty

- **propagationPolicy** (*in query*): string

  propagationPolicy

#### Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

### `deletecollection` delete collection of EndpointSlice

#### HTTP Request

DELETE /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices

#### Parameters

- **namespace** (*in path*): string, required

  namespace

- **body**: DeleteOptions

- **continue** (*in query*): string

  continue

- **dryRun** (*in query*): string

  dryRun

- **fieldSelector** (*in query*): string

  fieldSelector

- **gracePeriodSeconds** (*in query*): integer

  gracePeriodSeconds

- **labelSelector** (*in query*): string

  labelSelector

- **limit** (*in query*): integer

  limit

- **pretty** (*in query*): string

  pretty

- **propagationPolicy** (*in query*): string

  propagationPolicy

- **resourceVersion** (*in query*): string

  resourceVersion

- **resourceVersionMatch** (*in query*): string

  resourceVersionMatch

- **sendInitialEvents** (*in query*): boolean

  sendInitialEvents

- **timeoutSeconds** (*in query*): integer

  timeoutSeconds

#### Response

200 (Status): OK

401: Unauthorized

api metadata    apiVersion   discovery k8s io v1    import   k8s io api discovery v1    kind   EndpointSlice  content type   api reference  description   EndpointSlice represents a subset of the endpoints that implement a service   title   EndpointSlice  weight  3 auto generated  true           The file is auto generated from the Go source code of the component using a generic  generator  https   github com kubernetes sigs reference docs    To learn how to generate the reference documentation  please read  Contributing to the reference documentation   docs contribute generate ref docs    To update the reference content  please follow the   Contributing upstream   docs contribute generate ref docs contribute upstream   guide  You can file document formatting bugs against the  reference docs  https   github com kubernetes sigs reference docs   project        apiVersion  discovery k8s io v1    import  k8s io api discovery v1        EndpointSlice   EndpointSlice   EndpointSlice represents a subset of the endpoints that implement a service  For a given service there may be multiple EndpointSlice objects  selected by labels  which must be joined to produce the full set of endpoints    hr       apiVersion    discovery k8s io v1       kind    EndpointSlice       metadata     a href    ObjectMeta  a      Standard object s metadata       addressType    string   required    addressType specifies the type of address carried by this EndpointSlice  All addresses in this slice must be the same type  This field is immutable after creation  The following address types are currently supported    IPv4  Represents an IPv4 Address    IPv6  Represents an IPv6 Address    FQDN  Represents a Fully Qualified Domain Name       endpoints      Endpoint   required     Atomic  will be replaced during a merge       endpoints is a list of unique endpoints in this slice  Each slice may include a maximum of 1000 endpoints      a name  Endpoint    a     Endpoint represents a single logical  backend  implementing a service          endpoints addresses      string   required       Set  unique values will be kept during a merge           addresses of this endpoint  The contents of this field are interpreted according to the corresponding EndpointSlice addressType field  Consumers must handle different types of addresses in the context of their own capabilities  This must contain at least one address but no more than 100  These are all assumed to be fungible and clients may choose to only use the first element  Refer to  https   issue k8s io 106267        endpoints conditions    EndpointConditions       conditions contains information about the current status of the endpoint        a name  EndpointConditions    a       EndpointConditions represents the current condition of an endpoint            endpoints conditions ready    boolean         ready indicates that this endpoint is prepared to receive traffic  according to whatever system is managing the endpoint  A nil value indicates an unknown state  In most cases consumers should interpret this unknown state as ready  For compatibility reasons  ready should never be  true  for terminating endpoints  except when the normal readiness behavior is being explicitly overridden  for example when the associated Service has set the publishNotReadyAddresses flag           endpoints conditions serving    boolean         serving is identical to ready except that it is set regardless of the terminating state of endpoints  This condition should be set to true for a ready endpoint that is terminating  If nil  consumers should defer to the ready condition           endpoints conditions terminating    boolean         terminating indicates that this endpoint is terminating  A nil value indicates an unknown state  Consumers should interpret this unknown state to mean that the endpoint is not terminating         endpoints deprecatedTopology    map string string       deprecatedTopology contains topology information part of the v1beta1 API  This field is deprecated  and will be removed when the v1beta1 API is removed  no sooner than kubernetes v1 24    While this field can hold values  it is not writable through the v1 API  and any attempts to write to it will be silently ignored  Topology information can be found in the zone and nodeName fields instead         endpoints hints    EndpointHints       hints contains information associated with how an endpoint should be consumed        a name  EndpointHints    a       EndpointHints provides hints describing how an endpoint should be consumed            endpoints hints forZones      ForZone          Atomic  will be replaced during a merge               forZones indicates the zone s  this endpoint should be consumed by to enable topology aware routing          a name  ForZone    a         ForZone provides information about which zones should consume this endpoint              endpoints hints forZones name    string   required          name represents the name of the zone         endpoints hostname    string       hostname of this endpoint  This field may be used by consumers of endpoints to distinguish endpoints from each other  e g  in DNS names   Multiple endpoints which use the same hostname should be considered fungible  e g  multiple A values in DNS   Must be lowercase and pass DNS Label  RFC 1123  validation         endpoints nodeName    string       nodeName represents the name of the Node hosting this endpoint  This can be used to determine endpoints local to a Node         endpoints targetRef     a href    ObjectReference  a        targetRef is a reference to a Kubernetes object that represents this endpoint         endpoints zone    string       zone is the name of the Zone this endpoint exists in       ports      EndpointPort      Atomic  will be replaced during a merge       ports specifies the list of network ports exposed by each endpoint in this slice  Each port must have a unique name  When ports is empty  it indicates that there are no defined ports  When a port is defined with a nil port value  it indicates  all ports   Each slice may include a maximum of 100 ports      a name  EndpointPort    a     EndpointPort represents a Port used by an EndpointSlice         ports port    int32       port represents the port number of the endpoint  If this is not specified  ports are not restricted and must be interpreted in the context of the specific consumer         ports protocol    string       protocol represents the IP protocol for this port  Must be UDP  TCP  or SCTP  Default is TCP         ports name    string       name represents the name of this port  All ports in an EndpointSlice must have a unique name  If the EndpointSlice is derived from a Kubernetes service  this corresponds to the Service ports   name  Name must either be an empty string or pass DNS LABEL validation    must be no more than 63 characters long    must consist of lower case alphanumeric characters or        must start and end with an alphanumeric character  Default is empty string         ports appProtocol    string       The application protocol for this port  This is used as a hint for implementations to offer richer behavior for protocols that they understand  This field follows standard Kubernetes label syntax  Valid values are either             Un prefixed protocol names   reserved for IANA standard service names  as per RFC 6335 and https   www iana org assignments service names              Kubernetes defined prefixed names           kubernetes io h2c    HTTP 2 prior knowledge over cleartext as described in https   www rfc editor org rfc rfc9113 html name starting http 2 with prior           kubernetes io ws     WebSocket over cleartext as described in https   www rfc editor org rfc rfc6455          kubernetes io wss    WebSocket over TLS as described in https   www rfc editor org rfc rfc6455            Other protocols should use implementation defined prefixed names such as mycompany com my custom protocol          EndpointSliceList   EndpointSliceList   EndpointSliceList represents a list of endpoint slices   hr       apiVersion    discovery k8s io v1       kind    EndpointSliceList       metadata     a href    ListMeta  a      Standard list metadata       items       a href    EndpointSlice  a    required    items is the list of endpoint slices         Operations   Operations      hr             get  read the specified EndpointSlice       HTTP Request  GET  apis discovery k8s io v1 namespaces  namespace  endpointslices  name        Parameters       name     in path    string  required    name of the EndpointSlice       namespace     in path    string  required     a href    namespace  a        pretty     in query    string     a href    pretty  a          Response   200   a href    EndpointSlice  a    OK  401  Unauthorized        list  list or watch objects of kind EndpointSlice       HTTP Request  GET  apis discovery k8s io v1 namespaces  namespace  endpointslices       Parameters       namespace     in path    string  required     a href    namespace  a        allowWatchBookmarks     in query    boolean     a href    allowWatchBookmarks  a        continue     in query    string     a href    continue  a        fieldSelector     in query    string     a href    fieldSelector  a        labelSelector     in query    string     a href    labelSelector  a        limit     in query    integer     a href    limit  a        pretty     in query    string     a href    pretty  a        resourceVersion     in query    string     a href    resourceVersion  a        resourceVersionMatch     in query    string     a href    resourceVersionMatch  a        sendInitialEvents     in query    boolean     a href    sendInitialEvents  a        timeoutSeconds     in query    integer     a href    timeoutSeconds  a        watch     in query    boolean     a href    watch  a          Response   200   a href    EndpointSliceList  a    OK  401  Unauthorized        list  list or watch objects of kind EndpointSlice       HTTP Request  GET  apis discovery k8s io v1 endpointslices       Parameters       allowWatchBookmarks     in query    boolean     a href    allowWatchBookmarks  a        continue     in query    string     a href    continue  a        fieldSelector     in query    string     a href    fieldSelector  a        labelSelector     in query    string     a href    labelSelector  a        limit     in query    integer     a href    limit  a        pretty     in query    string     a href    pretty  a        resourceVersion     in query    string     a href    resourceVersion  a        resourceVersionMatch     in query    string     a href    resourceVersionMatch  a        sendInitialEvents     in query    boolean     a href    sendInitialEvents  a        timeoutSeconds     in query    integer     a href    timeoutSeconds  a        watch     in query    boolean     a href    watch  a          Response   200   a href    EndpointSliceList  a    OK  401  Unauthorized        create  create an EndpointSlice       HTTP Request  POST  apis discovery k8s io v1 namespaces  namespace  endpointslices       Parameters       namespace     in path    string  required     a href    namespace  a        body     a href    EndpointSlice  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        pretty     in query    string     a href    pretty  a          Response   200   a href    EndpointSlice  a    OK  201   a href    EndpointSlice  a    Created  202   a href    EndpointSlice  a    Accepted  401  Unauthorized        update  replace the specified EndpointSlice       HTTP Request  PUT  apis discovery k8s io v1 namespaces  namespace  endpointslices  name        Parameters       name     in path    string  required    name of the EndpointSlice       namespace     in path    string  required     a href    namespace  a        body     a href    EndpointSlice  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        pretty     in query    string     a href    pretty  a          Response   200   a href    EndpointSlice  a    OK  201   a href    EndpointSlice  a    Created  401  Unauthorized        patch  partially update the specified EndpointSlice       HTTP Request  PATCH  apis discovery k8s io v1 namespaces  namespace  endpointslices  name        Parameters       name     in path    string  required    name of the EndpointSlice       namespace     in path    string  required     a href    namespace  a        body     a href    Patch  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        force     in query    boolean     a href    force  a        pretty     in query    string     a href    pretty  a          Response   200   a href    EndpointSlice  a    OK  201   a href    EndpointSlice  a    Created  401  Unauthorized        delete  delete an EndpointSlice       HTTP Request  DELETE  apis discovery k8s io v1 namespaces  namespace  endpointslices  name        Parameters       name     in path    string  required    name of the EndpointSlice       namespace     in path    string  required     a href    namespace  a        body     a href    DeleteOptions  a            dryRun     in query    string     a href    dryRun  a        gracePeriodSeconds     in query    integer     a href    gracePeriodSeconds  a        pretty     in query    string     a href    pretty  a        propagationPolicy     in query    string     a href    propagationPolicy  a          Response   200   a href    Status  a    OK  202   a href    Status  a    Accepted  401  Unauthorized        deletecollection  delete collection of EndpointSlice       HTTP Request  DELETE  apis discovery k8s io v1 namespaces  namespace  endpointslices       Parameters       namespace     in path    string  required     a href    namespace  a        body     a href    DeleteOptions  a            continue     in query    string     a href    continue  a        dryRun     in query    string     a href    dryRun  a        fieldSelector     in query    string     a href    fieldSelector  a        gracePeriodSeconds     in query    integer     a href    gracePeriodSeconds  a        labelSelector     in query    string     a href    labelSelector  a        limit     in query    integer     a href    limit  a        pretty     in query    string     a href    pretty  a        propagationPolicy     in query    string     a href    propagationPolicy  a        resourceVersion     in query    string     a href    resourceVersion  a        resourceVersionMatch     in query    string     a href    resourceVersionMatch  a        sendInitialEvents     in query    boolean     a href    sendInitialEvents  a        timeoutSeconds     in query    integer     a href    timeoutSeconds  a          Response   200   a href    Status  a    OK  401  Unauthorized


kubernetes reference apiVersion v1 kind Endpoints weight 2 Endpoints is a collection of endpoints that implement the actual service contenttype apireference apimetadata title Endpoints autogenerated true import k8s io api core v1

Answer:
---
api_metadata:
  apiVersion: "v1"
  import: "k8s.io/api/core/v1"
  kind: "Endpoints"
content_type: "api_reference"
description: "Endpoints is a collection of endpoints that implement the actual service."
title: "Endpoints"
weight: 2
auto_generated: true
---

`apiVersion: v1`

`import "k8s.io/api/core/v1"`

## Endpoints {#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}]
     },
  ]

- **apiVersion**: v1

- **kind**: Endpoints

- **metadata** (ObjectMeta)

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

- **subsets** ([]EndpointSubset)

  *Atomic: will be replaced during a merge*

  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.

  *EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given:

  	{
  	  Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
  	  Ports:     [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
  	}

  The resulting set of endpoints can be viewed as:

  	a: [ 10.10.1.1:8675, 10.10.2.2:8675 ],
  	b: [ 10.10.1.1:309, 10.10.2.2:309 ]*

  - **subsets.addresses** ([]EndpointAddress)

    *Atomic: will be replaced during a merge*

    IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize.

    *EndpointAddress is a tuple that describes single IP address.*

    - **subsets.addresses.ip** (string), required

      The IP of this endpoint. May not be loopback (127.0.0.0/8 or ::1), link-local (169.254.0.0/16 or fe80::/10), or link-local multicast (224.0.0.0/24 or ff02::/16).

    - **subsets.addresses.hostname** (string)

      The Hostname of this endpoint

    - **subsets.addresses.nodeName** (string)

      Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.

    - **subsets.addresses.targetRef** (ObjectReference)

      Reference to object providing the endpoint.

  - **subsets.notReadyAddresses** ([]EndpointAddress)

    *Atomic: will be replaced during a merge*

    IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check.

    *EndpointAddress is a tuple that describes single IP address.*

    - **subsets.notReadyAddresses.ip** (string), required

      The IP of this endpoint. May not be loopback (127.0.0.0/8 or ::1), link-local (169.254.0.0/16 or fe80::/10), or link-local multicast (224.0.0.0/24 or ff02::/16).

    - **subsets.notReadyAddresses.hostname** (string)

      The Hostname of this endpoint

    - **subsets.notReadyAddresses.nodeName** (string)

      Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.

    - **subsets.notReadyAddresses.targetRef** (ObjectReference)

      Reference to object providing the endpoint.

  - **subsets.ports** ([]EndpointPort)

    *Atomic: will be replaced during a merge*

    Port numbers available on the related IP addresses.

    *EndpointPort is a tuple that describes a single port.*

    - **subsets.ports.port** (int32), required

      The port number of the endpoint.

    - **subsets.ports.protocol** (string)

      The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.

    - **subsets.ports.name** (string)

      The name of this port.  This must match the 'name' field in the corresponding ServicePort. Must be a DNS_LABEL. Optional only if one port is defined.

    - **subsets.ports.appProtocol** (string)

      The application protocol for this port. This is used as a hint for implementations to offer richer behavior for protocols that they understand. This field follows standard Kubernetes label syntax. Valid values are either:

      * Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names).

      * Kubernetes-defined prefixed names:
        * 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-
        * 'kubernetes.io/ws'  - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
        * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455

      * Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol.

## EndpointsList {#EndpointsList}

EndpointsList is a list of endpoints.

- **apiVersion**: v1

- **kind**: EndpointsList

- **metadata** (ListMeta)

  Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

- **items** ([]Endpoints), required

  List of endpoints.

## Operations {#Operations}

### `get` read the specified Endpoints

#### HTTP Request

GET /api/v1/namespaces/{namespace}/endpoints/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the Endpoints

- **namespace** (*in path*): string, required

  namespace

- **pretty** (*in query*): string

  pretty

#### Response

200 (Endpoints): OK

401: Unauthorized

### `list` list or watch objects of kind Endpoints

#### HTTP Request

GET /api/v1/namespaces/{namespace}/endpoints

#### Parameters

- **namespace** (*in path*): string, required

  namespace

- **allowWatchBookmarks** (*in query*): boolean

  allowWatchBookmarks

- **continue** (*in query*): string

  continue

- **fieldSelector** (*in query*): string

  fieldSelector

- **labelSelector** (*in query*): string

  labelSelector

- **limit** (*in query*): integer

  limit

- **pretty** (*in query*): string

  pretty

- **resourceVersion** (*in query*): string

  resourceVersion

- **resourceVersionMatch** (*in query*): string

  resourceVersionMatch

- **sendInitialEvents** (*in query*): boolean

  sendInitialEvents

- **timeoutSeconds** (*in query*): integer

  timeoutSeconds

- **watch** (*in query*): boolean

  watch

#### Response

200 (EndpointsList): OK

401: Unauthorized

### `list` list or watch objects of kind Endpoints

#### HTTP Request

GET /api/v1/endpoints

#### Parameters

- **allowWatchBookmarks** (*in query*): boolean

  allowWatchBookmarks

- **continue** (*in query*): string

  continue

- **fieldSelector** (*in query*): string

  fieldSelector

- **labelSelector** (*in query*): string

  labelSelector

- **limit** (*in query*): integer

  limit

- **pretty** (*in query*): string

  pretty

- **resourceVersion** (*in query*): string

  resourceVersion

- **resourceVersionMatch** (*in query*): string

  resourceVersionMatch

- **sendInitialEvents** (*in query*): boolean

  sendInitialEvents

- **timeoutSeconds** (*in query*): integer

  timeoutSeconds

- **watch** (*in query*): boolean

  watch

#### Response

200 (EndpointsList): OK

401: Unauthorized

### `create` create Endpoints

#### HTTP Request

POST /api/v1/namespaces/{namespace}/endpoints

#### Parameters

- **namespace** (*in path*): string, required

  namespace

- **body**: Endpoints, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **pretty** (*in query*): string

  pretty

#### Response

200 (Endpoints): OK

201 (Endpoints): Created

202 (Endpoints): Accepted

401: Unauthorized

### `update` replace the specified Endpoints

#### HTTP Request

PUT /api/v1/namespaces/{namespace}/endpoints/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the Endpoints

- **namespace** (*in path*): string, required

  namespace

- **body**: Endpoints, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **pretty** (*in query*): string

  pretty

#### Response

200 (Endpoints): OK

201 (Endpoints): Created

401: Unauthorized

### `patch` partially update the specified Endpoints

#### HTTP Request

PATCH /api/v1/namespaces/{namespace}/endpoints/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the Endpoints

- **namespace** (*in path*): string, required

  namespace

- **body**: Patch, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **force** (*in query*): boolean

  force

- **pretty** (*in query*): string

  pretty

#### Response

200 (Endpoints): OK

201 (Endpoints): Created

401: Unauthorized

### `delete` delete Endpoints

#### HTTP Request

DELETE /api/v1/namespaces/{namespace}/endpoints/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the Endpoints

- **namespace** (*in path*): string, required

  namespace

- **body**: DeleteOptions

- **dryRun** (*in query*): string

  dryRun

- **gracePeriodSeconds** (*in query*): integer

  gracePeriodSeconds

- **pretty** (*in query*): string

  pretty

- **propagationPolicy** (*in query*): string

  propagationPolicy

#### Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

### `deletecollection` delete collection of Endpoints

#### HTTP Request

DELETE /api/v1/namespaces/{namespace}/endpoints

#### Parameters

- **namespace** (*in path*): string, required

  namespace

- **body**: DeleteOptions

- **continue** (*in query*): string

  continue

- **dryRun** (*in query*): string

  dryRun

- **fieldSelector** (*in query*): string

  fieldSelector

- **gracePeriodSeconds** (*in query*): integer

  gracePeriodSeconds

- **labelSelector** (*in query*): string

  labelSelector

- **limit** (*in query*): integer

  limit

- **pretty** (*in query*): string

  pretty

- **propagationPolicy** (*in query*): string

  propagationPolicy

- **resourceVersion** (*in query*): string

  resourceVersion

- **resourceVersionMatch** (*in query*): string

  resourceVersionMatch

- **sendInitialEvents** (*in query*): boolean

  sendInitialEvents

- **timeoutSeconds** (*in query*): integer

  timeoutSeconds

#### Response

200 (Status): OK

401: Unauthorized

api metadata    apiVersion   v1    import   k8s io api core v1    kind   Endpoints  content type   api reference  description   Endpoints is a collection of endpoints that implement the actual service   title   Endpoints  weight  2 auto generated  true           The file is auto generated from the Go source code of the component using a generic  generator  https   github com kubernetes sigs reference docs    To learn how to generate the reference documentation  please read  Contributing to the reference documentation   docs contribute generate ref docs    To update the reference content  please follow the   Contributing upstream   docs contribute generate ref docs contribute upstream   guide  You can file document formatting bugs against the  reference docs  https   github com kubernetes sigs reference docs   project        apiVersion  v1    import  k8s io api core v1        Endpoints   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                 hr       apiVersion    v1       kind    Endpoints       metadata     a href    ObjectMeta  a      Standard object s metadata  More info  https   git k8s io community contributors devel sig architecture api conventions md metadata      subsets      EndpointSubset      Atomic  will be replaced during a merge       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      a name  EndpointSubset    a     EndpointSubset is a group of addresses with a common set of ports  The expanded set of endpoints is the Cartesian product of Addresses x Ports  For example  given               Addresses     ip    10 10 1 1      ip    10 10 2 2          Ports         name    a    port   8675     name    b    port   309             The resulting set of endpoints can be viewed as        a    10 10 1 1 8675  10 10 2 2 8675       b    10 10 1 1 309  10 10 2 2 309           subsets addresses      EndpointAddress        Atomic  will be replaced during a merge           IP addresses which offer the related ports that are marked as ready  These endpoints should be considered safe for load balancers and clients to utilize        a name  EndpointAddress    a       EndpointAddress is a tuple that describes single IP address            subsets addresses ip    string   required        The IP of this endpoint  May not be loopback  127 0 0 0 8 or   1   link local  169 254 0 0 16 or fe80   10   or link local multicast  224 0 0 0 24 or ff02   16            subsets addresses hostname    string         The Hostname of this endpoint          subsets addresses nodeName    string         Optional  Node hosting this endpoint  This can be used to determine endpoints local to a node           subsets addresses targetRef     a href    ObjectReference  a          Reference to object providing the endpoint         subsets notReadyAddresses      EndpointAddress        Atomic  will be replaced during a merge           IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting  have recently failed a readiness check  or have recently failed a liveness check        a name  EndpointAddress    a       EndpointAddress is a tuple that describes single IP address            subsets notReadyAddresses ip    string   required        The IP of this endpoint  May not be loopback  127 0 0 0 8 or   1   link local  169 254 0 0 16 or fe80   10   or link local multicast  224 0 0 0 24 or ff02   16            subsets notReadyAddresses hostname    string         The Hostname of this endpoint          subsets notReadyAddresses nodeName    string         Optional  Node hosting this endpoint  This can be used to determine endpoints local to a node           subsets notReadyAddresses targetRef     a href    ObjectReference  a          Reference to object providing the endpoint         subsets ports      EndpointPort        Atomic  will be replaced during a merge           Port numbers available on the related IP addresses        a name  EndpointPort    a       EndpointPort is a tuple that describes a single port            subsets ports port    int32   required        The port number of the endpoint           subsets ports protocol    string         The IP protocol for this port  Must be UDP  TCP  or SCTP  Default is TCP           subsets ports name    string         The name of this port   This must match the  name  field in the corresponding ServicePort  Must be a DNS LABEL  Optional only if one port is defined           subsets ports appProtocol    string         The application protocol for this port  This is used as a hint for implementations to offer richer behavior for protocols that they understand  This field follows standard Kubernetes label syntax  Valid values are either                 Un prefixed protocol names   reserved for IANA standard service names  as per RFC 6335 and https   www iana org assignments service names                  Kubernetes defined prefixed names             kubernetes io h2c    HTTP 2 prior knowledge over cleartext as described in https   www rfc editor org rfc rfc9113 html name starting http 2 with prior             kubernetes io ws     WebSocket over cleartext as described in https   www rfc editor org rfc rfc6455            kubernetes io wss    WebSocket over TLS as described in https   www rfc editor org rfc rfc6455                Other protocols should use implementation defined prefixed names such as mycompany com my custom protocol          EndpointsList   EndpointsList   EndpointsList is a list of endpoints    hr       apiVersion    v1       kind    EndpointsList       metadata     a href    ListMeta  a      Standard list metadata  More info  https   git k8s io community contributors devel sig architecture api conventions md types kinds      items       a href    Endpoints  a    required    List of endpoints          Operations   Operations      hr             get  read the specified Endpoints       HTTP Request  GET  api v1 namespaces  namespace  endpoints  name        Parameters       name     in path    string  required    name of the Endpoints       namespace     in path    string  required     a href    namespace  a        pretty     in query    string     a href    pretty  a          Response   200   a href    Endpoints  a    OK  401  Unauthorized        list  list or watch objects of kind Endpoints       HTTP Request  GET  api v1 namespaces  namespace  endpoints       Parameters       namespace     in path    string  required     a href    namespace  a        allowWatchBookmarks     in query    boolean     a href    allowWatchBookmarks  a        continue     in query    string     a href    continue  a        fieldSelector     in query    string     a href    fieldSelector  a        labelSelector     in query    string     a href    labelSelector  a        limit     in query    integer     a href    limit  a        pretty     in query    string     a href    pretty  a        resourceVersion     in query    string     a href    resourceVersion  a        resourceVersionMatch     in query    string     a href    resourceVersionMatch  a        sendInitialEvents     in query    boolean     a href    sendInitialEvents  a        timeoutSeconds     in query    integer     a href    timeoutSeconds  a        watch     in query    boolean     a href    watch  a          Response   200   a href    EndpointsList  a    OK  401  Unauthorized        list  list or watch objects of kind Endpoints       HTTP Request  GET  api v1 endpoints       Parameters       allowWatchBookmarks     in query    boolean     a href    allowWatchBookmarks  a        continue     in query    string     a href    continue  a        fieldSelector     in query    string     a href    fieldSelector  a        labelSelector     in query    string     a href    labelSelector  a        limit     in query    integer     a href    limit  a        pretty     in query    string     a href    pretty  a        resourceVersion     in query    string     a href    resourceVersion  a        resourceVersionMatch     in query    string     a href    resourceVersionMatch  a        sendInitialEvents     in query    boolean     a href    sendInitialEvents  a        timeoutSeconds     in query    integer     a href    timeoutSeconds  a        watch     in query    boolean     a href    watch  a          Response   200   a href    EndpointsList  a    OK  401  Unauthorized        create  create Endpoints       HTTP Request  POST  api v1 namespaces  namespace  endpoints       Parameters       namespace     in path    string  required     a href    namespace  a        body     a href    Endpoints  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        pretty     in query    string     a href    pretty  a          Response   200   a href    Endpoints  a    OK  201   a href    Endpoints  a    Created  202   a href    Endpoints  a    Accepted  401  Unauthorized        update  replace the specified Endpoints       HTTP Request  PUT  api v1 namespaces  namespace  endpoints  name        Parameters       name     in path    string  required    name of the Endpoints       namespace     in path    string  required     a href    namespace  a        body     a href    Endpoints  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        pretty     in query    string     a href    pretty  a          Response   200   a href    Endpoints  a    OK  201   a href    Endpoints  a    Created  401  Unauthorized        patch  partially update the specified Endpoints       HTTP Request  PATCH  api v1 namespaces  namespace  endpoints  name        Parameters       name     in path    string  required    name of the Endpoints       namespace     in path    string  required     a href    namespace  a        body     a href    Patch  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        force     in query    boolean     a href    force  a        pretty     in query    string     a href    pretty  a          Response   200   a href    Endpoints  a    OK  201   a href    Endpoints  a    Created  401  Unauthorized        delete  delete Endpoints       HTTP Request  DELETE  api v1 namespaces  namespace  endpoints  name        Parameters       name     in path    string  required    name of the Endpoints       namespace     in path    string  required     a href    namespace  a        body     a href    DeleteOptions  a            dryRun     in query    string     a href    dryRun  a        gracePeriodSeconds     in query    integer     a href    gracePeriodSeconds  a        pretty     in query    string     a href    pretty  a        propagationPolicy     in query    string     a href    propagationPolicy  a          Response   200   a href    Status  a    OK  202   a href    Status  a    Accepted  401  Unauthorized        deletecollection  delete collection of Endpoints       HTTP Request  DELETE  api v1 namespaces  namespace  endpoints       Parameters       namespace     in path    string  required     a href    namespace  a        body     a href    DeleteOptions  a            continue     in query    string     a href    continue  a        dryRun     in query    string     a href    dryRun  a        fieldSelector     in query    string     a href    fieldSelector  a        gracePeriodSeconds     in query    integer     a href    gracePeriodSeconds  a        labelSelector     in query    string     a href    labelSelector  a        limit     in query    integer     a href    limit  a        pretty     in query    string     a href    pretty  a        propagationPolicy     in query    string     a href    propagationPolicy  a        resourceVersion     in query    string     a href    resourceVersion  a        resourceVersionMatch     in query    string     a href    resourceVersionMatch  a        sendInitialEvents     in query    boolean     a href    sendInitialEvents  a        timeoutSeconds     in query    integer     a href    timeoutSeconds  a          Response   200   a href    Status  a    OK  401  Unauthorized


kubernetes reference weight 5 kind IngressClass IngressClass represents the class of the Ingress referenced by the Ingress Spec contenttype apireference apimetadata title IngressClass autogenerated true import k8s io api networking v1 apiVersion networking k8s io v1

Answer:
---
api_metadata:
  apiVersion: "networking.k8s.io/v1"
  import: "k8s.io/api/networking/v1"
  kind: "IngressClass"
content_type: "api_reference"
description: "IngressClass represents the class of the Ingress, referenced by the Ingress Spec."
title: "IngressClass"
weight: 5
auto_generated: true
---

`apiVersion: networking.k8s.io/v1`

`import "k8s.io/api/networking/v1"`

## IngressClass {#IngressClass}

IngressClass represents the class of the Ingress, referenced by the Ingress Spec. The `ingressclass.kubernetes.io/is-default-class` annotation can be used to indicate that an IngressClass should be considered default. When a single IngressClass resource has this annotation set to true, new Ingress resources without a class specified will be assigned this default class.

- **apiVersion**: networking.k8s.io/v1

- **kind**: IngressClass

- **metadata** (ObjectMeta)

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

- **spec** (IngressClassSpec)

  spec is the desired state of the IngressClass. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

## IngressClassSpec {#IngressClassSpec}

IngressClassSpec provides information about the class of an Ingress.

- **controller** (string)

  controller refers to the name of the controller that should handle this class. This allows for different "flavors" that are controlled by the same controller. For example, you may have different parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. "acme.io/ingress-controller". This field is immutable.

- **parameters** (IngressClassParametersReference)

  parameters is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters.

  *IngressClassParametersReference identifies an API object. This can be used to specify a cluster or namespace-scoped resource.*

  - **parameters.kind** (string), required

    kind is the type of resource being referenced.

  - **parameters.name** (string), required

    name is the name of resource being referenced.

  - **parameters.apiGroup** (string)

    apiGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

  - **parameters.namespace** (string)

    namespace is the namespace of the resource being referenced. This field is required when scope is set to "Namespace" and must be unset when scope is set to "Cluster".

  - **parameters.scope** (string)

    scope represents if this refers to a cluster or namespace scoped resource. This may be set to "Cluster" (default) or "Namespace".

## IngressClassList {#IngressClassList}

IngressClassList is a collection of IngressClasses.

- **apiVersion**: networking.k8s.io/v1

- **kind**: IngressClassList

- **metadata** (ListMeta)

  Standard list metadata.

- **items** ([]IngressClass), required

  items is the list of IngressClasses.

## Operations {#Operations}

### `get` read the specified IngressClass

#### HTTP Request

GET /apis/networking.k8s.io/v1/ingressclasses/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the IngressClass

- **pretty** (*in query*): string

  pretty

#### Response

200 (IngressClass): OK

401: Unauthorized

### `list` list or watch objects of kind IngressClass

#### HTTP Request

GET /apis/networking.k8s.io/v1/ingressclasses

#### Parameters

- **allowWatchBookmarks** (*in query*): boolean

  allowWatchBookmarks

- **continue** (*in query*): string

  continue

- **fieldSelector** (*in query*): string

  fieldSelector

- **labelSelector** (*in query*): string

  labelSelector

- **limit** (*in query*): integer

  limit

- **pretty** (*in query*): string

  pretty

- **resourceVersion** (*in query*): string

  resourceVersion

- **resourceVersionMatch** (*in query*): string

  resourceVersionMatch

- **sendInitialEvents** (*in query*): boolean

  sendInitialEvents

- **timeoutSeconds** (*in query*): integer

  timeoutSeconds

- **watch** (*in query*): boolean

  watch

#### Response

200 (IngressClassList): OK

401: Unauthorized

### `create` create an IngressClass

#### HTTP Request

POST /apis/networking.k8s.io/v1/ingressclasses

#### Parameters

- **body**: IngressClass, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **pretty** (*in query*): string

  pretty

#### Response

200 (IngressClass): OK

201 (IngressClass): Created

202 (IngressClass): Accepted

401: Unauthorized

### `update` replace the specified IngressClass

#### HTTP Request

PUT /apis/networking.k8s.io/v1/ingressclasses/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the IngressClass

- **body**: IngressClass, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **pretty** (*in query*): string

  pretty

#### Response

200 (IngressClass): OK

201 (IngressClass): Created

401: Unauthorized

### `patch` partially update the specified IngressClass

#### HTTP Request

PATCH /apis/networking.k8s.io/v1/ingressclasses/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the IngressClass

- **body**: Patch, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **force** (*in query*): boolean

  force

- **pretty** (*in query*): string

  pretty

#### Response

200 (IngressClass): OK

201 (IngressClass): Created

401: Unauthorized

### `delete` delete an IngressClass

#### HTTP Request

DELETE /apis/networking.k8s.io/v1/ingressclasses/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the IngressClass

- **body**: DeleteOptions

- **dryRun** (*in query*): string

  dryRun

- **gracePeriodSeconds** (*in query*): integer

  gracePeriodSeconds

- **pretty** (*in query*): string

  pretty

- **propagationPolicy** (*in query*): string

  propagationPolicy

#### Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

### `deletecollection` delete collection of IngressClass

#### HTTP Request

DELETE /apis/networking.k8s.io/v1/ingressclasses

#### Parameters

- **body**: DeleteOptions

- **continue** (*in query*): string

  continue

- **dryRun** (*in query*): string

  dryRun

- **fieldSelector** (*in query*): string

  fieldSelector

- **gracePeriodSeconds** (*in query*): integer

  gracePeriodSeconds

- **labelSelector** (*in query*): string

  labelSelector

- **limit** (*in query*): integer

  limit

- **pretty** (*in query*): string

  pretty

- **propagationPolicy** (*in query*): string

  propagationPolicy

- **resourceVersion** (*in query*): string

  resourceVersion

- **resourceVersionMatch** (*in query*): string

  resourceVersionMatch

- **sendInitialEvents** (*in query*): boolean

  sendInitialEvents

- **timeoutSeconds** (*in query*): integer

  timeoutSeconds

#### Response

200 (Status): OK

401: Unauthorized

api metadata    apiVersion   networking k8s io v1    import   k8s io api networking v1    kind   IngressClass  content type   api reference  description   IngressClass represents the class of the Ingress  referenced by the Ingress Spec   title   IngressClass  weight  5 auto generated  true           The file is auto generated from the Go source code of the component using a generic  generator  https   github com kubernetes sigs reference docs    To learn how to generate the reference documentation  please read  Contributing to the reference documentation   docs contribute generate ref docs    To update the reference content  please follow the   Contributing upstream   docs contribute generate ref docs contribute upstream   guide  You can file document formatting bugs against the  reference docs  https   github com kubernetes sigs reference docs   project        apiVersion  networking k8s io v1    import  k8s io api networking v1        IngressClass   IngressClass   IngressClass represents the class of the Ingress  referenced by the Ingress Spec  The  ingressclass kubernetes io is default class  annotation can be used to indicate that an IngressClass should be considered default  When a single IngressClass resource has this annotation set to true  new Ingress resources without a class specified will be assigned this default class    hr       apiVersion    networking k8s io v1       kind    IngressClass       metadata     a href    ObjectMeta  a      Standard object s metadata  More info  https   git k8s io community contributors devel sig architecture api conventions md metadata      spec     a href    IngressClassSpec  a      spec is the desired state of the IngressClass  More info  https   git k8s io community contributors devel sig architecture api conventions md spec and status         IngressClassSpec   IngressClassSpec   IngressClassSpec provides information about the class of an Ingress    hr       controller    string     controller refers to the name of the controller that should handle this class  This allows for different  flavors  that are controlled by the same controller  For example  you may have different parameters for the same implementing controller  This should be specified as a domain prefixed path no more than 250 characters in length  e g   acme io ingress controller   This field is immutable       parameters    IngressClassParametersReference     parameters is a link to a custom resource containing additional configuration for the controller  This is optional if the controller does not require extra parameters      a name  IngressClassParametersReference    a     IngressClassParametersReference identifies an API object  This can be used to specify a cluster or namespace scoped resource          parameters kind    string   required      kind is the type of resource being referenced         parameters name    string   required      name is the name of resource being referenced         parameters apiGroup    string       apiGroup is the group for the resource being referenced  If APIGroup is not specified  the specified Kind must be in the core API group  For any other third party types  APIGroup is required         parameters namespace    string       namespace is the namespace of the resource being referenced  This field is required when scope is set to  Namespace  and must be unset when scope is set to  Cluster          parameters scope    string       scope represents if this refers to a cluster or namespace scoped resource  This may be set to  Cluster   default  or  Namespace           IngressClassList   IngressClassList   IngressClassList is a collection of IngressClasses    hr       apiVersion    networking k8s io v1       kind    IngressClassList       metadata     a href    ListMeta  a      Standard list metadata       items       a href    IngressClass  a    required    items is the list of IngressClasses          Operations   Operations      hr             get  read the specified IngressClass       HTTP Request  GET  apis networking k8s io v1 ingressclasses  name        Parameters       name     in path    string  required    name of the IngressClass       pretty     in query    string     a href    pretty  a          Response   200   a href    IngressClass  a    OK  401  Unauthorized        list  list or watch objects of kind IngressClass       HTTP Request  GET  apis networking k8s io v1 ingressclasses       Parameters       allowWatchBookmarks     in query    boolean     a href    allowWatchBookmarks  a        continue     in query    string     a href    continue  a        fieldSelector     in query    string     a href    fieldSelector  a        labelSelector     in query    string     a href    labelSelector  a        limit     in query    integer     a href    limit  a        pretty     in query    string     a href    pretty  a        resourceVersion     in query    string     a href    resourceVersion  a        resourceVersionMatch     in query    string     a href    resourceVersionMatch  a        sendInitialEvents     in query    boolean     a href    sendInitialEvents  a        timeoutSeconds     in query    integer     a href    timeoutSeconds  a        watch     in query    boolean     a href    watch  a          Response   200   a href    IngressClassList  a    OK  401  Unauthorized        create  create an IngressClass       HTTP Request  POST  apis networking k8s io v1 ingressclasses       Parameters       body     a href    IngressClass  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        pretty     in query    string     a href    pretty  a          Response   200   a href    IngressClass  a    OK  201   a href    IngressClass  a    Created  202   a href    IngressClass  a    Accepted  401  Unauthorized        update  replace the specified IngressClass       HTTP Request  PUT  apis networking k8s io v1 ingressclasses  name        Parameters       name     in path    string  required    name of the IngressClass       body     a href    IngressClass  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        pretty     in query    string     a href    pretty  a          Response   200   a href    IngressClass  a    OK  201   a href    IngressClass  a    Created  401  Unauthorized        patch  partially update the specified IngressClass       HTTP Request  PATCH  apis networking k8s io v1 ingressclasses  name        Parameters       name     in path    string  required    name of the IngressClass       body     a href    Patch  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        force     in query    boolean     a href    force  a        pretty     in query    string     a href    pretty  a          Response   200   a href    IngressClass  a    OK  201   a href    IngressClass  a    Created  401  Unauthorized        delete  delete an IngressClass       HTTP Request  DELETE  apis networking k8s io v1 ingressclasses  name        Parameters       name     in path    string  required    name of the IngressClass       body     a href    DeleteOptions  a            dryRun     in query    string     a href    dryRun  a        gracePeriodSeconds     in query    integer     a href    gracePeriodSeconds  a        pretty     in query    string     a href    pretty  a        propagationPolicy     in query    string     a href    propagationPolicy  a          Response   200   a href    Status  a    OK  202   a href    Status  a    Accepted  401  Unauthorized        deletecollection  delete collection of IngressClass       HTTP Request  DELETE  apis networking k8s io v1 ingressclasses       Parameters       body     a href    DeleteOptions  a            continue     in query    string     a href    continue  a        dryRun     in query    string     a href    dryRun  a        fieldSelector     in query    string     a href    fieldSelector  a        gracePeriodSeconds     in query    integer     a href    gracePeriodSeconds  a        labelSelector     in query    string     a href    labelSelector  a        limit     in query    integer     a href    limit  a        pretty     in query    string     a href    pretty  a        propagationPolicy     in query    string     a href    propagationPolicy  a        resourceVersion     in query    string     a href    resourceVersion  a        resourceVersionMatch     in query    string     a href    resourceVersionMatch  a        sendInitialEvents     in query    boolean     a href    sendInitialEvents  a        timeoutSeconds     in query    integer     a href    timeoutSeconds  a          Response   200   a href    Status  a    OK  401  Unauthorized