1. Documentation
    2. Page history / Suggest an edit
×

Kubernetes v1 REST API

Overview

The Kubernetes API allows you to run containerized applications, bind persistent storage, link those applications through service discovery, and manage the cluster infrastructure.

Version information

Version: v1

URI scheme

Host: 127.0.0.1:8443 BasePath: / Schemes: HTTPS

Paths

get available resources

GET /api/v1

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Produces

  • application/json

Tags

  • apiv1

create a Binding

POST /api/v1/bindings

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Binding

Responses

HTTP Code Description Schema

200

success

v1.Binding

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

list objects of kind ComponentStatus

GET /api/v1/componentstatuses

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

v1.ComponentStatusList

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

list or watch objects of kind Endpoints

GET /api/v1/endpoints

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

v1.EndpointsList

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

create a Endpoints

POST /api/v1/endpoints

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Endpoints

Responses

HTTP Code Description Schema

200

success

v1.Endpoints

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

list or watch objects of kind Event

GET /api/v1/events

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

v1.EventList

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

create a Event

POST /api/v1/events

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Event

Responses

HTTP Code Description Schema

200

success

v1.Event

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

list or watch objects of kind LimitRange

GET /api/v1/limitranges

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

v1.LimitRangeList

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

create a LimitRange

POST /api/v1/limitranges

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.LimitRange

Responses

HTTP Code Description Schema

200

success

v1.LimitRange

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

list or watch objects of kind Namespace

GET /api/v1/namespaces

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

v1.NamespaceList

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

create a Namespace

POST /api/v1/namespaces

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Namespace

Responses

HTTP Code Description Schema

200

success

v1.Namespace

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

create a Binding

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Binding

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

v1.Binding

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

list objects of kind ComponentStatus

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

v1.ComponentStatusList

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

read the specified ComponentStatus

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ComponentStatus

true

string

Responses

HTTP Code Description Schema

200

success

v1.ComponentStatus

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

list or watch objects of kind Endpoints

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

v1.EndpointsList

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

create a Endpoints

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Endpoints

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

v1.Endpoints

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

read the specified Endpoints

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Endpoints

true

string

Responses

HTTP Code Description Schema

200

success

v1.Endpoints

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

replace the specified Endpoints

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Endpoints

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Endpoints

true

string

Responses

HTTP Code Description Schema

200

success

v1.Endpoints

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

delete a Endpoints

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Endpoints

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

partially update the specified Endpoints

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Endpoints

true

string

Responses

HTTP Code Description Schema

200

success

v1.Endpoints

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

Tags

  • apiv1

list or watch objects of kind Event

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

v1.EventList

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

create a Event

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Event

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

v1.Event

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

read the specified Event

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Event

true

string

Responses

HTTP Code Description Schema

200

success

v1.Event

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

replace the specified Event

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Event

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Event

true

string

Responses

HTTP Code Description Schema

200

success

v1.Event

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

delete a Event

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Event

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

partially update the specified Event

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Event

true

string

Responses

HTTP Code Description Schema

200

success

v1.Event

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

Tags

  • apiv1

list or watch objects of kind LimitRange

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

v1.LimitRangeList

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

create a LimitRange

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.LimitRange

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

v1.LimitRange

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

read the specified LimitRange

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the LimitRange

true

string

Responses

HTTP Code Description Schema

200

success

v1.LimitRange

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

replace the specified LimitRange

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.LimitRange

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the LimitRange

true

string

Responses

HTTP Code Description Schema

200

success

v1.LimitRange

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

delete a LimitRange

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the LimitRange

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

partially update the specified LimitRange

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the LimitRange

true

string

Responses

HTTP Code Description Schema

200

success

v1.LimitRange

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

Tags

  • apiv1

list or watch objects of kind PersistentVolumeClaim

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

Description

Persistent Volume Claims (PVC) represent a request to use a persistent volume (PV) with a pod. When creating a pod definition (or replication controller or deployment config) a developer may specify the amount of storage they need via a persistent volume reference. If an administrator has enabled and configured persistent volumes for use, they will be allocated on demand to pods that have similar requirements. Since volumes are created lazily, some pods may be scheduled to a node before their volume is assigned. The node will detect this situation and wait to start the pod until the volume is bound. Events will be generated (visible by using the describe command on the pod) that indicate the pod is waiting for volumes.

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

v1.PersistentVolumeClaimList

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

create a PersistentVolumeClaim

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PersistentVolumeClaim

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

