kubernetes reference import k8s io api networking v1beta1 IPAddress represents a single IP of a single IP Family contenttype apireference title IPAddress v1beta1 apiVersion networking k8s io v1beta1 apimetadata kind IPAddress weight 4 autogenerated true

Answer:
---
api_metadata:
  apiVersion: "networking.k8s.io/v1beta1"
  import: "k8s.io/api/networking/v1beta1"
  kind: "IPAddress"
content_type: "api_reference"
description: "IPAddress represents a single IP of a single IP Family."
title: "IPAddress v1beta1"
weight: 4
auto_generated: true
---

`apiVersion: networking.k8s.io/v1beta1`

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

## IPAddress {#IPAddress}

IPAddress represents a single IP of a single IP Family. The object is designed to be used by APIs that operate on IP addresses. The object is used by the Service core API for allocation of IP addresses. An IP address can be represented in different formats, to guarantee the uniqueness of the IP, the name of the object is the IP address in canonical format, four decimal digits separated by dots suppressing leading zeros for IPv4 and the representation defined by RFC 5952 for IPv6. Valid: 192.168.1.5 or 2001:db8::1 or 2001:db8:aaaa:bbbb:cccc:dddd:eeee:1 Invalid: 10.01.2.3 or 2001:db8:0:0:0::1

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

- **kind**: IPAddress

- **metadata** (ObjectMeta)

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

- **spec** (IPAddressSpec)

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

## IPAddressSpec {#IPAddressSpec}

IPAddressSpec describe the attributes in an IP Address.

- **parentRef** (ParentReference), required

  ParentRef references the resource that an IPAddress is attached to. An IPAddress must reference a parent object.

  *ParentReference describes a reference to a parent object.*

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

    Name is the name of the object being referenced.

  - **parentRef.resource** (string), required

    Resource is the resource of the object being referenced.

  - **parentRef.group** (string)

    Group is the group of the object being referenced.

  - **parentRef.namespace** (string)

    Namespace is the namespace of the object being referenced.

## IPAddressList {#IPAddressList}

IPAddressList contains a list of IPAddress.

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

- **kind**: IPAddressList

- **metadata** (ListMeta)

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

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

  items is the list of IPAddresses.

## Operations {#Operations}

### `get` read the specified IPAddress

#### HTTP Request

GET /apis/networking.k8s.io/v1beta1/ipaddresses/{name}

#### Parameters

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

  name of the IPAddress

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

  pretty

#### Response

200 (IPAddress): OK

401: Unauthorized

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

#### HTTP Request

GET /apis/networking.k8s.io/v1beta1/ipaddresses

#### 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 (IPAddressList): OK

401: Unauthorized

### `create` create an IPAddress

#### HTTP Request

POST /apis/networking.k8s.io/v1beta1/ipaddresses

#### Parameters

- **body**: IPAddress, required

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

  dryRun

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

  fieldManager

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

  fieldValidation

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

  pretty

#### Response

200 (IPAddress): OK

201 (IPAddress): Created

202 (IPAddress): Accepted

401: Unauthorized

### `update` replace the specified IPAddress

#### HTTP Request

PUT /apis/networking.k8s.io/v1beta1/ipaddresses/{name}

#### Parameters

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

  name of the IPAddress

- **body**: IPAddress, required

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

  dryRun

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

  fieldManager

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

  fieldValidation

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

  pretty

#### Response

200 (IPAddress): OK

201 (IPAddress): Created

401: Unauthorized

### `patch` partially update the specified IPAddress

#### HTTP Request

PATCH /apis/networking.k8s.io/v1beta1/ipaddresses/{name}

#### Parameters

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

  name of the IPAddress

- **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 (IPAddress): OK

201 (IPAddress): Created

401: Unauthorized

### `delete` delete an IPAddress

#### HTTP Request

DELETE /apis/networking.k8s.io/v1beta1/ipaddresses/{name}

#### Parameters

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

  name of the IPAddress

- **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 IPAddress

#### HTTP Request

DELETE /apis/networking.k8s.io/v1beta1/ipaddresses

