kubernetes reference autogenerated true weight 5 import k8s io api coordination v1 contenttype apireference Lease defines a lease concept apiVersion coordination k8s io v1 apimetadata kind Lease title Lease

Answer:
---
api_metadata:
  apiVersion: "coordination.k8s.io/v1"
  import: "k8s.io/api/coordination/v1"
  kind: "Lease"
content_type: "api_reference"
description: "Lease defines a lease concept."
title: "Lease"
weight: 5
auto_generated: true
---

`apiVersion: coordination.k8s.io/v1`

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

## Lease {#Lease}

Lease defines a lease concept.

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

- **kind**: Lease

- **metadata** (ObjectMeta)

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

- **spec** (LeaseSpec)

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

## LeaseSpec {#LeaseSpec}

LeaseSpec is a specification of a Lease.

- **acquireTime** (MicroTime)

  acquireTime is a time when the current lease was acquired.

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

- **holderIdentity** (string)

  holderIdentity contains the identity of the holder of a current lease. If Coordinated Leader Election is used, the holder identity must be equal to the elected LeaseCandidate.metadata.name field.

- **leaseDurationSeconds** (int32)

  leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measured against the time of last observed renewTime.

- **leaseTransitions** (int32)

  leaseTransitions is the number of transitions of a lease between holders.

- **preferredHolder** (string)

  PreferredHolder signals to a lease holder that the lease has a more optimal holder and should be given up. This field can only be set if Strategy is also set.

- **renewTime** (MicroTime)

  renewTime is a time when the current holder of a lease has last updated the lease.

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

- **strategy** (string)

  Strategy indicates the strategy for picking the leader for coordinated leader election. If the field is not specified, there is no active coordination for this lease. (Alpha) Using this field requires the CoordinatedLeaderElection feature gate to be enabled.

## LeaseList {#LeaseList}

LeaseList is a list of Lease objects.

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

- **kind**: LeaseList

- **metadata** (ListMeta)

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

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

  items is a list of schema objects.

## Operations {#Operations}

### `get` read the specified Lease

#### HTTP Request

GET /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}

#### Parameters

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

  name of the Lease

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

  namespace

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

  pretty

#### Response

200 (Lease): OK

401: Unauthorized

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

#### HTTP Request

GET /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases

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

401: Unauthorized

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

#### HTTP Request

GET /apis/coordination.k8s.io/v1/leases

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

401: Unauthorized

### `create` create a Lease

#### HTTP Request

POST /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases

#### Parameters

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

  namespace

- **body**: Lease, required

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

  dryRun

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

  fieldManager

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

  fieldValidation

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

  pretty

#### Response

200 (Lease): OK

201 (Lease): Created

202 (Lease): Accepted

401: Unauthorized

### `update` replace the specified Lease

#### HTTP Request

PUT /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}

#### Parameters

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

  name of the Lease

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

  namespace

- **body**: Lease, required

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

  dryRun

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

  fieldManager

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

  fieldValidation

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

  pretty

#### Response

200 (Lease): OK

201 (Lease): Created

401: Unauthorized

### `patch` partially update the specified Lease

#### HTTP Request

PATCH /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}

#### Parameters

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

  name of the Lease

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

201 (Lease): Created

401: Unauthorized

### `delete` delete a Lease

#### HTTP Request

DELETE /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}

#### Parameters

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

  name of the Lease

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

#### HTTP Request

DELETE /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases

#### 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 v1    import   k8s io api coordination v1    kind   Lease  content type   api reference  description   Lease defines a lease concept   title   Lease  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  coordination k8s io v1    import  k8s io api coordination v1        Lease   Lease   Lease defines a lease concept    hr       apiVersion    coordination k8s io v1       kind    Lease       metadata     a href    ObjectMeta  a      More info  https   git k8s io community contributors devel sig architecture api conventions md metadata      spec     a href    LeaseSpec  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         LeaseSpec   LeaseSpec   LeaseSpec is a specification of a Lease    hr       acquireTime    MicroTime     acquireTime is a time when the current lease was acquired      a name  MicroTime    a     MicroTime is version of Time with microsecond level precision        holderIdentity    string     holderIdentity contains the identity of the holder of a current lease  If Coordinated Leader Election is used  the holder identity must be equal to the elected LeaseCandidate metadata name field       leaseDurationSeconds    int32     leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it  This is measured against the time of last observed renewTime       leaseTransitions    int32     leaseTransitions is the number of transitions of a lease between holders       preferredHolder    string     PreferredHolder signals to a lease holder that the lease has a more optimal holder and should be given up  This field can only be set if Strategy is also set       renewTime    MicroTime     renewTime is a time when the current holder of a lease has last updated the lease      a name  MicroTime    a     MicroTime is version of Time with microsecond level precision        strategy    string     Strategy indicates the strategy for picking the leader for coordinated leader election  If the field is not specified  there is no active coordination for this lease   Alpha  Using this field requires the CoordinatedLeaderElection feature gate to be enabled          LeaseList   LeaseList   LeaseList is a list of Lease objects    hr       apiVersion    coordination k8s io v1       kind    LeaseList       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    Lease  a    required    items is a list of schema objects          Operations   Operations      hr             get  read the specified Lease       HTTP Request  GET  apis coordination k8s io v1 namespaces  namespace  leases  name        Parameters       name     in path    string  required    name of the Lease       namespace     in path    string  required     a href    namespace  a        pretty     in query    string     a href    pretty  a          Response   200   a href    Lease  a    OK  401  Unauthorized        list  list or watch objects of kind Lease       HTTP Request  GET  apis coordination k8s io v1 namespaces  namespace  leases       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    LeaseList  a    OK  401  Unauthorized        list  list or watch objects of kind Lease       HTTP Request  GET  apis coordination k8s io v1 leases       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    LeaseList  a    OK  401  Unauthorized        create  create a Lease       HTTP Request  POST  apis coordination k8s io v1 namespaces  namespace  leases       Parameters       namespace     in path    string  required     a href    namespace  a        body     a href    Lease  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    Lease  a    OK  201   a href    Lease  a    Created  202   a href    Lease  a    Accepted  401  Unauthorized        update  replace the specified Lease       HTTP Request  PUT  apis coordination k8s io v1 namespaces  namespace  leases  name        Parameters       name     in path    string  required    name of the Lease       namespace     in path    string  required     a href    namespace  a        body     a href    Lease  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    Lease  a    OK  201   a href    Lease  a    Created  401  Unauthorized        patch  partially update the specified Lease       HTTP Request  PATCH  apis coordination k8s io v1 namespaces  namespace  leases  name        Parameters       name     in path    string  required    name of the Lease       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    Lease  a    OK  201   a href    Lease  a    Created  401  Unauthorized        delete  delete a Lease       HTTP Request  DELETE  apis coordination k8s io v1 namespaces  namespace  leases  name        Parameters       name     in path    string  required    name of the Lease       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 Lease       HTTP Request  DELETE  apis coordination k8s io v1 namespaces  namespace  leases       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 Event is a report of an event somewhere in the cluster contenttype apireference import k8s io api events v1 title Event kind Event apiVersion events k8s io v1 apimetadata weight 3 autogenerated true

Answer:
---
api_metadata:
  apiVersion: "events.k8s.io/v1"
  import: "k8s.io/api/events/v1"
  kind: "Event"
content_type: "api_reference"
description: "Event is a report of an event somewhere in the cluster."
title: "Event"
weight: 3
auto_generated: true
---

`apiVersion: events.k8s.io/v1`

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

## Event {#Event}

Event is a report of an event somewhere in the cluster. It generally denotes some state change in the system. Events have a limited retention time and triggers and messages may evolve with time.  Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason.  Events should be treated as informative, best-effort, supplemental data.

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

- **kind**: Event

- **metadata** (ObjectMeta)

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

- **eventTime** (MicroTime), required

  eventTime is the time when this Event was first observed. It is required.

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

- **action** (string)

  action is what action was taken/failed regarding to the regarding object. It is machine-readable. This field cannot be empty for new Events and it can have at most 128 characters.

- **deprecatedCount** (int32)

  deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type.

- **deprecatedFirstTimestamp** (Time)

  deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type.

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