v1.PersistentVolumeClaim

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

read the specified PersistentVolumeClaim

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

Responses

HTTP Code Description Schema

200

success

v1.PersistentVolumeClaim

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

replace the specified PersistentVolumeClaim

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PersistentVolumeClaim

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

Responses

HTTP Code Description Schema

200

success

v1.PersistentVolumeClaim

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

delete a PersistentVolumeClaim

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

partially update the specified PersistentVolumeClaim

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

Responses

HTTP Code Description Schema

200

success

v1.PersistentVolumeClaim

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

Tags

  • apiv1

replace status of the specified PersistentVolumeClaim

PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PersistentVolumeClaim

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

Responses

HTTP Code Description Schema

200

success

v1.PersistentVolumeClaim

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

list or watch objects of kind Pod

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

v1.PodList

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

create a Pod

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Pod

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

v1.Pod

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

read the specified Pod

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

Responses

HTTP Code Description Schema

200

success

v1.Pod

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

replace the specified Pod

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Pod

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

Responses

HTTP Code Description Schema

200

success

v1.Pod

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

delete a Pod

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

partially update the specified Pod

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

Responses

HTTP Code Description Schema

200

success

v1.Pod

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

Tags

  • apiv1

connect GET requests to attach of Pod

GET /api/v1/namespaces/{namespace}/pods/{name}/attach

Parameters

Type Name Description Required Schema Default

QueryParameter

stdin

Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false.

false

boolean

QueryParameter

stdout

Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true.

false

boolean

QueryParameter

stderr

Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true.

false

boolean

QueryParameter

tty

TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false.

false

boolean

QueryParameter

container

The container in which to execute the command. Defaults to only container if there is only one container in the pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

connect POST requests to attach of Pod

POST /api/v1/namespaces/{namespace}/pods/{name}/attach

Parameters

Type Name Description Required Schema Default

QueryParameter

stdin

Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false.

false

boolean

QueryParameter

stdout

Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true.

false

boolean

QueryParameter

stderr

Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true.

false

boolean

QueryParameter

tty

TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false.

false

boolean

QueryParameter

container

The container in which to execute the command. Defaults to only container if there is only one container in the pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

create binding of a Binding

POST /api/v1/namespaces/{namespace}/pods/{name}/binding

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Binding

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Binding

true

string

Responses

HTTP Code Description Schema

200

success

v1.Binding

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

connect GET requests to exec of Pod

GET /api/v1/namespaces/{namespace}/pods/{name}/exec

Parameters

Type Name Description Required Schema Default

QueryParameter

stdin

Redirect the standard input stream of the pod for this call. Defaults to false.

false

boolean

QueryParameter

stdout

Redirect the standard output stream of the pod for this call. Defaults to true.

false

boolean

QueryParameter

stderr

Redirect the standard error stream of the pod for this call. Defaults to true.

false

boolean

QueryParameter

tty

TTY if true indicates that a tty will be allocated for the exec call. Defaults to false.

false

boolean

QueryParameter

container

Container in which to execute the command. Defaults to only container if there is only one container in the pod.

false

string

QueryParameter

command

Command is the remote command to execute. argv array. Not executed within a shell.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

connect POST requests to exec of Pod

POST /api/v1/namespaces/{namespace}/pods/{name}/exec

Parameters

Type Name Description Required Schema Default

QueryParameter

stdin

Redirect the standard input stream of the pod for this call. Defaults to false.

false

boolean

QueryParameter

stdout

Redirect the standard output stream of the pod for this call. Defaults to true.

false

boolean

QueryParameter

stderr

Redirect the standard error stream of the pod for this call. Defaults to true.

false

boolean

QueryParameter

tty

TTY if true indicates that a tty will be allocated for the exec call. Defaults to false.

false

boolean

QueryParameter

container

Container in which to execute the command. Defaults to only container if there is only one container in the pod.

false

string

QueryParameter

command

Command is the remote command to execute. argv array. Not executed within a shell.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

read log of the specified Pod

GET /api/v1/namespaces/{namespace}/pods/{name}/log

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

container

The container for which to stream logs. Defaults to only container if there is one container in the pod.

false

string

QueryParameter

follow

Follow the log stream of the pod. Defaults to false.

false

boolean

QueryParameter

previous

Return previous terminated container logs. Defaults to false.

false

boolean

QueryParameter

sinceSeconds

A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.

false

ref

QueryParameter

sinceTime

An RFC3339 timestamp from which to show logs. If this value preceeds the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.