#### 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 v1beta1    import   k8s io api networking v1beta1    kind   IPAddress  content type   api reference  description   IPAddress represents a single IP of a single IP Family   title   IPAddress v1beta1  weight  4 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 v1beta1    import  k8s io api networking v1beta1        IPAddress   IPAddress   IPAddress represents a single IP of a single IP Family  The object is designed to be used by APIs that operate on IP addresses  The object is used by the Service core API for allocation of IP addresses  An IP address can be represented in different formats  to guarantee the uniqueness of the IP  the name of the object is the IP address in canonical format  four decimal digits separated by dots suppressing leading zeros for IPv4 and the representation defined by RFC 5952 for IPv6  Valid  192 168 1 5 or 2001 db8  1 or 2001 db8 aaaa bbbb cccc dddd eeee 1 Invalid  10 01 2 3 or 2001 db8 0 0 0  1   hr       apiVersion    networking k8s io v1beta1       kind    IPAddress       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    IPAddressSpec  a      spec is the desired state of the IPAddress  More info  https   git k8s io community contributors devel sig architecture api conventions md spec and status         IPAddressSpec   IPAddressSpec   IPAddressSpec describe the attributes in an IP Address    hr       parentRef    ParentReference   required    ParentRef references the resource that an IPAddress is attached to  An IPAddress must reference a parent object      a name  ParentReference    a     ParentReference describes a reference to a parent object          parentRef name    string   required      Name is the name of the object being referenced         parentRef resource    string   required      Resource is the resource of the object being referenced         parentRef group    string       Group is the group of the object being referenced         parentRef namespace    string       Namespace is the namespace of the object being referenced          IPAddressList   IPAddressList   IPAddressList contains a list of IPAddress    hr       apiVersion    networking k8s io v1beta1       kind    IPAddressList       metadata     a href    ListMeta  a      Standard object s metadata  More info  https   git k8s io community contributors devel sig architecture api conventions md metadata      items       a href    IPAddress  a    required    items is the list of IPAddresses          Operations   Operations      hr             get  read the specified IPAddress       HTTP Request  GET  apis networking k8s io v1beta1 ipaddresses  name        Parameters       name     in path    string  required    name of the IPAddress       pretty     in query    string     a href    pretty  a          Response   200   a href    IPAddress  a    OK  401  Unauthorized        list  list or watch objects of kind IPAddress       HTTP Request  GET  apis networking k8s io v1beta1 ipaddresses       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    IPAddressList  a    OK  401  Unauthorized        create  create an IPAddress       HTTP Request  POST  apis networking k8s io v1beta1 ipaddresses       Parameters       body     a href    IPAddress  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    IPAddress  a    OK  201   a href    IPAddress  a    Created  202   a href    IPAddress  a    Accepted  401  Unauthorized        update  replace the specified IPAddress       HTTP Request  PUT  apis networking k8s io v1beta1 ipaddresses  name        Parameters       name     in path    string  required    name of the IPAddress       body     a href    IPAddress  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    IPAddress  a    OK  201   a href    IPAddress  a    Created  401  Unauthorized        patch  partially update the specified IPAddress       HTTP Request  PATCH  apis networking k8s io v1beta1 ipaddresses  name        Parameters       name     in path    string  required    name of the IPAddress       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    IPAddress  a    OK  201   a href    IPAddress  a    Created  401  Unauthorized        delete  delete an IPAddress       HTTP Request  DELETE  apis networking k8s io v1beta1 ipaddresses  name        Parameters       name     in path    string  required    name of the IPAddress       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 IPAddress       HTTP Request  DELETE  apis networking k8s io v1beta1 ipaddresses       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


kubernetes reference weight 6 apiVersion coordination k8s io v1alpha1 contenttype apireference import k8s io api coordination v1alpha1 kind LeaseCandidate apimetadata LeaseCandidate defines a candidate for a Lease object title LeaseCandidate v1alpha1 autogenerated true

Answer:
---
api_metadata:
  apiVersion: "coordination.k8s.io/v1alpha1"
  import: "k8s.io/api/coordination/v1alpha1"
  kind: "LeaseCandidate"
content_type: "api_reference"
description: "LeaseCandidate defines a candidate for a Lease object."
title: "LeaseCandidate v1alpha1"
weight: 6
auto_generated: true
---

`apiVersion: coordination.k8s.io/v1alpha1`

`import "k8s.io/api/coordination/v1alpha1"`

## LeaseCandidate {#LeaseCandidate}

LeaseCandidate defines a candidate for a Lease object. Candidates are created such that coordinated leader election will pick the best leader from the list of candidates.

- **apiVersion**: coordination.k8s.io/v1alpha1

- **kind**: LeaseCandidate

- **metadata** (ObjectMeta)

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

- **spec** (LeaseCandidateSpec)

  spec contains the specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

## LeaseCandidateSpec {#LeaseCandidateSpec}

LeaseCandidateSpec is a specification of a Lease.

- **leaseName** (string), required

  LeaseName is the name of the lease for which this candidate is contending. This field is immutable.

- **preferredStrategies** ([]string), required

  *Atomic: will be replaced during a merge*

  PreferredStrategies indicates the list of strategies for picking the leader for coordinated leader election. The list is ordered, and the first strategy supersedes all other strategies. The list is used by coordinated leader election to make a decision about the final election strategy. This follows as - If all clients have strategy X as the first element in this list, strategy X will be used. - If a candidate has strategy [X] and another candidate has strategy [Y, X], Y supersedes X and strategy Y
    will be used.
  - If a candidate has strategy [X, Y] and another candidate has strategy [Y, X], this is a user error and leader
    election will not operate the Lease until resolved.
  (Alpha) Using this field requires the CoordinatedLeaderElection feature gate to be enabled.

- **binaryVersion** (string)

  BinaryVersion is the binary version. It must be in a semver format without leading `v`. This field is required when strategy is "OldestEmulationVersion"

- **emulationVersion** (string)

  EmulationVersion is the emulation version. It must be in a semver format without leading `v`. EmulationVersion must be less than or equal to BinaryVersion. This field is required when strategy is "OldestEmulationVersion"

- **pingTime** (MicroTime)

  PingTime is the last time that the server has requested the LeaseCandidate to renew. It is only done during leader election to check if any LeaseCandidates have become ineligible. When PingTime is updated, the LeaseCandidate will respond by updating RenewTime.

  *MicroTime is version of Time with microsecond level precision.*

- **renewTime** (MicroTime)

  RenewTime is the time that the LeaseCandidate was last updated. Any time a Lease needs to do leader election, the PingTime field is updated to signal to the LeaseCandidate that they should update the RenewTime. Old LeaseCandidate objects are also garbage collected if it has been hours since the last renew. The PingTime field is updated regularly to prevent garbage collection for still active LeaseCandidates.

  *MicroTime is version of Time with microsecond level precision.*

