Chapter 3. Kubernetes v1 REST API

3.1. Overview

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

3.1.1. Version information

Version: v1

3.1.2. URI scheme

Host: 127.0.0.1:8443
BasePath: /
Schemes: HTTPS

3.2. Paths

3.2.1. get available resources

GET /api/v1

3.2.1.1. Responses

HTTP CodeDescriptionSchema

default

success

Section 2.3.5, “v1.APIResourceList”

3.2.1.2. Consumes

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.1.3. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.1.4. Tags

  • apiv1

3.2.2. create a Binding

POST /api/v1/bindings

3.2.2.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.10, “v1.Binding”

 

3.2.2.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.10, “v1.Binding”

3.2.2.3. Consumes

  • /

3.2.2.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.2.5. Tags

  • apiv1

3.2.3. list objects of kind ComponentStatus

GET /api/v1/componentstatuses

3.2.3.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

false

string

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

3.2.3.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.17, “v1.ComponentStatusList”

3.2.3.3. Consumes

  • /

3.2.3.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf
  • application/json;stream=watch
  • application/vnd.kubernetes.protobuf;stream=watch

3.2.3.5. Tags

  • apiv1

3.2.4. read the specified ComponentStatus

GET /api/v1/componentstatuses/{name}

3.2.4.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

PathParameter

name

name of the ComponentStatus

true

string

 

3.2.4.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.16, “v1.ComponentStatus”

3.2.4.3. Consumes

  • /

3.2.4.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.4.5. Tags

  • apiv1

3.2.5. list or watch objects of kind ConfigMap

GET /api/v1/configmaps

3.2.5.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

false

string

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

3.2.5.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.21, “v1.ConfigMapList”

3.2.5.3. Consumes

  • /

3.2.5.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf
  • application/json;stream=watch
  • application/vnd.kubernetes.protobuf;stream=watch

3.2.5.5. Tags

  • apiv1

3.2.6. create a ConfigMap

POST /api/v1/configmaps

3.2.6.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.18, “v1.ConfigMap”

 

3.2.6.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.18, “v1.ConfigMap”

3.2.6.3. Consumes

  • /

3.2.6.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.6.5. Tags

  • apiv1

3.2.7. list or watch objects of kind Endpoints

GET /api/v1/endpoints

3.2.7.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

false

string

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

3.2.7.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.45, “v1.EndpointsList”

3.2.7.3. Consumes

  • /

3.2.7.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf
  • application/json;stream=watch
  • application/vnd.kubernetes.protobuf;stream=watch

3.2.7.5. Tags

  • apiv1

3.2.8. create Endpoints

POST /api/v1/endpoints

3.2.8.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.44, “v1.Endpoints”

 

3.2.8.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.44, “v1.Endpoints”

3.2.8.3. Consumes

  • /

3.2.8.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.8.5. Tags

  • apiv1

3.2.9. list or watch objects of kind Event

GET /api/v1/events

3.2.9.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

false

string

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

3.2.9.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.50, “v1.EventList”

3.2.9.3. Consumes

  • /

3.2.9.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf
  • application/json;stream=watch
  • application/vnd.kubernetes.protobuf;stream=watch

3.2.9.5. Tags

  • apiv1

3.2.10. create an Event

POST /api/v1/events

3.2.10.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.49, “v1.Event”

 

3.2.10.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.49, “v1.Event”

3.2.10.3. Consumes

  • /

3.2.10.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.10.5. Tags

  • apiv1

3.2.11. list or watch objects of kind LimitRange

GET /api/v1/limitranges

3.2.11.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

false

string

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

3.2.11.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.74, “v1.LimitRangeList”

3.2.11.3. Consumes

  • /

3.2.11.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf
  • application/json;stream=watch
  • application/vnd.kubernetes.protobuf;stream=watch

3.2.11.5. Tags

  • apiv1

3.2.12. create a LimitRange

POST /api/v1/limitranges

3.2.12.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.72, “v1.LimitRange”

 

3.2.12.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.72, “v1.LimitRange”