false

string

QueryParameter

timestamps

If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false.

false

boolean

QueryParameter

tailLines

If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime

false

ref

QueryParameter

limitBytes

If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit.

false

ref

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

Responses

HTTP Code Description Schema

200

success

v1.Pod

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

connect GET requests to portforward of Pod

GET /api/v1/namespaces/{namespace}/pods/{name}/portforward

Parameters

Type Name Description Required Schema Default

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

connect POST requests to portforward of Pod

POST /api/v1/namespaces/{namespace}/pods/{name}/portforward

Parameters

Type Name Description Required Schema Default

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

connect GET requests to proxy of Pod

GET /api/v1/namespaces/{namespace}/pods/{name}/proxy

Parameters

Type Name Description Required Schema Default

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

connect PUT requests to proxy of Pod

PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy

Parameters

Type Name Description Required Schema Default

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

connect DELETE requests to proxy of Pod

DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy

Parameters

Type Name Description Required Schema Default

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

connect POST requests to proxy of Pod

POST /api/v1/namespaces/{namespace}/pods/{name}/proxy

Parameters

Type Name Description Required Schema Default

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

connect GET requests to proxy of Pod

GET /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path:*}

Parameters

Type Name Description Required Schema Default

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

connect PUT requests to proxy of Pod

PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path:*}

Parameters

Type Name Description Required Schema Default

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

connect DELETE requests to proxy of Pod

DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path:*}

Parameters

Type Name Description Required Schema Default

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

connect POST requests to proxy of Pod

POST /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path:*}

Parameters

Type Name Description Required Schema Default

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

replace status of the specified Pod

PUT /api/v1/namespaces/{namespace}/pods/{name}/status

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Pod

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

Responses

HTTP Code Description Schema

200

success

v1.Pod

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

list or watch objects of kind PodTemplate

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

v1.PodTemplateList

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

create a PodTemplate

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PodTemplate

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

v1.PodTemplate

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

read the specified PodTemplate

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PodTemplate

true

string

Responses

HTTP Code Description Schema

200

success

v1.PodTemplate

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

replace the specified PodTemplate

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PodTemplate

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PodTemplate

true

string

Responses

HTTP Code Description Schema

200

success

v1.PodTemplate

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

delete a PodTemplate

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PodTemplate

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

partially update the specified PodTemplate

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PodTemplate

true

string

Responses

HTTP Code Description Schema

200

success

v1.PodTemplate

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

Tags

  • apiv1

list or watch objects of kind ReplicationController

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

v1.ReplicationControllerList

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

create a ReplicationController

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ReplicationController

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

v1.ReplicationController

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

read the specified ReplicationController

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

Responses

HTTP Code Description Schema

200

success

v1.ReplicationController

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

replace the specified ReplicationController

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ReplicationController

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

Responses

HTTP Code Description Schema

200

success

v1.ReplicationController

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

delete a ReplicationController

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

partially update the specified ReplicationController

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

Responses

HTTP Code Description Schema

200

success

v1.ReplicationController

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

Tags

  • apiv1

replace status of the specified ReplicationController

PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ReplicationController

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

Responses

HTTP Code Description Schema

200

success

v1.ReplicationController

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

list or watch objects of kind ResourceQuota

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

v1.ResourceQuotaList

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

create a ResourceQuota

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ResourceQuota

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

v1.ResourceQuota

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

read the specified ResourceQuota

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

Responses

HTTP Code Description Schema

200

success

v1.ResourceQuota

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

replace the specified ResourceQuota

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ResourceQuota

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

Responses

HTTP Code Description Schema

200

success

v1.ResourceQuota

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

delete a ResourceQuota

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

partially update the specified ResourceQuota

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

Responses

HTTP Code Description Schema

200

success

v1.ResourceQuota

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

Tags

  • apiv1

replace status of the specified ResourceQuota

PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ResourceQuota

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

Responses

HTTP Code Description Schema

200

success

v1.ResourceQuota

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

list or watch objects of kind Secret

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

v1.SecretList

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

create a Secret

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Secret

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

v1.Secret

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

read the specified Secret

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Secret

true

string

Responses

HTTP Code Description Schema

200

success

v1.Secret

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

replace the specified Secret

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Secret

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Secret

true

string

Responses

HTTP Code Description Schema

200

success

v1.Secret

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

delete a Secret

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Secret

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

partially update the specified Secret

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Secret

true

string

Responses

HTTP Code Description Schema

200