## LeaseCandidateList {#LeaseCandidateList}

LeaseCandidateList is a list of Lease objects.

- **apiVersion**: coordination.k8s.io/v1alpha1

- **kind**: LeaseCandidateList

- **metadata** (ListMeta)

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

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

  items is a list of schema objects.

## Operations {#Operations}

### `get` read the specified LeaseCandidate

#### HTTP Request

GET /apis/coordination.k8s.io/v1alpha1/namespaces/{namespace}/leasecandidates/{name}

#### Parameters

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

  name of the LeaseCandidate

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

  namespace

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

  pretty

#### Response

200 (LeaseCandidate): OK

401: Unauthorized

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

#### HTTP Request

GET /apis/coordination.k8s.io/v1alpha1/namespaces/{namespace}/leasecandidates

#### 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 (LeaseCandidateList): OK

401: Unauthorized

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

#### HTTP Request

GET /apis/coordination.k8s.io/v1alpha1/leasecandidates

#### 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 (LeaseCandidateList): OK

401: Unauthorized

### `create` create a LeaseCandidate

#### HTTP Request

POST /apis/coordination.k8s.io/v1alpha1/namespaces/{namespace}/leasecandidates

#### Parameters

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

  namespace

- **body**: LeaseCandidate, required

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

  dryRun

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

  fieldManager

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

  fieldValidation

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

  pretty

#### Response

200 (LeaseCandidate): OK

201 (LeaseCandidate): Created

202 (LeaseCandidate): Accepted

401: Unauthorized

### `update` replace the specified LeaseCandidate

#### HTTP Request

PUT /apis/coordination.k8s.io/v1alpha1/namespaces/{namespace}/leasecandidates/{name}

#### Parameters

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

  name of the LeaseCandidate

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

  namespace

- **body**: LeaseCandidate, required

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

  dryRun

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

  fieldManager

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

  fieldValidation

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

  pretty

#### Response

200 (LeaseCandidate): OK

201 (LeaseCandidate): Created

401: Unauthorized

### `patch` partially update the specified LeaseCandidate

#### HTTP Request

PATCH /apis/coordination.k8s.io/v1alpha1/namespaces/{namespace}/leasecandidates/{name}

#### Parameters

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

  name of the LeaseCandidate

- **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 (LeaseCandidate): OK

201 (LeaseCandidate): Created

401: Unauthorized

### `delete` delete a LeaseCandidate

#### HTTP Request

DELETE /apis/coordination.k8s.io/v1alpha1/namespaces/{namespace}/leasecandidates/{name}

#### Parameters

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

  name of the LeaseCandidate

- **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 LeaseCandidate

#### HTTP Request

DELETE /apis/coordination.k8s.io/v1alpha1/namespaces/{namespace}/leasecandidates