3.2.12.3. Consumes

  • /

3.2.12.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.12.5. Tags

  • apiv1

3.2.13. list or watch objects of kind Namespace

GET /api/v1/namespaces

3.2.13.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

false

string

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

3.2.13.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.82, “v1.NamespaceList”

3.2.13.3. Consumes

  • /

3.2.13.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf
  • application/json;stream=watch
  • application/vnd.kubernetes.protobuf;stream=watch

3.2.13.5. Tags

  • apiv1

3.2.14. create a Namespace

POST /api/v1/namespaces

3.2.14.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.81, “v1.Namespace”

 

3.2.14.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.81, “v1.Namespace”

3.2.14.3. Consumes

  • /

3.2.14.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.14.5. Tags

  • apiv1

3.2.15. delete collection of Namespace

DELETE /api/v1/namespaces

3.2.15.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

false

string

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

3.2.15.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.264, “v1.Status”

3.2.15.3. Consumes

  • /

3.2.15.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.15.5. Tags

  • apiv1

3.2.16. create a Binding

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

3.2.16.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.10, “v1.Binding”

 

PathParameter

namespace

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

true

string

 

3.2.16.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.10, “v1.Binding”

3.2.16.3. Consumes

  • /

3.2.16.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.16.5. Tags

  • apiv1

3.2.17. list or watch objects of kind ConfigMap

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

3.2.17.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

false

string

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

3.2.17.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.21, “v1.ConfigMapList”

3.2.17.3. Consumes

  • /

3.2.17.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf
  • application/json;stream=watch
  • application/vnd.kubernetes.protobuf;stream=watch

3.2.17.5. Tags

  • apiv1

3.2.18. create a ConfigMap

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

3.2.18.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.18, “v1.ConfigMap”

 

PathParameter

namespace

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

true

string

 

3.2.18.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.18, “v1.ConfigMap”

3.2.18.3. Consumes

  • /

3.2.18.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.18.5. Tags

  • apiv1

3.2.19. delete collection of ConfigMap

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

3.2.19.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

false

string

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

3.2.19.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.264, “v1.Status”

3.2.19.3. Consumes

  • /

3.2.19.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.19.5. Tags

  • apiv1

3.2.20. read the specified ConfigMap

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

3.2.20.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

 

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.

false

boolean

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the ConfigMap

true

string

 

3.2.20.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.18, “v1.ConfigMap”

3.2.20.3. Consumes

  • /

3.2.20.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.20.5. Tags

  • apiv1

3.2.21. partially update the specified ConfigMap

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

3.2.21.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.180, “v1.Patch”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the ConfigMap

true

string

 

3.2.21.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.18, “v1.ConfigMap”

3.2.21.3. Consumes

  • application/json-patch+json
  • application/merge-patch+json
  • application/strategic-merge-patch+json

3.2.21.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.21.5. Tags

  • apiv1

3.2.22. replace the specified ConfigMap

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

3.2.22.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.18, “v1.ConfigMap”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the ConfigMap

true

string

 

3.2.22.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.18, “v1.ConfigMap”

3.2.22.3. Consumes

  • /

3.2.22.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.22.5. Tags

  • apiv1

3.2.23. delete a ConfigMap

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

3.2.23.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.61, “v1.DeleteOptions”

 

QueryParameter

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.

false

integer

 

QueryParameter

orphanDependents

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

false

boolean

 

QueryParameter

propagationPolicy

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.

false

string

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the ConfigMap

true

string

 

3.2.23.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.264, “v1.Status”

3.2.23.3. Consumes

  • /

3.2.23.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.23.5. Tags

  • apiv1

3.2.24. list or watch objects of kind Endpoints

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

3.2.24.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

false

string

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

3.2.24.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.45, “v1.EndpointsList”

3.2.24.3. Consumes

  • /

3.2.24.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf
  • application/json;stream=watch
  • application/vnd.kubernetes.protobuf;stream=watch

3.2.24.5. Tags

  • apiv1