success

v1.Secret

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

Tags

  • apiv1

list or watch objects of kind ServiceAccount

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

v1.ServiceAccountList

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

create a ServiceAccount

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ServiceAccount

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

v1.ServiceAccount

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

read the specified ServiceAccount

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ServiceAccount

true

string

Responses

HTTP Code Description Schema

200

success

v1.ServiceAccount

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

replace the specified ServiceAccount

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ServiceAccount

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ServiceAccount

true

string

Responses

HTTP Code Description Schema

200

success

v1.ServiceAccount

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

delete a ServiceAccount

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ServiceAccount

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

partially update the specified ServiceAccount

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ServiceAccount

true

string

Responses

HTTP Code Description Schema

200

success

v1.ServiceAccount

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

Tags

  • apiv1

list or watch objects of kind Service

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

v1.ServiceList

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

create a Service

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Service

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

v1.Service

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

read the specified Service

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

Responses

HTTP Code Description Schema

200

success

v1.Service

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

replace the specified Service

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Service

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

Responses

HTTP Code Description Schema

200

success

v1.Service

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

delete a Service

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

partially update the specified Service

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

Responses

HTTP Code Description Schema

200

success

v1.Service

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

Tags

  • apiv1

read the specified Namespace

GET /api/v1/namespaces/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

PathParameter

name

name of the Namespace

true

string

Responses

HTTP Code Description Schema

200

success

v1.Namespace

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

replace the specified Namespace

PUT /api/v1/namespaces/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Namespace

PathParameter

name

name of the Namespace

true

string

Responses

HTTP Code Description Schema

200

success

v1.Namespace

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

delete a Namespace

DELETE /api/v1/namespaces/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

name

name of the Namespace

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

partially update the specified Namespace

PATCH /api/v1/namespaces/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the Namespace

true

string

Responses

HTTP Code Description Schema

200

success

v1.Namespace

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

Tags

  • apiv1

replace finalize of the specified Namespace

PUT /api/v1/namespaces/{name}/finalize

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Namespace

PathParameter

name

name of the Namespace

true

string

Responses

HTTP Code Description Schema

200

success

v1.Namespace

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

replace status of the specified Namespace

PUT /api/v1/namespaces/{name}/status

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Namespace

PathParameter

name

name of the Namespace

true

string

Responses

HTTP Code Description Schema

200

success

v1.Namespace

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

list or watch objects of kind Node

GET /api/v1/nodes

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

v1.NodeList

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

create a Node

POST /api/v1/nodes

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Node

Responses

HTTP Code Description Schema

200

success

v1.Node

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

read the specified Node

GET /api/v1/nodes/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

PathParameter

name

name of the Node

true

string

Responses

HTTP Code Description Schema

200

success

v1.Node

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

replace the specified Node

PUT /api/v1/nodes/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Node

PathParameter

name

name of the Node

true

string

Responses

HTTP Code Description Schema

200

success

v1.Node

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

delete a Node

DELETE /api/v1/nodes/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

name

name of the Node

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

partially update the specified Node

PATCH /api/v1/nodes/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the Node

true

string

Responses

HTTP Code Description Schema

200

success

v1.Node

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

Tags

  • apiv1

replace status of the specified Node

PUT /api/v1/nodes/{name}/status

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Node

PathParameter

name

name of the Node

true

string

Responses

HTTP Code Description Schema

200

success

v1.Node

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

list or watch objects of kind PersistentVolumeClaim

GET /api/v1/persistentvolumeclaims

Description

Persistent Volume Claims (PVC) represent a request to use a persistent volume (PV) with a pod. When creating a pod definition (or replication controller or deployment config) a developer may specify the amount of storage they need via a persistent volume reference. If an administrator has enabled and configured persistent volumes for use, they will be allocated on demand to pods that have similar requirements. Since volumes are created lazily, some pods may be scheduled to a node before their volume is assigned. The node will detect this situation and wait to start the pod until the volume is bound. Events will be generated (visible by using the describe command on the pod) that indicate the pod is waiting for volumes.

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

v1.PersistentVolumeClaimList

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

create a PersistentVolumeClaim

POST /api/v1/persistentvolumeclaims

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PersistentVolumeClaim

Responses

HTTP Code Description Schema

200

success

v1.PersistentVolumeClaim

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

list or watch objects of kind PersistentVolume

GET /api/v1/persistentvolumes

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

v1.PersistentVolumeList

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

create a PersistentVolume