#### 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   coordination k8s io v1alpha1    import   k8s io api coordination v1alpha1    kind   LeaseCandidate  content type   api reference  description   LeaseCandidate defines a candidate for a Lease object   title   LeaseCandidate v1alpha1  weight  6 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  coordination k8s io v1alpha1    import  k8s io api coordination v1alpha1        LeaseCandidate   LeaseCandidate   LeaseCandidate defines a candidate for a Lease object  Candidates are created such that coordinated leader election will pick the best leader from the list of candidates    hr       apiVersion    coordination k8s io v1alpha1       kind    LeaseCandidate       metadata     a href    ObjectMeta  a      More info  https   git k8s io community contributors devel sig architecture api conventions md metadata      spec     a href    LeaseCandidateSpec  a      spec contains the specification of the Lease  More info  https   git k8s io community contributors devel sig architecture api conventions md spec and status         LeaseCandidateSpec   LeaseCandidateSpec   LeaseCandidateSpec is a specification of a Lease    hr       leaseName    string   required    LeaseName is the name of the lease for which this candidate is contending  This field is immutable       preferredStrategies      string   required     Atomic  will be replaced during a merge       PreferredStrategies indicates the list of strategies for picking the leader for coordinated leader election  The list is ordered  and the first strategy supersedes all other strategies  The list is used by coordinated leader election to make a decision about the final election strategy  This follows as   If all clients have strategy X as the first element in this list  strategy X will be used    If a candidate has strategy  X  and another candidate has strategy  Y  X   Y supersedes X and strategy Y     will be used      If a candidate has strategy  X  Y  and another candidate has strategy  Y  X   this is a user error and leader     election will not operate the Lease until resolved     Alpha  Using this field requires the CoordinatedLeaderElection feature gate to be enabled       binaryVersion    string     BinaryVersion is the binary version  It must be in a semver format without leading  v   This field is required when strategy is  OldestEmulationVersion       emulationVersion    string     EmulationVersion is the emulation version  It must be in a semver format without leading  v   EmulationVersion must be less than or equal to BinaryVersion  This field is required when strategy is  OldestEmulationVersion       pingTime    MicroTime     PingTime is the last time that the server has requested the LeaseCandidate to renew  It is only done during leader election to check if any LeaseCandidates have become ineligible  When PingTime is updated  the LeaseCandidate will respond by updating RenewTime      a name  MicroTime    a     MicroTime is version of Time with microsecond level precision        renewTime    MicroTime     RenewTime is the time that the LeaseCandidate was last updated  Any time a Lease needs to do leader election  the PingTime field is updated to signal to the LeaseCandidate that they should update the RenewTime  Old LeaseCandidate objects are also garbage collected if it has been hours since the last renew  The PingTime field is updated regularly to prevent garbage collection for still active LeaseCandidates      a name  MicroTime    a     MicroTime is version of Time with microsecond level precision           LeaseCandidateList   LeaseCandidateList   LeaseCandidateList is a list of Lease objects    hr       apiVersion    coordination k8s io v1alpha1       kind    LeaseCandidateList       metadata     a href    ListMeta  a      Standard list metadata  More info  https   git k8s io community contributors devel sig architecture api conventions md metadata      items       a href    LeaseCandidate  a    required    items is a list of schema objects          Operations   Operations      hr             get  read the specified LeaseCandidate       HTTP Request  GET  apis coordination k8s io v1alpha1 namespaces  namespace  leasecandidates  name        Parameters       name     in path    string  required    name of the LeaseCandidate       namespace     in path    string  required     a href    namespace  a        pretty     in query    string     a href    pretty  a          Response   200   a href    LeaseCandidate  a    OK  401  Unauthorized        list  list or watch objects of kind LeaseCandidate       HTTP Request  GET  apis coordination k8s io v1alpha1 namespaces  namespace  leasecandidates       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    LeaseCandidateList  a    OK  401  Unauthorized        list  list or watch objects of kind LeaseCandidate       HTTP Request  GET  apis coordination k8s io v1alpha1 leasecandidates       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    LeaseCandidateList  a    OK  401  Unauthorized        create  create a LeaseCandidate       HTTP Request  POST  apis coordination k8s io v1alpha1 namespaces  namespace  leasecandidates       Parameters       namespace     in path    string  required     a href    namespace  a        body     a href    LeaseCandidate  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    LeaseCandidate  a    OK  201   a href    LeaseCandidate  a    Created  202   a href    LeaseCandidate  a    Accepted  401  Unauthorized        update  replace the specified LeaseCandidate       HTTP Request  PUT  apis coordination k8s io v1alpha1 namespaces  namespace  leasecandidates  name        Parameters       name     in path    string  required    name of the LeaseCandidate       namespace     in path    string  required     a href    namespace  a        body     a href    LeaseCandidate  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    LeaseCandidate  a    OK  201   a href    LeaseCandidate  a    Created  401  Unauthorized        patch  partially update the specified LeaseCandidate       HTTP Request  PATCH  apis coordination k8s io v1alpha1 namespaces  namespace  leasecandidates  name        Parameters       name     in path    string  required    name of the LeaseCandidate       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    LeaseCandidate  a    OK  201   a href    LeaseCandidate  a    Created  401  Unauthorized        delete  delete a LeaseCandidate       HTTP Request  DELETE  apis coordination k8s io v1alpha1 namespaces  namespace  leasecandidates  name        Parameters       name     in path    string  required    name of the LeaseCandidate       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 LeaseCandidate       HTTP Request  DELETE  apis coordination k8s io v1alpha1 namespaces  namespace  leasecandidates       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 title ServiceCIDR v1beta1 kind ServiceCIDR import k8s io api networking v1beta1 contenttype apireference apiVersion networking k8s io v1beta1 weight 10 ServiceCIDR defines a range of IP addresses using CIDR format e apimetadata autogenerated true

Answer:
---
api_metadata:
  apiVersion: "networking.k8s.io/v1beta1"
  import: "k8s.io/api/networking/v1beta1"
  kind: "ServiceCIDR"
content_type: "api_reference"
description: "ServiceCIDR defines a range of IP addresses using CIDR format (e."
title: "ServiceCIDR v1beta1"
weight: 10
auto_generated: true
---

`apiVersion: networking.k8s.io/v1beta1`

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

## ServiceCIDR {#ServiceCIDR}

ServiceCIDR defines a range of IP addresses using CIDR format (e.g. 192.168.0.0/24 or 2001:db2::/64). This range is used to allocate ClusterIPs to Service objects.

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

- **kind**: ServiceCIDR

- **metadata** (ObjectMeta)

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

- **spec** (ServiceCIDRSpec)

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

- **status** (ServiceCIDRStatus)

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

## ServiceCIDRSpec {#ServiceCIDRSpec}

ServiceCIDRSpec define the CIDRs the user wants to use for allocating ClusterIPs for Services.

- **cidrs** ([]string)

  *Atomic: will be replaced during a merge*

  CIDRs defines the IP blocks in CIDR notation (e.g. "192.168.0.0/24" or "2001:db8::/64") from which to assign service cluster IPs. Max of two CIDRs is allowed, one of each IP family. This field is immutable.

## ServiceCIDRStatus {#ServiceCIDRStatus}

ServiceCIDRStatus describes the current state of the ServiceCIDR.

- **conditions** ([]Condition)

  *Patch strategy: merge on key `type`*

  *Map: unique values on key type will be kept during a merge*

  conditions holds an array of metav1.Condition that describe the state of the ServiceCIDR. Current service state

  *Condition contains details for one aspect of the current state of this API Resource.*

  - **conditions.lastTransitionTime** (Time), required

    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.

    *Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON.  Wrappers are provided for many of the factory methods that the time package offers.*

  - **conditions.message** (string), required

    message is a human readable message indicating details about the transition. This may be an empty string.

  - **conditions.reason** (string), required

    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.

  - **conditions.status** (string), required

    status of the condition, one of True, False, Unknown.

  - **conditions.type** (string), required

    type of condition in CamelCase or in foo.example.com/CamelCase.

  - **conditions.observedGeneration** (int64)

    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.