3.2.25. create Endpoints

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

3.2.25.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.44, “v1.Endpoints”

 

PathParameter

namespace

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

true

string

 

3.2.25.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.44, “v1.Endpoints”

3.2.25.3. Consumes

  • /

3.2.25.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.25.5. Tags

  • apiv1

3.2.26. delete collection of Endpoints

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

3.2.26.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

false

string

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

3.2.26.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.264, “v1.Status”

3.2.26.3. Consumes

  • /

3.2.26.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.26.5. Tags

  • apiv1

3.2.27. read the specified Endpoints

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

3.2.27.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

 

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.

false

boolean

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Endpoints

true

string

 

3.2.27.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.44, “v1.Endpoints”

3.2.27.3. Consumes

  • /

3.2.27.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.27.5. Tags

  • apiv1

3.2.28. partially update the specified Endpoints

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

3.2.28.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.180, “v1.Patch”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Endpoints

true

string

 

3.2.28.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.44, “v1.Endpoints”

3.2.28.3. Consumes

  • application/json-patch+json
  • application/merge-patch+json
  • application/strategic-merge-patch+json

3.2.28.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.28.5. Tags

  • apiv1

3.2.29. replace the specified Endpoints

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

3.2.29.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.44, “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

 

3.2.29.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.44, “v1.Endpoints”

3.2.29.3. Consumes

  • /

3.2.29.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.29.5. Tags

  • apiv1

3.2.30. delete Endpoints

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

3.2.30.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.61, “v1.DeleteOptions”

 

QueryParameter

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.

false

integer

 

QueryParameter

orphanDependents

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

false

boolean

 

QueryParameter

propagationPolicy

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.

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

 

3.2.30.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.264, “v1.Status”

3.2.30.3. Consumes

  • /

3.2.30.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.30.5. Tags

  • apiv1

3.2.31. list or watch objects of kind Event

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

3.2.31.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

false

string

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

3.2.31.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.50, “v1.EventList”

3.2.31.3. Consumes

  • /

3.2.31.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf
  • application/json;stream=watch
  • application/vnd.kubernetes.protobuf;stream=watch

3.2.31.5. Tags

  • apiv1

3.2.32. create an Event

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

3.2.32.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.49, “v1.Event”

 

PathParameter

namespace

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

true

string

 

3.2.32.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.49, “v1.Event”

3.2.32.3. Consumes

  • /

3.2.32.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.32.5. Tags

  • apiv1

3.2.33. delete collection of Event

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

3.2.33.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

false

string

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

3.2.33.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.264, “v1.Status”

3.2.33.3. Consumes

  • /

3.2.33.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.33.5. Tags

  • apiv1

3.2.34. read the specified Event

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

3.2.34.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

 

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.

false

boolean

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Event

true

string

 

3.2.34.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.49, “v1.Event”

3.2.34.3. Consumes

  • /

3.2.34.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.34.5. Tags

  • apiv1

3.2.35. partially update the specified Event

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

3.2.35.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.180, “v1.Patch”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Event

true

string

 

3.2.35.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.49, “v1.Event”

3.2.35.3. Consumes

  • application/json-patch+json
  • application/merge-patch+json
  • application/strategic-merge-patch+json

3.2.35.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.35.5. Tags

  • apiv1

3.2.36. replace the specified Event

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

3.2.36.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.49, “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

 

3.2.36.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.49, “v1.Event”

3.2.36.3. Consumes

  • /

3.2.36.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.36.5. Tags

  • apiv1

3.2.37. delete an Event

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

3.2.37.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.61, “v1.DeleteOptions”

 

QueryParameter

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.

false

integer

 

QueryParameter

orphanDependents

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

false

boolean

 

QueryParameter

propagationPolicy

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.

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

 

3.2.37.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.264, “v1.Status”

3.2.37.3. Consumes

  • /

3.2.37.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.37.5. Tags

  • apiv1

3.2.38. list or watch objects of kind LimitRange

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

3.2.38.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

false

string

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