POST /api/v1/persistentvolumes

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PersistentVolume

Responses

HTTP Code Description Schema

200

success

v1.PersistentVolume

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

read the specified PersistentVolume

GET /api/v1/persistentvolumes/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

PathParameter

name

name of the PersistentVolume

true

string

Responses

HTTP Code Description Schema

200

success

v1.PersistentVolume

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

replace the specified PersistentVolume

PUT /api/v1/persistentvolumes/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PersistentVolume

PathParameter

name

name of the PersistentVolume

true

string

Responses

HTTP Code Description Schema

200

success

v1.PersistentVolume

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

delete a PersistentVolume

DELETE /api/v1/persistentvolumes/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

name

name of the PersistentVolume

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

partially update the specified PersistentVolume

PATCH /api/v1/persistentvolumes/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the PersistentVolume

true

string

Responses

HTTP Code Description Schema

200

success

v1.PersistentVolume

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

Tags

  • apiv1

replace status of the specified PersistentVolume

PUT /api/v1/persistentvolumes/{name}/status

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PersistentVolume

PathParameter

name

name of the PersistentVolume

true

string

Responses

HTTP Code Description Schema

200

success

v1.PersistentVolume

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

list or watch objects of kind Pod

GET /api/v1/pods

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

v1.PodList

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

create a Pod

POST /api/v1/pods

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Pod

Responses

HTTP Code Description Schema

200

success

v1.Pod

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

list or watch objects of kind PodTemplate

GET /api/v1/podtemplates

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

v1.PodTemplateList

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

create a PodTemplate

POST /api/v1/podtemplates

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PodTemplate

Responses

HTTP Code Description Schema

200

success

v1.PodTemplate

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

proxy GET requests to Pod

GET /api/v1/proxy/namespaces/{namespace}/pods/{name}

Parameters

Type Name Description Required Schema Default

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

proxy PUT requests to Pod

PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}

Parameters

Type Name Description Required Schema Default

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

proxy DELETE requests to Pod

DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}

Parameters

Type Name Description Required Schema Default

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

proxy POST requests to Pod

POST /api/v1/proxy/namespaces/{namespace}/pods/{name}

Parameters

Type Name Description Required Schema Default

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

proxy GET requests to Pod

GET /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path:*}

Parameters

Type Name Description Required Schema Default

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

proxy PUT requests to Pod

PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path:*}

Parameters

Type Name Description Required Schema Default

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

proxy DELETE requests to Pod

DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path:*}

Parameters

Type Name Description Required Schema Default

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

proxy POST requests to Pod

POST /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path:*}

Parameters

Type Name Description Required Schema Default

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

proxy GET requests to Service

GET /api/v1/proxy/namespaces/{namespace}/services/{name}

Parameters

Type Name Description Required Schema Default

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

proxy PUT requests to Service

PUT /api/v1/proxy/namespaces/{namespace}/services/{name}

Parameters

Type Name Description Required Schema Default

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

proxy DELETE requests to Service

DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}

Parameters

Type Name Description Required Schema Default

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

proxy POST requests to Service

POST /api/v1/proxy/namespaces/{namespace}/services/{name}

Parameters

Type Name Description Required Schema Default

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

proxy GET requests to Service

GET /api/v1/proxy/namespaces/{namespace}/services/{name}/{path:*}

Parameters

Type Name Description Required Schema Default

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

proxy PUT requests to Service

PUT /api/v1/proxy/namespaces/{namespace}/services/{name}/{path:*}

Parameters

Type Name Description Required Schema Default

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

proxy DELETE requests to Service

DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}/{path:*}

Parameters

Type Name Description Required Schema Default

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

proxy POST requests to Service

POST /api/v1/proxy/namespaces/{namespace}/services/{name}/{path:*}

Parameters

Type Name Description Required Schema Default

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

proxy GET requests to Node

GET /api/v1/proxy/nodes/{name}

Parameters

Type Name Description Required Schema Default

PathParameter

name

name of the Node

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

proxy PUT requests to Node

PUT /api/v1/proxy/nodes/{name}

Parameters

Type Name Description Required Schema Default

PathParameter

name

name of the Node

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

proxy DELETE requests to Node

DELETE /api/v1/proxy/nodes/{name}

Parameters

Type Name Description Required Schema Default

PathParameter

name

name of the Node

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

proxy POST requests to Node

POST /api/v1/proxy/nodes/{name}

Parameters

Type Name Description Required Schema Default

PathParameter

name