## ServiceCIDRList {#ServiceCIDRList}

ServiceCIDRList contains a list of ServiceCIDR objects.

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

- **kind**: ServiceCIDRList

- **metadata** (ListMeta)

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

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

  items is the list of ServiceCIDRs.

## Operations {#Operations}

### `get` read the specified ServiceCIDR

#### HTTP Request

GET /apis/networking.k8s.io/v1beta1/servicecidrs/{name}

#### Parameters

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

  name of the ServiceCIDR

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

  pretty

#### Response

200 (ServiceCIDR): OK

401: Unauthorized

### `get` read status of the specified ServiceCIDR

#### HTTP Request

GET /apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status

#### Parameters

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

  name of the ServiceCIDR

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

  pretty

#### Response

200 (ServiceCIDR): OK

401: Unauthorized

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

#### HTTP Request

GET /apis/networking.k8s.io/v1beta1/servicecidrs

#### 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 (ServiceCIDRList): OK

401: Unauthorized

### `create` create a ServiceCIDR

#### HTTP Request

POST /apis/networking.k8s.io/v1beta1/servicecidrs

#### Parameters

- **body**: ServiceCIDR, required

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

  dryRun

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

  fieldManager

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

  fieldValidation

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

  pretty

#### Response

200 (ServiceCIDR): OK

201 (ServiceCIDR): Created

202 (ServiceCIDR): Accepted

401: Unauthorized

### `update` replace the specified ServiceCIDR

#### HTTP Request

PUT /apis/networking.k8s.io/v1beta1/servicecidrs/{name}

#### Parameters

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

  name of the ServiceCIDR

- **body**: ServiceCIDR, required

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

  dryRun

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

  fieldManager

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

  fieldValidation

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

  pretty

#### Response

200 (ServiceCIDR): OK

201 (ServiceCIDR): Created

401: Unauthorized

### `update` replace status of the specified ServiceCIDR

#### HTTP Request

PUT /apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status

#### Parameters

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

  name of the ServiceCIDR

- **body**: ServiceCIDR, required

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

  dryRun

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

  fieldManager

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

  fieldValidation

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

  pretty

#### Response

200 (ServiceCIDR): OK

201 (ServiceCIDR): Created

401: Unauthorized

### `patch` partially update the specified ServiceCIDR

#### HTTP Request

PATCH /apis/networking.k8s.io/v1beta1/servicecidrs/{name}

#### Parameters

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

  name of the ServiceCIDR

- **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 (ServiceCIDR): OK

201 (ServiceCIDR): Created

401: Unauthorized

### `patch` partially update status of the specified ServiceCIDR

#### HTTP Request

PATCH /apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status

#### Parameters

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

  name of the ServiceCIDR

- **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 (ServiceCIDR): OK

201 (ServiceCIDR): Created

401: Unauthorized

### `delete` delete a ServiceCIDR

#### HTTP Request

DELETE /apis/networking.k8s.io/v1beta1/servicecidrs/{name}

#### Parameters

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

  name of the ServiceCIDR

- **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 ServiceCIDR

#### HTTP Request

DELETE /apis/networking.k8s.io/v1beta1/servicecidrs