3.2.38.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.74, “v1.LimitRangeList”

3.2.38.3. Consumes

  • /

3.2.38.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf
  • application/json;stream=watch
  • application/vnd.kubernetes.protobuf;stream=watch

3.2.38.5. Tags

  • apiv1

3.2.39. create a LimitRange

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

3.2.39.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.72, “v1.LimitRange”

 

PathParameter

namespace

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

true

string

 

3.2.39.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.72, “v1.LimitRange”

3.2.39.3. Consumes

  • /

3.2.39.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.39.5. Tags

  • apiv1

3.2.40. delete collection of LimitRange

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

3.2.40.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

false

string

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

3.2.40.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.264, “v1.Status”

3.2.40.3. Consumes

  • /

3.2.40.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.40.5. Tags

  • apiv1

3.2.41. read the specified LimitRange

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

3.2.41.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

 

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.

false

boolean

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the LimitRange

true

string

 

3.2.41.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.72, “v1.LimitRange”

3.2.41.3. Consumes

  • /

3.2.41.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.41.5. Tags

  • apiv1

3.2.42. partially update the specified LimitRange

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

3.2.42.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.180, “v1.Patch”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the LimitRange

true

string

 

3.2.42.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.72, “v1.LimitRange”

3.2.42.3. Consumes

  • application/json-patch+json
  • application/merge-patch+json
  • application/strategic-merge-patch+json

3.2.42.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.42.5. Tags

  • apiv1

3.2.43. replace the specified LimitRange

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

3.2.43.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.72, “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

 

3.2.43.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.72, “v1.LimitRange”

3.2.43.3. Consumes

  • /

3.2.43.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.43.5. Tags

  • apiv1

3.2.44. delete a LimitRange

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

3.2.44.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.61, “v1.DeleteOptions”

 

QueryParameter

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.

false

integer

 

QueryParameter

orphanDependents

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

false

boolean

 

QueryParameter

propagationPolicy

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.

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

 

3.2.44.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.264, “v1.Status”

3.2.44.3. Consumes

  • /

3.2.44.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.44.5. Tags

  • apiv1

3.2.45. list or watch objects of kind PersistentVolumeClaim

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

3.2.45.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

false

string

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

3.2.45.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.105, “v1.PersistentVolumeClaimList”

3.2.45.3. Consumes

  • /

3.2.45.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf
  • application/json;stream=watch
  • application/vnd.kubernetes.protobuf;stream=watch

3.2.45.5. Tags

  • apiv1

3.2.46. create a PersistentVolumeClaim

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

3.2.46.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.104, “v1.PersistentVolumeClaim”

 

PathParameter

namespace

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

true

string

 

3.2.46.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.104, “v1.PersistentVolumeClaim”

3.2.46.3. Consumes

  • /

3.2.46.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.46.5. Tags

  • apiv1

3.2.47. delete collection of PersistentVolumeClaim

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

3.2.47.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

false

string

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

3.2.47.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.264, “v1.Status”

3.2.47.3. Consumes

  • /

3.2.47.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.47.5. Tags

  • apiv1

3.2.48. read the specified PersistentVolumeClaim

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

3.2.48.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

 

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.

false

boolean

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the PersistentVolumeClaim

true

string

 

3.2.48.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.104, “v1.PersistentVolumeClaim”

3.2.48.3. Consumes

  • /

3.2.48.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.48.5. Tags

  • apiv1

3.2.49. partially update the specified PersistentVolumeClaim

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

3.2.49.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.180, “v1.Patch”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the PersistentVolumeClaim

true

string

 

3.2.49.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.104, “v1.PersistentVolumeClaim”

3.2.49.3. Consumes

  • application/json-patch+json
  • application/merge-patch+json
  • application/strategic-merge-patch+json

3.2.49.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.49.5. Tags

  • apiv1

3.2.50. replace the specified PersistentVolumeClaim

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

3.2.50.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.104, “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

 

3.2.50.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.104, “v1.PersistentVolumeClaim”

3.2.50.3. Consumes

  • /