name of the Node

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

proxy GET requests to Node

GET /api/v1/proxy/nodes/{name}/{path:*}

Parameters

Type Name Description Required Schema Default

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

proxy PUT requests to Node

PUT /api/v1/proxy/nodes/{name}/{path:*}

Parameters

Type Name Description Required Schema Default

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

proxy DELETE requests to Node

DELETE /api/v1/proxy/nodes/{name}/{path:*}

Parameters

Type Name Description Required Schema Default

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

proxy POST requests to Node

POST /api/v1/proxy/nodes/{name}/{path:*}

Parameters

Type Name Description Required Schema Default

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • apiv1

list or watch objects of kind ReplicationController

GET /api/v1/replicationcontrollers

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

v1.ReplicationControllerList

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

create a ReplicationController

POST /api/v1/replicationcontrollers

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ReplicationController

Responses

HTTP Code Description Schema

200

success

v1.ReplicationController

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

list or watch objects of kind ResourceQuota

GET /api/v1/resourcequotas

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

v1.ResourceQuotaList

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

create a ResourceQuota

POST /api/v1/resourcequotas

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ResourceQuota

Responses

HTTP Code Description Schema

200

success

v1.ResourceQuota

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

list or watch objects of kind Secret

GET /api/v1/secrets

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

v1.SecretList

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

create a Secret

POST /api/v1/secrets

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Secret

Responses

HTTP Code Description Schema

200

success

v1.Secret

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

list or watch objects of kind SecurityContextConstraints

GET /api/v1/securitycontextconstraints

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

v1.SecurityContextConstraintsList

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

create a SecurityContextConstraints

POST /api/v1/securitycontextconstraints

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.SecurityContextConstraints

Responses

HTTP Code Description Schema

200

success

v1.SecurityContextConstraints

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

read the specified SecurityContextConstraints

GET /api/v1/securitycontextconstraints/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

PathParameter

name

name of the SecurityContextConstraints

true

string

Responses

HTTP Code Description Schema

200

success

v1.SecurityContextConstraints

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

replace the specified SecurityContextConstraints

PUT /api/v1/securitycontextconstraints/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.SecurityContextConstraints

PathParameter

name

name of the SecurityContextConstraints

true

string

Responses

HTTP Code Description Schema

200

success

v1.SecurityContextConstraints

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

delete a SecurityContextConstraints

DELETE /api/v1/securitycontextconstraints/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

name

name of the SecurityContextConstraints

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

partially update the specified SecurityContextConstraints

PATCH /api/v1/securitycontextconstraints/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the SecurityContextConstraints

true

string

Responses

HTTP Code Description Schema

200

success

v1.SecurityContextConstraints

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

Tags

  • apiv1

list or watch objects of kind ServiceAccount

GET /api/v1/serviceaccounts

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

v1.ServiceAccountList

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

create a ServiceAccount

POST /api/v1/serviceaccounts

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ServiceAccount

Responses

HTTP Code Description Schema

200

success

v1.ServiceAccount

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

list or watch objects of kind Service

GET /api/v1/services

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

v1.ServiceList

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

create a Service

POST /api/v1/services

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Service

Responses

HTTP Code Description Schema

200

success

v1.Service

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch individual changes to a list of Endpoints

GET /api/v1/watch/endpoints

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch individual changes to a list of Event

GET /api/v1/watch/events

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch individual changes to a list of LimitRange

GET /api/v1/watch/limitranges

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch individual changes to a list of Namespace

GET /api/v1/watch/namespaces

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch individual changes to a list of Endpoints

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch changes to an object of kind Endpoints

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Endpoints

true

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch individual changes to a list of Event

GET /api/v1/watch/namespaces/{namespace}/events

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch changes to an object of kind Event

GET /api/v1/watch/namespaces/{namespace}/events/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Event

true

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch individual changes to a list of LimitRange

GET /api/v1/watch/namespaces/{namespace}/limitranges

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch changes to an object of kind LimitRange

GET /api/v1/watch/namespaces/{namespace}/limitranges/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the LimitRange

true

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch individual changes to a list of PersistentVolumeClaim

GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch changes to an object of kind PersistentVolumeClaim

GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch individual changes to a list of Pod

GET /api/v1/watch/namespaces/{namespace}/pods

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch changes to an object of kind Pod

GET /api/v1/watch/namespaces/{namespace}/pods/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch individual changes to a list of PodTemplate