#### 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 v1beta1    import   k8s io api networking v1beta1    kind   ServiceCIDR  content type   api reference  description   ServiceCIDR defines a range of IP addresses using CIDR format  e   title   ServiceCIDR v1beta1  weight  10 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 v1beta1    import  k8s io api networking v1beta1        ServiceCIDR   ServiceCIDR   ServiceCIDR defines a range of IP addresses using CIDR format  e g  192 168 0 0 24 or 2001 db2   64   This range is used to allocate ClusterIPs to Service objects    hr       apiVersion    networking k8s io v1beta1       kind    ServiceCIDR       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    ServiceCIDRSpec  a      spec is the desired state of the ServiceCIDR  More info  https   git k8s io community contributors devel sig architecture api conventions md spec and status      status     a href    ServiceCIDRStatus  a      status represents the current state of the ServiceCIDR  More info  https   git k8s io community contributors devel sig architecture api conventions md spec and status         ServiceCIDRSpec   ServiceCIDRSpec   ServiceCIDRSpec define the CIDRs the user wants to use for allocating ClusterIPs for Services    hr       cidrs      string      Atomic  will be replaced during a merge       CIDRs defines the IP blocks in CIDR notation  e g   192 168 0 0 24  or  2001 db8   64   from which to assign service cluster IPs  Max of two CIDRs is allowed  one of each IP family  This field is immutable          ServiceCIDRStatus   ServiceCIDRStatus   ServiceCIDRStatus describes the current state of the ServiceCIDR    hr       conditions      Condition      Patch strategy  merge on key  type         Map  unique values on key type will be kept during a merge       conditions holds an array of metav1 Condition that describe the state of the ServiceCIDR  Current service state     a name  Condition    a     Condition contains details for one aspect of the current state of this API Resource          conditions lastTransitionTime    Time   required      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        a name  Time    a       Time is a wrapper around time Time which supports correct marshaling to YAML and JSON   Wrappers are provided for many of the factory methods that the time package offers          conditions message    string   required      message is a human readable message indicating details about the transition  This may be an empty string         conditions reason    string   required      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         conditions status    string   required      status of the condition  one of True  False  Unknown         conditions type    string   required      type of condition in CamelCase or in foo example com CamelCase         conditions observedGeneration    int64       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          ServiceCIDRList   ServiceCIDRList   ServiceCIDRList contains a list of ServiceCIDR objects    hr       apiVersion    networking k8s io v1beta1       kind    ServiceCIDRList       metadata     a href    ListMeta  a      Standard object s metadata  More info  https   git k8s io community contributors devel sig architecture api conventions md metadata      items       a href    ServiceCIDR  a    required    items is the list of ServiceCIDRs          Operations   Operations      hr             get  read the specified ServiceCIDR       HTTP Request  GET  apis networking k8s io v1beta1 servicecidrs  name        Parameters       name     in path    string  required    name of the ServiceCIDR       pretty     in query    string     a href    pretty  a          Response   200   a href    ServiceCIDR  a    OK  401  Unauthorized        get  read status of the specified ServiceCIDR       HTTP Request  GET  apis networking k8s io v1beta1 servicecidrs  name  status       Parameters       name     in path    string  required    name of the ServiceCIDR       pretty     in query    string     a href    pretty  a          Response   200   a href    ServiceCIDR  a    OK  401  Unauthorized        list  list or watch objects of kind ServiceCIDR       HTTP Request  GET  apis networking k8s io v1beta1 servicecidrs       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    ServiceCIDRList  a    OK  401  Unauthorized        create  create a ServiceCIDR       HTTP Request  POST  apis networking k8s io v1beta1 servicecidrs       Parameters       body     a href    ServiceCIDR  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    ServiceCIDR  a    OK  201   a href    ServiceCIDR  a    Created  202   a href    ServiceCIDR  a    Accepted  401  Unauthorized        update  replace the specified ServiceCIDR       HTTP Request  PUT  apis networking k8s io v1beta1 servicecidrs  name        Parameters       name     in path    string  required    name of the ServiceCIDR       body     a href    ServiceCIDR  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    ServiceCIDR  a    OK  201   a href    ServiceCIDR  a    Created  401  Unauthorized        update  replace status of the specified ServiceCIDR       HTTP Request  PUT  apis networking k8s io v1beta1 servicecidrs  name  status       Parameters       name     in path    string  required    name of the ServiceCIDR       body     a href    ServiceCIDR  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    ServiceCIDR  a    OK  201   a href    ServiceCIDR  a    Created  401  Unauthorized        patch  partially update the specified ServiceCIDR       HTTP Request  PATCH  apis networking k8s io v1beta1 servicecidrs  name        Parameters       name     in path    string  required    name of the ServiceCIDR       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    ServiceCIDR  a    OK  201   a href    ServiceCIDR  a    Created  401  Unauthorized        patch  partially update status of the specified ServiceCIDR       HTTP Request  PATCH  apis networking k8s io v1beta1 servicecidrs  name  status       Parameters       name     in path    string  required    name of the ServiceCIDR       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    ServiceCIDR  a    OK  201   a href    ServiceCIDR  a    Created  401  Unauthorized        delete  delete a ServiceCIDR       HTTP Request  DELETE  apis networking k8s io v1beta1 servicecidrs  name        Parameters       name     in path    string  required    name of the ServiceCIDR       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 ServiceCIDR       HTTP Request  DELETE  apis networking k8s io v1beta1 servicecidrs       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


kubernetes reference APIService represents a server for a particular GroupVersion title APIService kind APIService contenttype apireference import k8s io kube aggregator pkg apis apiregistration v1 apimetadata autogenerated true apiVersion apiregistration k8s io v1 weight 1

Answer:
---
api_metadata:
  apiVersion: "apiregistration.k8s.io/v1"
  import: "k8s.io/kube-aggregator/pkg/apis/apiregistration/v1"
  kind: "APIService"
content_type: "api_reference"
description: "APIService represents a server for a particular GroupVersion."
title: "APIService"
weight: 1
auto_generated: true
---

`apiVersion: apiregistration.k8s.io/v1`

`import "k8s.io/kube-aggregator/pkg/apis/apiregistration/v1"`

## APIService {#APIService}

APIService represents a server for a particular GroupVersion. Name must be "version.group".

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

- **kind**: APIService

- **metadata** (ObjectMeta)

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

- **spec** (APIServiceSpec)

  Spec contains information for locating and communicating with a server

- **status** (APIServiceStatus)

  Status contains derived information about an API server

## APIServiceSpec {#APIServiceSpec}

APIServiceSpec contains information for locating and communicating with a server. Only https is supported, though you are able to disable certificate verification.

- **groupPriorityMinimum** (int32), required

  GroupPriorityMinimum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMinimum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object.  (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s

- **versionPriority** (int32), required

  VersionPriority controls the ordering of this API version inside of its group.  Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10). Since it's inside of a group, the number can be small, probably in the 10s. In case of equal version priorities, the version string will be used to compute the order inside a group. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10.

- **caBundle** ([]byte)

  *Atomic: will be replaced during a merge*

  CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate. If unspecified, system trust roots on the apiserver are used.

- **group** (string)

  Group is the API group name this server hosts

- **insecureSkipTLSVerify** (boolean)

  InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged.  You should use the CABundle instead.