3.2.50.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.50.5. Tags

  • apiv1

3.2.51. delete a PersistentVolumeClaim

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

3.2.51.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.61, “v1.DeleteOptions”

 

QueryParameter

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.

false

integer

 

QueryParameter

orphanDependents

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

false

boolean

 

QueryParameter

propagationPolicy

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.

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

 

3.2.51.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.264, “v1.Status”

3.2.51.3. Consumes

  • /

3.2.51.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.51.5. Tags

  • apiv1

3.2.52. read status of the specified PersistentVolumeClaim

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

3.2.52.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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

 

3.2.52.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.104, “v1.PersistentVolumeClaim”

3.2.52.3. Consumes

  • /

3.2.52.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.52.5. Tags

  • apiv1

3.2.53. partially update status of the specified PersistentVolumeClaim

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

3.2.53.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.180, “v1.Patch”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the PersistentVolumeClaim

true

string

 

3.2.53.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.104, “v1.PersistentVolumeClaim”

3.2.53.3. Consumes

  • application/json-patch+json
  • application/merge-patch+json
  • application/strategic-merge-patch+json

3.2.53.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.53.5. Tags

  • apiv1

3.2.54. replace status of the specified PersistentVolumeClaim

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

3.2.54.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.104, “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

 

3.2.54.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.104, “v1.PersistentVolumeClaim”

3.2.54.3. Consumes

  • /

3.2.54.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.54.5. Tags

  • apiv1

3.2.55. list or watch objects of kind Pod

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

3.2.55.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

false

string

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

3.2.55.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.118, “v1.PodList”

3.2.55.3. Consumes

  • /

3.2.55.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf
  • application/json;stream=watch
  • application/vnd.kubernetes.protobuf;stream=watch

3.2.55.5. Tags

  • apiv1

3.2.56. create a Pod

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

3.2.56.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.113, “v1.Pod”

 

PathParameter

namespace

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

true

string

 

3.2.56.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.113, “v1.Pod”

3.2.56.3. Consumes

  • /

3.2.56.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.56.5. Tags

  • apiv1

3.2.57. delete collection of Pod

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

3.2.57.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

false

string

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

3.2.57.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.264, “v1.Status”

3.2.57.3. Consumes

  • /

3.2.57.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.57.5. Tags

  • apiv1

3.2.58. read the specified Pod

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

3.2.58.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

 

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.

false

boolean

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Pod

true

string

 

3.2.58.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.113, “v1.Pod”

3.2.58.3. Consumes

  • /

3.2.58.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.58.5. Tags

  • apiv1

3.2.59. partially update the specified Pod

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

3.2.59.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.180, “v1.Patch”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Pod

true

string

 

3.2.59.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.113, “v1.Pod”

3.2.59.3. Consumes

  • application/json-patch+json
  • application/merge-patch+json
  • application/strategic-merge-patch+json

3.2.59.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.59.5. Tags

  • apiv1

3.2.60. replace the specified Pod

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

3.2.60.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.113, “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

 

3.2.60.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.113, “v1.Pod”

3.2.60.3. Consumes

  • /

3.2.60.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.60.5. Tags

  • apiv1

3.2.61. delete a Pod

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

3.2.61.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.61, “v1.DeleteOptions”

 

QueryParameter

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.

false

integer

 

QueryParameter

orphanDependents

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

false

boolean

 

QueryParameter

propagationPolicy

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.

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

 

3.2.61.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.264, “v1.Status”

3.2.61.3. Consumes

  • /

3.2.61.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.61.5. Tags

  • apiv1

3.2.62. connect GET requests to attach of Pod

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

3.2.62.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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

 

3.2.62.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.62.3. Consumes

  • /

3.2.62.4. Produces

  • /

3.2.62.5. Tags

  • apiv1

3.2.63. connect POST requests to attach of Pod

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

3.2.63.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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

 

3.2.63.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.63.3. Consumes

  • /

3.2.63.4. Produces

  • /

3.2.63.5. Tags

  • apiv1