GET /api/v1/watch/namespaces/{namespace}/podtemplates

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch changes to an object of kind PodTemplate

GET /api/v1/watch/namespaces/{namespace}/podtemplates/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PodTemplate

true

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch individual changes to a list of ReplicationController

GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch changes to an object of kind ReplicationController

GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch individual changes to a list of ResourceQuota

GET /api/v1/watch/namespaces/{namespace}/resourcequotas

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch changes to an object of kind ResourceQuota

GET /api/v1/watch/namespaces/{namespace}/resourcequotas/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch individual changes to a list of Secret

GET /api/v1/watch/namespaces/{namespace}/secrets

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch changes to an object of kind Secret

GET /api/v1/watch/namespaces/{namespace}/secrets/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Secret

true

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch individual changes to a list of ServiceAccount

GET /api/v1/watch/namespaces/{namespace}/serviceaccounts

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch changes to an object of kind ServiceAccount

GET /api/v1/watch/namespaces/{namespace}/serviceaccounts/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ServiceAccount

true

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch individual changes to a list of Service

GET /api/v1/watch/namespaces/{namespace}/services

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch changes to an object of kind Service

GET /api/v1/watch/namespaces/{namespace}/services/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch changes to an object of kind Namespace

GET /api/v1/watch/namespaces/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

name

name of the Namespace

true

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch individual changes to a list of Node

GET /api/v1/watch/nodes

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch changes to an object of kind Node

GET /api/v1/watch/nodes/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

name

name of the Node

true

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch individual changes to a list of PersistentVolumeClaim

GET /api/v1/watch/persistentvolumeclaims

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch individual changes to a list of PersistentVolume

GET /api/v1/watch/persistentvolumes

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch changes to an object of kind PersistentVolume

GET /api/v1/watch/persistentvolumes/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

name

name of the PersistentVolume

true

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch individual changes to a list of Pod

GET /api/v1/watch/pods

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch individual changes to a list of PodTemplate

GET /api/v1/watch/podtemplates

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch individual changes to a list of ReplicationController

GET /api/v1/watch/replicationcontrollers

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch individual changes to a list of ResourceQuota

GET /api/v1/watch/resourcequotas

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch individual changes to a list of Secret

GET /api/v1/watch/secrets

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch individual changes to a list of SecurityContextConstraints

GET /api/v1/watch/securitycontextconstraints

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch changes to an object of kind SecurityContextConstraints

GET /api/v1/watch/securitycontextconstraints/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

PathParameter

name

name of the SecurityContextConstraints

true

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch individual changes to a list of ServiceAccount

GET /api/v1/watch/serviceaccounts

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

watch individual changes to a list of Service

GET /api/v1/watch/services

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If 'true', then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

Responses

HTTP Code Description Schema

200

success

json.WatchEvent

Consumes

  • /

Produces

  • application/json

Tags

  • apiv1

Definitions

v1.PersistentVolume

A Persistent Volume (PV) is a storage device that is made available for use by applications by an administrator. When a user requests persistent storage be allocated for a pod, they create a persistent volume claim with the size and type of storage they need. The system will look for persistent volumes that match that claim and, if one is available, it will assign that persistent volume to the claim. Information about the volume (type, location, secrets necessary to use it) will be available to the claim and the claim may then be used from a pod as a volume source.

Deleting a persistent volume removes the cluster’s record of the volume, and may result in automated processes destroying the underlying network store.

Name Description Required Schema Default

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Spec defines a specification of a persistent volume owned by the cluster. Provisioned by an administrator. More info: http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistent-volumes

false

v1.PersistentVolumeSpec

status

Status represents the current information/status for the persistent volume. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistent-volumes

false

v1.PersistentVolumeStatus

v1.MetadataVolumeSource

Name Description Required Schema Default

items

list of metadata files

false

v1.MetadataFile array

v1.TCPSocketAction

TCPSocketAction describes an action based on opening a socket

Name Description Required Schema Default

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

true

string

v1.ResourceQuotaStatus

ResourceQuotaStatus defines the enforced hard limits and observed use.

Name Description Required Schema Default

hard

Hard is the set of enforced hard limits for each named resource. More info: http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota

false

any

used

Used is the current observed total usage of the resource in the namespace.

false

any

v1.ContainerStateTerminated

ContainerStateTerminated is a terminated state of a container.

Name Description Required Schema Default

exitCode

Exit status from the last termination of the container

true