- **service** (ServiceReference)

  Service is a reference to the service for this API server.  It must communicate on port 443. If the Service is nil, that means the handling for the API groupversion is handled locally on this server. The call will simply delegate to the normal handler chain to be fulfilled.

  *ServiceReference holds a reference to Service.legacy.k8s.io*

  - **service.name** (string)

    Name is the name of the service

  - **service.namespace** (string)

    Namespace is the namespace of the service

  - **service.port** (int32)

    If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive).

- **version** (string)

  Version is the API version this server hosts.  For example, "v1"

## APIServiceStatus {#APIServiceStatus}

APIServiceStatus contains derived information about an API server

- **conditions** ([]APIServiceCondition)

  *Patch strategy: merge on key `type`*

  *Map: unique values on key type will be kept during a merge*

  Current service state of apiService.

  *APIServiceCondition describes the state of an APIService at a particular point*

  - **conditions.status** (string), required

    Status is the status of the condition. Can be True, False, Unknown.

  - **conditions.type** (string), required

    Type is the type of the condition.

  - **conditions.lastTransitionTime** (Time)

    Last time the condition transitioned from one status to another.

    *Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON.  Wrappers are provided for many of the factory methods that the time package offers.*

  - **conditions.message** (string)

    Human-readable message indicating details about last transition.

  - **conditions.reason** (string)

    Unique, one-word, CamelCase reason for the condition's last transition.

## APIServiceList {#APIServiceList}

APIServiceList is a list of APIService objects.

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

- **kind**: APIServiceList

- **metadata** (ListMeta)

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

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

  Items is the list of APIService

## Operations {#Operations}

### `get` read the specified APIService

#### HTTP Request

GET /apis/apiregistration.k8s.io/v1/apiservices/{name}

#### Parameters

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

  name of the APIService

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

  pretty

#### Response

200 (APIService): OK

401: Unauthorized

### `get` read status of the specified APIService

#### HTTP Request

GET /apis/apiregistration.k8s.io/v1/apiservices/{name}/status

#### Parameters

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

  name of the APIService

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

  pretty

#### Response

200 (APIService): OK

401: Unauthorized

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

#### HTTP Request

GET /apis/apiregistration.k8s.io/v1/apiservices

#### 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 (APIServiceList): OK

401: Unauthorized

### `create` create an APIService

#### HTTP Request

POST /apis/apiregistration.k8s.io/v1/apiservices

#### Parameters

- **body**: APIService, required

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

  dryRun

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

  fieldManager

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

  fieldValidation

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

  pretty

#### Response

200 (APIService): OK

201 (APIService): Created

202 (APIService): Accepted

401: Unauthorized

### `update` replace the specified APIService

#### HTTP Request

PUT /apis/apiregistration.k8s.io/v1/apiservices/{name}

#### Parameters

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

  name of the APIService

- **body**: APIService, required

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

  dryRun

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

  fieldManager

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

  fieldValidation

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

  pretty

#### Response

200 (APIService): OK

201 (APIService): Created

401: Unauthorized

### `update` replace status of the specified APIService

#### HTTP Request

PUT /apis/apiregistration.k8s.io/v1/apiservices/{name}/status

#### Parameters

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

  name of the APIService

- **body**: APIService, required

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

  dryRun

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

  fieldManager

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

  fieldValidation

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

  pretty

#### Response

200 (APIService): OK

201 (APIService): Created

401: Unauthorized

### `patch` partially update the specified APIService

#### HTTP Request

PATCH /apis/apiregistration.k8s.io/v1/apiservices/{name}

#### Parameters

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

  name of the APIService

- **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 (APIService): OK

201 (APIService): Created

401: Unauthorized

### `patch` partially update status of the specified APIService

#### HTTP Request

PATCH /apis/apiregistration.k8s.io/v1/apiservices/{name}/status

#### Parameters

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

  name of the APIService

- **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 (APIService): OK

201 (APIService): Created

401: Unauthorized

### `delete` delete an APIService

#### HTTP Request

DELETE /apis/apiregistration.k8s.io/v1/apiservices/{name}

#### Parameters

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

  name of the APIService

- **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 APIService

#### HTTP Request

DELETE /apis/apiregistration.k8s.io/v1/apiservices