3.2.64. create binding of a Binding

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

3.2.64.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.10, “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

 

3.2.64.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.10, “v1.Binding”

3.2.64.3. Consumes

  • /

3.2.64.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.64.5. Tags

  • apiv1

3.2.65. create eviction of an Eviction

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

3.2.65.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.181, “v1beta1.Eviction”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Eviction

true

string

 

3.2.65.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.181, “v1beta1.Eviction”

3.2.65.3. Consumes

  • /

3.2.65.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.65.5. Tags

  • apiv1

3.2.66. connect GET requests to exec of Pod

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

3.2.66.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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

 

3.2.66.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.66.3. Consumes

  • /

3.2.66.4. Produces

  • /

3.2.66.5. Tags

  • apiv1

3.2.67. connect POST requests to exec of Pod

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

3.2.67.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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

 

3.2.67.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.67.3. Consumes

  • /

3.2.67.4. Produces

  • /

3.2.67.5. Tags

  • apiv1

3.2.68. read log of the specified Pod

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

3.2.68.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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

integer

 

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

integer

 

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

integer

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Pod

true

string

 

3.2.68.2. Responses

HTTP CodeDescriptionSchema

200

success

string

3.2.68.3. Consumes

  • /

3.2.68.4. Produces

  • text/plain
  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.68.5. Tags

  • apiv1

3.2.69. connect GET requests to portforward of Pod

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

3.2.69.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

ports

List of ports to forward Required when using WebSockets

false

integer

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Pod

true

string

 

3.2.69.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.69.3. Consumes

  • /

3.2.69.4. Produces

  • /

3.2.69.5. Tags

  • apiv1

3.2.70. connect POST requests to portforward of Pod

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

3.2.70.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

ports

List of ports to forward Required when using WebSockets

false

integer

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Pod

true

string

 

3.2.70.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.70.3. Consumes

  • /

3.2.70.4. Produces

  • /

3.2.70.5. Tags

  • apiv1

3.2.71. connect GET requests to proxy of Pod

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

3.2.71.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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

 

3.2.71.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.71.3. Consumes

  • /

3.2.71.4. Produces

  • /

3.2.71.5. Tags

  • apiv1

3.2.72. connect OPTIONS requests to proxy of Pod

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

3.2.72.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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

 

3.2.72.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.72.3. Consumes

  • /

3.2.72.4. Produces

  • /

3.2.72.5. Tags

  • apiv1

3.2.73. connect POST requests to proxy of Pod

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

3.2.73.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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

 

3.2.73.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.73.3. Consumes

  • /

3.2.73.4. Produces

  • /

3.2.73.5. Tags

  • apiv1

3.2.74. connect HEAD requests to proxy of Pod

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

3.2.74.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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

 

3.2.74.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.74.3. Consumes

  • /

3.2.74.4. Produces

  • /

3.2.74.5. Tags

  • apiv1

3.2.75. connect PUT requests to proxy of Pod

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

3.2.75.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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

 

3.2.75.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.75.3. Consumes

  • /

3.2.75.4. Produces

  • /

3.2.75.5. Tags

  • apiv1

3.2.76. connect DELETE requests to proxy of Pod

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

3.2.76.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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

 

3.2.76.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.76.3. Consumes

  • /

3.2.76.4. Produces

  • /

3.2.76.5. Tags

  • apiv1

3.2.77. connect GET requests to proxy of Pod

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

3.2.77.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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

 

3.2.77.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.77.3. Consumes

  • /

3.2.77.4. Produces

  • /

3.2.77.5. Tags

  • apiv1

3.2.78. connect OPTIONS requests to proxy of Pod

OPTIONS /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}

3.2.78.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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

 

3.2.78.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.78.3. Consumes

  • /

3.2.78.4. Produces

  • /

3.2.78.5. Tags

  • apiv1

3.2.79. connect POST requests to proxy of Pod

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

3.2.79.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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

 

3.2.79.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.79.3. Consumes

  • /

3.2.79.4. Produces

  • /