integer (int32)

signal

Signal from the last termination of the container

false

integer (int32)

reason

(brief) reason from the last termination of the container

false

string

message

Message regarding the last termination of the container

false

string

startedAt

Time at which previous execution of the container started

false

string

finishedAt

Time at which the container last terminated

false

string

containerID

Container’s ID in the format 'docker://<container_id>'

false

string

v1.ReplicationControllerList

ReplicationControllerList is a collection of replication controllers.

Name Description Required Schema Default

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

List of replication controllers. More info: http://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md

true

v1.ReplicationController array

v1.Capability

v1.Pod

A pod corresponds to a group of containers running together on the same machine. All containers in a pod share an IP address, and may have access to shared volumes and local fileystem. Like individual application containers, pods are considered to be relatively ephemeral rather than durable entities. Pods are scheduled to nodes and remain there until termination (according to restart policy) or deletion. When a node dies, the pods scheduled to that node are deleted. Specific pods are never rescheduled to new nodes; instead, they must be replaced by a component like the replication controller.

See the Kubernetes pod documentation for more information.

Name Description Required Schema Default

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Specification of the desired behavior of the pod. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1.PodSpec

status

Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1.PodStatus

v1.Event

Event is a report of an event somewhere in the cluster.

Name Description Required Schema Default

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

true

v1.ObjectMeta

involvedObject

The object that this event is about.

true

v1.ObjectReference

reason

This should be a short, machine understandable string that gives the reason for the transition into the object’s current status.

false

string

message

A human-readable description of the status of this operation.

false

string

source

The component reporting this event. Should be a short machine understandable string.

false

v1.EventSource

firstTimestamp

The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)

false

string

lastTimestamp

The time at which the most recent occurrence of this event was recorded.

false

string

count

The number of times this event has occurred.

false

integer (int32)

v1.NodeDaemonEndpoints

NodeDaemonEndpoints lists ports opened by daemons running on the Node.

Name Description Required Schema Default

kubeletEndpoint

Endpoint on which Kubelet is listening.

false

v1.DaemonEndpoint

v1.HostPathVolumeSource

HostPathVolumeSource represents bare host directory volume.

Name Description Required Schema Default

path

Path of the directory on the host. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#hostpath

true

string

v1.Volume

Volume represents a named volume in a pod that may be accessed by any container in the pod.

Name Description Required Schema Default

name

Volume’s name. Must be a DNS_LABEL and unique within the pod. More info: http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names

true

string

hostPath

HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#hostpath

false

v1.HostPathVolumeSource

emptyDir

EmptyDir represents a temporary directory that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#emptydir

false

v1.EmptyDirVolumeSource

gcePersistentDisk

GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk

false

v1.GCEPersistentDiskVolumeSource

awsElasticBlockStore

AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore

false

v1.AWSElasticBlockStoreVolumeSource

gitRepo

GitRepo represents a git repository at a particular revision.

false

v1.GitRepoVolumeSource

secret

Secret represents a secret that should populate this volume. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#secrets

false

v1.SecretVolumeSource

nfs

NFS represents an NFS mount on the host that shares a pod’s lifetime More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs

false

v1.NFSVolumeSource

iscsi

ISCSI represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/HEAD/examples/iscsi/README.md

false

v1.ISCSIVolumeSource

glusterfs

Glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/glusterfs/README.md

false

v1.GlusterfsVolumeSource

persistentVolumeClaim

PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

false

v1.PersistentVolumeClaimVolumeSource

rbd

RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/rbd/README.md

false

v1.RBDVolumeSource

cinder

Cinder represents a cinder volume attached and mounted on kubelets host machine More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

false

v1.CinderVolumeSource

cephfs

CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime

false

v1.CephFSVolumeSource

flocker

Flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running

false

v1.FlockerVolumeSource

downwardAPI

DownwardAPI represents downward API about the pod that should populate this volume

false

v1.DownwardAPIVolumeSource

fc

FC represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.

false

v1.FCVolumeSource

metadata

false

v1.MetadataVolumeSource

v1.ContainerStateRunning

ContainerStateRunning is a running state of a container.

Name Description Required Schema Default

startedAt

Time at which the container was last (re-)started

false

string

v1.DeleteOptions

DeleteOptions may be provided when deleting an API object

Name Description Required Schema Default

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

true

integer (int64)

v1.PodTemplateSpec

PodTemplateSpec describes the data a pod should have when created from a template

Name Description Required Schema Default