- **deprecatedLastTimestamp** (Time)

  deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type.

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

- **deprecatedSource** (EventSource)

  deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type.

  *EventSource contains information for an event.*

  - **deprecatedSource.component** (string)

    Component from which the event is generated.

  - **deprecatedSource.host** (string)

    Node name on which the event is generated.

- **note** (string)

  note is a human-readable description of the status of this operation. Maximal length of the note is 1kB, but libraries should be prepared to handle values up to 64kB.

- **reason** (string)

  reason is why the action was taken. It is human-readable. This field cannot be empty for new Events and it can have at most 128 characters.

- **regarding** (ObjectReference)

  regarding contains the object this Event is about. In most cases it's an Object reporting controller implements, e.g. ReplicaSetController implements ReplicaSets and this event is emitted because it acts on some changes in a ReplicaSet object.

- **related** (ObjectReference)

  related is the optional secondary object for more complex actions. E.g. when regarding object triggers a creation or deletion of related object.

- **reportingController** (string)

  reportingController is the name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`. This field cannot be empty for new Events.

- **reportingInstance** (string)

  reportingInstance is the ID of the controller instance, e.g. `kubelet-xyzf`. This field cannot be empty for new Events and it can have at most 128 characters.

- **series** (EventSeries)

  series is data about the Event series this event represents or nil if it's a singleton Event.

  *EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time. How often to update the EventSeries is up to the event reporters. The default event reporter in "k8s.io/client-go/tools/events/event_broadcaster.go" shows how this struct is updated on heartbeats and can guide customized reporter implementations.*

  - **series.count** (int32), required

    count is the number of occurrences in this series up to the last heartbeat time.

  - **series.lastObservedTime** (MicroTime), required

    lastObservedTime is the time when last Event from the series was seen before last heartbeat.

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

- **type** (string)

  type is the type of this event (Normal, Warning), new types could be added in the future. It is machine-readable. This field cannot be empty for new Events.

## EventList {#EventList}

EventList is a list of Event objects.

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

- **kind**: EventList

- **metadata** (ListMeta)

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

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

  items is a list of schema objects.

## Operations {#Operations}

### `get` read the specified Event

#### HTTP Request

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

#### Parameters

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

  name of the Event

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

  namespace

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

  pretty

#### Response

200 (Event): OK

401: Unauthorized

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

#### HTTP Request

GET /apis/events.k8s.io/v1/namespaces/{namespace}/events

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

401: Unauthorized

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

#### HTTP Request

GET /apis/events.k8s.io/v1/events

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

401: Unauthorized

### `create` create an Event

#### HTTP Request

POST /apis/events.k8s.io/v1/namespaces/{namespace}/events

#### Parameters

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

  namespace

- **body**: Event, required

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

  dryRun

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

  fieldManager

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

  fieldValidation

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

  pretty

#### Response

200 (Event): OK

201 (Event): Created

202 (Event): Accepted

401: Unauthorized

### `update` replace the specified Event

#### HTTP Request

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

#### Parameters

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

  name of the Event

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

  namespace

- **body**: Event, required

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

  dryRun

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

  fieldManager

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

  fieldValidation

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

  pretty

#### Response

200 (Event): OK

201 (Event): Created

401: Unauthorized

### `patch` partially update the specified Event

#### HTTP Request

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

#### Parameters

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

  name of the Event

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

201 (Event): Created

401: Unauthorized

### `delete` delete an Event

#### HTTP Request

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

#### Parameters

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

  name of the Event

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

#### HTTP Request

DELETE /apis/events.k8s.io/v1/namespaces/{namespace}/events

#### 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   events k8s io v1    import   k8s io api events v1    kind   Event  content type   api reference  description   Event is a report of an event somewhere in the cluster   title   Event  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  events k8s io v1    import  k8s io api events v1        Event   Event   Event is a report of an event somewhere in the cluster  It generally denotes some state change in the system  Events have a limited retention time and triggers and messages may evolve with time   Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger  or the continued existence of events with that Reason   Events should be treated as informative  best effort  supplemental data    hr       apiVersion    events k8s io v1       kind    Event       metadata     a href    ObjectMeta  a      Standard object s metadata  More info  https   git k8s io community contributors devel sig architecture api conventions md metadata      eventTime    MicroTime   required    eventTime is the time when this Event was first observed  It is required      a name  MicroTime    a     MicroTime is version of Time with microsecond level precision        action    string     action is what action was taken failed regarding to the regarding object  It is machine readable  This field cannot be empty for new Events and it can have at most 128 characters       deprecatedCount    int32     deprecatedCount is the deprecated field assuring backward compatibility with core v1 Event type       deprecatedFirstTimestamp    Time     deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core v1 Event type      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        deprecatedLastTimestamp    Time     deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core v1 Event type      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        deprecatedSource    EventSource     deprecatedSource is the deprecated field assuring backward compatibility with core v1 Event type      a name  EventSource    a     EventSource contains information for an event          deprecatedSource component    string       Component from which the event is generated         deprecatedSource host    string       Node name on which the event is generated       note    string     note is a human readable description of the status of this operation  Maximal length of the note is 1kB  but libraries should be prepared to handle values up to 64kB       reason    string     reason is why the action was taken  It is human readable  This field cannot be empty for new Events and it can have at most 128 characters       regarding     a href    ObjectReference  a      regarding contains the object this Event is about  In most cases it s an Object reporting controller implements  e g  ReplicaSetController implements ReplicaSets and this event is emitted because it acts on some changes in a ReplicaSet object       related     a href    ObjectReference  a      related is the optional secondary object for more complex actions  E g  when regarding object triggers a creation or deletion of related object       reportingController    string     reportingController is the name of the controller that emitted this Event  e g   kubernetes io kubelet   This field cannot be empty for new Events       reportingInstance    string     reportingInstance is the ID of the controller instance  e g   kubelet xyzf   This field cannot be empty for new Events and it can have at most 128 characters       series    EventSeries     series is data about the Event series this event represents or nil if it s a singleton Event      a name  EventSeries    a     EventSeries contain information on series of events  i e  thing that was is happening continuously for some time  How often to update the EventSeries is up to the event reporters  The default event reporter in  k8s io client go tools events event broadcaster go  shows how this struct is updated on heartbeats and can guide customized reporter implementations          series count    int32   required      count is the number of occurrences in this series up to the last heartbeat time         series lastObservedTime    MicroTime   required      lastObservedTime is the time when last Event from the series was seen before last heartbeat        a name  MicroTime    a       MicroTime is version of Time with microsecond level precision        type    string     type is the type of this event  Normal  Warning   new types could be added in the future  It is machine readable  This field cannot be empty for new Events          EventList   EventList   EventList is a list of Event objects    hr       apiVersion    events k8s io v1       kind    EventList       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    Event  a    required    items is a list of schema objects          Operations   Operations      hr             get  read the specified Event       HTTP Request  GET  apis events k8s io v1 namespaces  namespace  events  name        Parameters       name     in path    string  required    name of the Event       namespace     in path    string  required     a href    namespace  a        pretty     in query    string     a href    pretty  a          Response   200   a href    Event  a    OK  401  Unauthorized        list  list or watch objects of kind Event       HTTP Request  GET  apis events k8s io v1 namespaces  namespace  events       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    EventList  a    OK  401  Unauthorized        list  list or watch objects of kind Event       HTTP Request  GET  apis events k8s io v1 events       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    EventList  a    OK  401  Unauthorized        create  create an Event       HTTP Request  POST  apis events k8s io v1 namespaces  namespace  events       Parameters       namespace     in path    string  required     a href    namespace  a        body     a href    Event  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    Event  a    OK  201   a href    Event  a    Created  202   a href    Event  a    Accepted  401  Unauthorized        update  replace the specified Event       HTTP Request  PUT  apis events k8s io v1 namespaces  namespace  events  name        Parameters       name     in path    string  required    name of the Event       namespace     in path    string  required     a href    namespace  a        body     a href    Event  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    Event  a    OK  201   a href    Event  a    Created  401  Unauthorized        patch  partially update the specified Event       HTTP Request  PATCH  apis events k8s io v1 namespaces  namespace  events  name        Parameters       name     in path    string  required    name of the Event       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    Event  a    OK  201   a href    Event  a    Created  401  Unauthorized        delete  delete an Event       HTTP Request  DELETE  apis events k8s io v1 namespaces  namespace  events  name        Parameters       name     in path    string  required    name of the Event       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 Event       HTTP Request  DELETE  apis events k8s io v1 namespaces  namespace  events       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 weight 2 kind ComponentStatus title ComponentStatus contenttype apireference apimetadata autogenerated true ComponentStatus and ComponentStatusList holds the cluster validation info import k8s io api core v1

Answer:
---
api_metadata:
  apiVersion: "v1"
  import: "k8s.io/api/core/v1"
  kind: "ComponentStatus"
content_type: "api_reference"
description: "ComponentStatus (and ComponentStatusList) holds the cluster validation info."
title: "ComponentStatus"
weight: 2
auto_generated: true
---

`apiVersion: v1`

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

## ComponentStatus {#ComponentStatus}

ComponentStatus (and ComponentStatusList) holds the cluster validation info. Deprecated: This API is deprecated in v1.19+

- **apiVersion**: v1

- **kind**: ComponentStatus

- **metadata** (ObjectMeta)

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

- **conditions** ([]ComponentCondition)

  *Patch strategy: merge on key `type`*

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

  List of component conditions observed

  *Information about the condition of a component.*

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

    Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown".

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

    Type of condition for a component. Valid value: "Healthy"

  - **conditions.error** (string)

    Condition error code for a component. For example, a health check error code.

  - **conditions.message** (string)

    Message about the condition for a component. For example, information about a health check.

## ComponentStatusList {#ComponentStatusList}

Status of all the conditions for the component as a list of ComponentStatus objects. Deprecated: This API is deprecated in v1.19+

- **apiVersion**: v1

- **kind**: ComponentStatusList

- **metadata** (ListMeta)

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

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

  List of ComponentStatus objects.

## Operations {#Operations}

### `get` read the specified ComponentStatus

#### HTTP Request

GET /api/v1/componentstatuses/{name}

#### Parameters

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

  name of the ComponentStatus

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

  pretty

#### Response

200 (ComponentStatus): OK

401: Unauthorized

### `list` list objects of kind ComponentStatus

#### HTTP Request

GET /api/v1/componentstatuses

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

401: Unauthorized

api metadata    apiVersion   v1    import   k8s io api core v1    kind   ComponentStatus  content type   api reference  description   ComponentStatus  and ComponentStatusList  holds the cluster validation info   title   ComponentStatus  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        ComponentStatus   ComponentStatus   ComponentStatus  and ComponentStatusList  holds the cluster validation info  Deprecated  This API is deprecated in v1 19    hr       apiVersion    v1       kind    ComponentStatus       metadata     a href    ObjectMeta  a      Standard object s metadata  More info  https   git k8s io community contributors devel sig architecture api conventions md metadata      conditions      ComponentCondition      Patch strategy  merge on key  type         Map  unique values on key type will be kept during a merge       List of component conditions observed     a name  ComponentCondition    a     Information about the condition of a component          conditions status    string   required      Status of the condition for a component  Valid values for  Healthy    True    False   or  Unknown          conditions type    string   required      Type of condition for a component  Valid value   Healthy         conditions error    string       Condition error code for a component  For example  a health check error code         conditions message    string       Message about the condition for a component  For example  information about a health check          ComponentStatusList   ComponentStatusList   Status of all the conditions for the component as a list of ComponentStatus objects  Deprecated  This API is deprecated in v1 19    hr       apiVersion    v1       kind    ComponentStatusList       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    ComponentStatus  a    required    List of ComponentStatus objects          Operations   Operations      hr             get  read the specified ComponentStatus       HTTP Request  GET  api v1 componentstatuses  name        Parameters       name     in path    string  required    name of the ComponentStatus       pretty     in query    string     a href    pretty  a          Response   200   a href    ComponentStatus  a    OK  401  Unauthorized        list  list objects of kind ComponentStatus       HTTP Request  GET  api v1 componentstatuses       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    ComponentStatusList  a    OK  401  Unauthorized