3.2.79.5. Tags

  • apiv1

3.2.80. connect HEAD requests to proxy of Pod

HEAD /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}

3.2.80.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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

 

3.2.80.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.80.3. Consumes

  • /

3.2.80.4. Produces

  • /

3.2.80.5. Tags

  • apiv1

3.2.81. connect PUT requests to proxy of Pod

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

3.2.81.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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

 

3.2.81.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.81.3. Consumes

  • /

3.2.81.4. Produces

  • /

3.2.81.5. Tags

  • apiv1

3.2.82. connect DELETE requests to proxy of Pod

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

3.2.82.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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

 

3.2.82.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.82.3. Consumes

  • /

3.2.82.4. Produces

  • /

3.2.82.5. Tags

  • apiv1

3.2.83. read status of the specified Pod

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

3.2.83.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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

 

3.2.83.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.113, “v1.Pod”

3.2.83.3. Consumes

  • /

3.2.83.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.83.5. Tags

  • apiv1

3.2.84. partially update status of the specified Pod

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

3.2.84.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.180, “v1.Patch”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Pod

true

string

 

3.2.84.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.113, “v1.Pod”

3.2.84.3. Consumes

  • application/json-patch+json
  • application/merge-patch+json
  • application/strategic-merge-patch+json

3.2.84.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.84.5. Tags

  • apiv1

3.2.85. replace status of the specified Pod

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

3.2.85.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.113, “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

 

3.2.85.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.113, “v1.Pod”

3.2.85.3. Consumes

  • /

3.2.85.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.85.5. Tags

  • apiv1

3.2.86. list or watch objects of kind PodTemplate

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

3.2.86.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

false

string

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

3.2.86.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.123, “v1.PodTemplateList”

3.2.86.3. Consumes

  • /

3.2.86.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf
  • application/json;stream=watch
  • application/vnd.kubernetes.protobuf;stream=watch

3.2.86.5. Tags

  • apiv1

3.2.87. create a PodTemplate

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

3.2.87.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.122, “v1.PodTemplate”

 

PathParameter

namespace

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

true

string

 

3.2.87.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.122, “v1.PodTemplate”

3.2.87.3. Consumes

  • /

3.2.87.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.87.5. Tags

  • apiv1

3.2.88. delete collection of PodTemplate

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

3.2.88.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

false

string

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

3.2.88.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.264, “v1.Status”

3.2.88.3. Consumes

  • /

3.2.88.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.88.5. Tags

  • apiv1

3.2.89. read the specified PodTemplate

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

3.2.89.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

 

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.

false

boolean

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the PodTemplate

true

string

 

3.2.89.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.122, “v1.PodTemplate”

3.2.89.3. Consumes

  • /

3.2.89.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.89.5. Tags

  • apiv1

3.2.90. partially update the specified PodTemplate

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

3.2.90.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.180, “v1.Patch”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the PodTemplate

true

string

 

3.2.90.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.122, “v1.PodTemplate”

3.2.90.3. Consumes

  • application/json-patch+json
  • application/merge-patch+json
  • application/strategic-merge-patch+json

3.2.90.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.90.5. Tags

  • apiv1

3.2.91. replace the specified PodTemplate

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

3.2.91.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.122, “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

 

3.2.91.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.122, “v1.PodTemplate”

3.2.91.3. Consumes

  • /

3.2.91.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.91.5. Tags

  • apiv1

3.2.92. delete a PodTemplate

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

3.2.92.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.61, “v1.DeleteOptions”

 

QueryParameter

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.

false

integer

 

QueryParameter

orphanDependents

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

false

boolean

 

QueryParameter

propagationPolicy

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.

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

 

3.2.92.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.264, “v1.Status”

3.2.92.3. Consumes

  • /

3.2.92.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.92.5. Tags

  • apiv1

3.2.93. list or watch objects of kind ReplicationController

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

3.2.93.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

false

string

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

3.2.93.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.134, “v1.ReplicationControllerList”

3.2.93.3. Consumes

  • /