#### 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   apiregistration k8s io v1    import   k8s io kube aggregator pkg apis apiregistration v1    kind   APIService  content type   api reference  description   APIService represents a server for a particular GroupVersion   title   APIService  weight  1 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  apiregistration k8s io v1    import  k8s io kube aggregator pkg apis apiregistration v1        APIService   APIService   APIService represents a server for a particular GroupVersion  Name must be  version group     hr       apiVersion    apiregistration k8s io v1       kind    APIService       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    APIServiceSpec  a      Spec contains information for locating and communicating with a server      status     a href    APIServiceStatus  a      Status contains derived information about an API server         APIServiceSpec   APIServiceSpec   APIServiceSpec contains information for locating and communicating with a server  Only https is supported  though you are able to disable certificate verification    hr       groupPriorityMinimum    int32   required    GroupPriorityMinimum is the priority this group should have at least  Higher priority means that the group is preferred by clients over lower priority ones  Note that other versions of this group might specify even higher GroupPriorityMinimum values such that the whole group gets a higher priority  The primary sort is based on GroupPriorityMinimum  ordered highest number to lowest  20 before 10   The secondary sort is based on the alphabetical comparison of the name of the object    v1 bar before v1 foo  We d recommend something like    k8s io  except extensions  at 18000 and PaaSes  OpenShift  Deis  are recommended to be in the 2000s      versionPriority    int32   required    VersionPriority controls the ordering of this API version inside of its group   Must be greater than zero  The primary sort is based on VersionPriority  ordered highest to lowest  20 before 10   Since it s inside of a group  the number can be small  probably in the 10s  In case of equal version priorities  the version string will be used to compute the order inside a group  If the version string is  kube like   it will sort above non  kube like  version strings  which are ordered lexicographically   Kube like  versions start with a  v   then are followed by a number  the major version   then optionally the string  alpha  or  beta  and another number  the minor version   These are sorted first by GA   beta   alpha  where GA is a version with no suffix such as beta or alpha   and then by comparing major version  then minor version  An example sorted list of versions  v10  v2  v1  v11beta2  v10beta3  v3beta1  v12alpha1  v11alpha2  foo1  foo10       caBundle      byte      Atomic  will be replaced during a merge       CABundle is a PEM encoded CA bundle which will be used to validate an API server s serving certificate  If unspecified  system trust roots on the apiserver are used       group    string     Group is the API group name this server hosts      insecureSkipTLSVerify    boolean     InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server  This is strongly discouraged   You should use the CABundle instead       service    ServiceReference     Service is a reference to the service for this API server   It must communicate on port 443  If the Service is nil  that means the handling for the API groupversion is handled locally on this server  The call will simply delegate to the normal handler chain to be fulfilled      a name  ServiceReference    a     ServiceReference holds a reference to Service legacy k8s io         service name    string       Name is the name of the service        service namespace    string       Namespace is the namespace of the service        service port    int32       If specified  the port on the service that hosting webhook  Default to 443 for backward compatibility   port  should be a valid port number  1 65535  inclusive        version    string     Version is the API version this server hosts   For example   v1          APIServiceStatus   APIServiceStatus   APIServiceStatus contains derived information about an API server   hr       conditions      APIServiceCondition      Patch strategy  merge on key  type         Map  unique values on key type will be kept during a merge       Current service state of apiService      a name  APIServiceCondition    a     APIServiceCondition describes the state of an APIService at a particular point         conditions status    string   required      Status is the status of the condition  Can be True  False  Unknown         conditions type    string   required      Type is the type of the condition         conditions lastTransitionTime    Time       Last time the condition transitioned from one status to another        a name  Time    a       Time is a wrapper around time Time which supports correct marshaling to YAML and JSON   Wrappers are provided for many of the factory methods that the time package offers          conditions message    string       Human readable message indicating details about last transition         conditions reason    string       Unique  one word  CamelCase reason for the condition s last transition          APIServiceList   APIServiceList   APIServiceList is a list of APIService objects    hr       apiVersion    apiregistration k8s io v1       kind    APIServiceList       metadata     a href    ListMeta  a      Standard list metadata More info  https   git k8s io community contributors devel sig architecture api conventions md metadata      items       a href    APIService  a    required    Items is the list of APIService         Operations   Operations      hr             get  read the specified APIService       HTTP Request  GET  apis apiregistration k8s io v1 apiservices  name        Parameters       name     in path    string  required    name of the APIService       pretty     in query    string     a href    pretty  a          Response   200   a href    APIService  a    OK  401  Unauthorized        get  read status of the specified APIService       HTTP Request  GET  apis apiregistration k8s io v1 apiservices  name  status       Parameters       name     in path    string  required    name of the APIService       pretty     in query    string     a href    pretty  a          Response   200   a href    APIService  a    OK  401  Unauthorized        list  list or watch objects of kind APIService       HTTP Request  GET  apis apiregistration k8s io v1 apiservices       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    APIServiceList  a    OK  401  Unauthorized        create  create an APIService       HTTP Request  POST  apis apiregistration k8s io v1 apiservices       Parameters       body     a href    APIService  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    APIService  a    OK  201   a href    APIService  a    Created  202   a href    APIService  a    Accepted  401  Unauthorized        update  replace the specified APIService       HTTP Request  PUT  apis apiregistration k8s io v1 apiservices  name        Parameters       name     in path    string  required    name of the APIService       body     a href    APIService  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    APIService  a    OK  201   a href    APIService  a    Created  401  Unauthorized        update  replace status of the specified APIService       HTTP Request  PUT  apis apiregistration k8s io v1 apiservices  name  status       Parameters       name     in path    string  required    name of the APIService       body     a href    APIService  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    APIService  a    OK  201   a href    APIService  a    Created  401  Unauthorized        patch  partially update the specified APIService       HTTP Request  PATCH  apis apiregistration k8s io v1 apiservices  name        Parameters       name     in path    string  required    name of the APIService       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    APIService  a    OK  201   a href    APIService  a    Created  401  Unauthorized        patch  partially update status of the specified APIService       HTTP Request  PATCH  apis apiregistration k8s io v1 apiservices  name  status       Parameters       name     in path    string  required    name of the APIService       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    APIService  a    OK  201   a href    APIService  a    Created  401  Unauthorized        delete  delete an APIService       HTTP Request  DELETE  apis apiregistration k8s io v1 apiservices  name        Parameters       name     in path    string  required    name of the APIService       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 APIService       HTTP Request  DELETE  apis apiregistration k8s io v1 apiservices       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