3.2.93.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf
  • application/json;stream=watch
  • application/vnd.kubernetes.protobuf;stream=watch

3.2.93.5. Tags

  • apiv1

3.2.94. create a ReplicationController

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

3.2.94.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.132, “v1.ReplicationController”

 

PathParameter

namespace

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

true

string

 

3.2.94.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.132, “v1.ReplicationController”

3.2.94.3. Consumes

  • /

3.2.94.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.94.5. Tags

  • apiv1

3.2.95. delete collection of ReplicationController

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

3.2.95.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

false

string

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

3.2.95.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.264, “v1.Status”

3.2.95.3. Consumes

  • /

3.2.95.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.95.5. Tags

  • apiv1

3.2.96. read the specified ReplicationController

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

3.2.96.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

 

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.

false

boolean

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the ReplicationController

true

string

 

3.2.96.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.132, “v1.ReplicationController”

3.2.96.3. Consumes

  • /

3.2.96.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.96.5. Tags

  • apiv1

3.2.97. partially update the specified ReplicationController

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

3.2.97.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.180, “v1.Patch”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the ReplicationController

true

string

 

3.2.97.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.132, “v1.ReplicationController”

3.2.97.3. Consumes

  • application/json-patch+json
  • application/merge-patch+json
  • application/strategic-merge-patch+json

3.2.97.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.97.5. Tags

  • apiv1

3.2.98. replace the specified ReplicationController

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

3.2.98.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.132, “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

 

3.2.98.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.132, “v1.ReplicationController”

3.2.98.3. Consumes

  • /

3.2.98.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.98.5. Tags

  • apiv1

3.2.99. delete a ReplicationController

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

3.2.99.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.61, “v1.DeleteOptions”

 

QueryParameter

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.

false

integer

 

QueryParameter

orphanDependents

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

false

boolean

 

QueryParameter

propagationPolicy

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.

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

 

3.2.99.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.264, “v1.Status”

3.2.99.3. Consumes

  • /

3.2.99.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.99.5. Tags

  • apiv1

3.2.100. read scale of the specified Scale

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

3.2.100.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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 Scale

true

string

 

3.2.100.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.147, “v1.Scale”

3.2.100.3. Consumes

  • /

3.2.100.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.100.5. Tags

  • apiv1

3.2.101. partially update scale of the specified Scale

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

3.2.101.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.180, “v1.Patch”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Scale

true

string

 

3.2.101.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.147, “v1.Scale”

3.2.101.3. Consumes

  • application/json-patch+json
  • application/merge-patch+json
  • application/strategic-merge-patch+json

3.2.101.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.101.5. Tags

  • apiv1

3.2.102. replace scale of the specified Scale

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

3.2.102.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.147, “v1.Scale”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Scale

true

string

 

3.2.102.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.147, “v1.Scale”

3.2.102.3. Consumes

  • /

3.2.102.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.102.5. Tags

  • apiv1

3.2.103. read status of the specified ReplicationController

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

3.2.103.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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

 

3.2.103.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.132, “v1.ReplicationController”

3.2.103.3. Consumes

  • /

3.2.103.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.103.5. Tags

  • apiv1

3.2.104. partially update status of the specified ReplicationController

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

3.2.104.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.180, “v1.Patch”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the ReplicationController

true

string

 

3.2.104.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.132, “v1.ReplicationController”

3.2.104.3. Consumes

  • application/json-patch+json
  • application/merge-patch+json
  • application/strategic-merge-patch+json

3.2.104.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.104.5. Tags

  • apiv1

3.2.105. replace status of the specified ReplicationController

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

3.2.105.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.132, “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

 

3.2.105.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.132, “v1.ReplicationController”

3.2.105.3. Consumes

  • /

3.2.105.4. Produces

  • application/json
  • application/yaml
  • application/vnd.kubernetes.protobuf

3.2.105.5. Tags

  • apiv1

3.2.106. list or watch objects of kind ResourceQuota

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

3.2.106.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

false

string

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer