REST API Reference

OpenShift Enterprise 3.0

OpenShift Enterprise 3.0 REST API for Developers

Red Hat OpenShift Documentation Team

Abstract

The OpenShift Enterprise 3.0 distribution of Kubernetes includes the Kubernetes v1 REST API and the OpenShift v1 REST API. These are RESTful APIs accessible via HTTP(s) on the OpenShift Enterprise master servers.

These REST APIs can be used to manage end-user applications, the cluster, and the users of the cluster.


Chapter 1. Overview

The OpenShift distribution of Kubernetes includes the Kubernetes v1 REST API and the OpenShift v1 REST API. These are RESTful APIs accessible via HTTP(s) on the OpenShift master servers.

These REST APIs can be used to manage end-user applications, the cluster, and the users of the cluster.

Chapter 2. OpenShift v1 REST API

2.1. Overview

The OpenShift API exposes operations for managing an enterprise Kubernetes cluster, including security and user management, application deployments, image and source builds, HTTP(s) routing, and project management.

2.1.1. Version information

Version: v1

2.1.2. URI scheme

Host: 127.0.0.1:8443 BasePath: / Schemes: HTTPS

2.2. Paths

2.2.1. list or watch objects of kind BuildConfig

GET /oapi/v1/buildconfigs

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

false

string

 

2.2.1.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.34, “v1.BuildConfigList”

2.2.1.3. Consumes

  • /

2.2.1.4. Produces

  • application/json

2.2.1.5. Tags

  • oapiv1

2.2.2. create a BuildConfig

POST /oapi/v1/buildconfigs

2.2.2.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.56, “v1.BuildConfig”

 

2.2.2.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.56, “v1.BuildConfig”

2.2.2.3. Consumes

  • /

2.2.2.4. Produces

  • application/json

2.2.2.5. Tags

  • oapiv1

2.2.3. list or watch objects of kind Build

GET /oapi/v1/builds

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

false

string

 

2.2.3.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.94, “v1.BuildList”

2.2.3.3. Consumes

  • /

2.2.3.4. Produces

  • application/json

2.2.3.5. Tags

  • oapiv1

2.2.4. create a Build

POST /oapi/v1/builds

2.2.4.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.26, “v1.Build”

 

2.2.4.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.26, “v1.Build”

2.2.4.3. Consumes

  • /

2.2.4.4. Produces

  • application/json

2.2.4.5. Tags

  • oapiv1

2.2.5. list or watch objects of kind ClusterNetwork

GET /oapi/v1/clusternetworks

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

false

string

 

2.2.5.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.38, “v1.ClusterNetworkList”

2.2.5.3. Consumes

  • /

2.2.5.4. Produces

  • application/json

2.2.5.5. Tags

  • oapiv1

2.2.6. create a ClusterNetwork

POST /oapi/v1/clusternetworks

2.2.6.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.46, “v1.ClusterNetwork”

 

2.2.6.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.46, “v1.ClusterNetwork”

2.2.6.3. Consumes

  • /

2.2.6.4. Produces

  • application/json

2.2.6.5. Tags

  • oapiv1

2.2.7. read the specified ClusterNetwork

GET /oapi/v1/clusternetworks/{name}

2.2.7.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

PathParameter

name

name of the ClusterNetwork

true

string

 

2.2.7.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.46, “v1.ClusterNetwork”

2.2.7.3. Consumes

  • /

2.2.7.4. Produces

  • application/json

2.2.7.5. Tags

  • oapiv1

2.2.8. replace the specified ClusterNetwork

PUT /oapi/v1/clusternetworks/{name}

2.2.8.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.46, “v1.ClusterNetwork”

 

PathParameter

name

name of the ClusterNetwork

true

string

 

2.2.8.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.46, “v1.ClusterNetwork”

2.2.8.3. Consumes

  • /

2.2.8.4. Produces

  • application/json

2.2.8.5. Tags

  • oapiv1

2.2.9. delete a ClusterNetwork

DELETE /oapi/v1/clusternetworks/{name}

2.2.9.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

name

name of the ClusterNetwork

true

string

 

2.2.9.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

2.2.9.3. Consumes

  • /

2.2.9.4. Produces

  • application/json

2.2.9.5. Tags

  • oapiv1

2.2.10. partially update the specified ClusterNetwork

PATCH /oapi/v1/clusternetworks/{name}

2.2.10.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

name

name of the ClusterNetwork

true

string

 

2.2.10.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.46, “v1.ClusterNetwork”

2.2.10.3. Consumes

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

2.2.10.4. Produces

  • application/json

2.2.10.5. Tags

  • oapiv1

2.2.11. list or watch objects of kind ClusterPolicy

GET /oapi/v1/clusterpolicies

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

false

string

 

2.2.11.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.138, “v1.ClusterPolicyList”

2.2.11.3. Consumes

  • /

2.2.11.4. Produces

  • application/json

2.2.11.5. Tags

  • oapiv1

2.2.12. create a ClusterPolicy

POST /oapi/v1/clusterpolicies

2.2.12.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.76, “v1.ClusterPolicy”

 

2.2.12.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.76, “v1.ClusterPolicy”

2.2.12.3. Consumes

  • /

2.2.12.4. Produces

  • application/json

2.2.12.5. Tags

  • oapiv1

2.2.13. read the specified ClusterPolicy

GET /oapi/v1/clusterpolicies/{name}

2.2.13.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

PathParameter

name

name of the ClusterPolicy

true

string

 

2.2.13.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.76, “v1.ClusterPolicy”

2.2.13.3. Consumes

  • /

2.2.13.4. Produces

  • application/json

2.2.13.5. Tags

  • oapiv1

2.2.14. replace the specified ClusterPolicy

PUT /oapi/v1/clusterpolicies/{name}

2.2.14.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.76, “v1.ClusterPolicy”

 

PathParameter

name

name of the ClusterPolicy

true

string

 

2.2.14.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.76, “v1.ClusterPolicy”

2.2.14.3. Consumes

  • /

2.2.14.4. Produces

  • application/json

2.2.14.5. Tags

  • oapiv1

2.2.15. delete a ClusterPolicy

DELETE /oapi/v1/clusterpolicies/{name}

2.2.15.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

name

name of the ClusterPolicy

true

string

 

2.2.15.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

2.2.15.3. Consumes

  • /

2.2.15.4. Produces

  • application/json

2.2.15.5. Tags

  • oapiv1

2.2.16. partially update the specified ClusterPolicy

PATCH /oapi/v1/clusterpolicies/{name}

2.2.16.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

name

name of the ClusterPolicy

true

string

 

2.2.16.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.76, “v1.ClusterPolicy”

2.2.16.3. Consumes

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

2.2.16.4. Produces

  • application/json

2.2.16.5. Tags

  • oapiv1

2.2.17. list or watch objects of kind ClusterPolicyBinding

GET /oapi/v1/clusterpolicybindings

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

false

string

 

2.2.17.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.113, “v1.ClusterPolicyBindingList”

2.2.17.3. Consumes

  • /

2.2.17.4. Produces

  • application/json

2.2.17.5. Tags

  • oapiv1

2.2.18. create a ClusterPolicyBinding

POST /oapi/v1/clusterpolicybindings

2.2.18.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.12, “v1.ClusterPolicyBinding”

 

2.2.18.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.12, “v1.ClusterPolicyBinding”

2.2.18.3. Consumes

  • /

2.2.18.4. Produces

  • application/json

2.2.18.5. Tags

  • oapiv1

2.2.19. read the specified ClusterPolicyBinding

GET /oapi/v1/clusterpolicybindings/{name}

2.2.19.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

PathParameter

name

name of the ClusterPolicyBinding

true

string

 

2.2.19.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.12, “v1.ClusterPolicyBinding”

2.2.19.3. Consumes

  • /

2.2.19.4. Produces

  • application/json

2.2.19.5. Tags

  • oapiv1

2.2.20. replace the specified ClusterPolicyBinding

PUT /oapi/v1/clusterpolicybindings/{name}

2.2.20.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.12, “v1.ClusterPolicyBinding”

 

PathParameter

name

name of the ClusterPolicyBinding

true

string

 

2.2.20.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.12, “v1.ClusterPolicyBinding”

2.2.20.3. Consumes

  • /

2.2.20.4. Produces

  • application/json

2.2.20.5. Tags

  • oapiv1

2.2.21. delete a ClusterPolicyBinding

DELETE /oapi/v1/clusterpolicybindings/{name}

2.2.21.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

name

name of the ClusterPolicyBinding

true

string

 

2.2.21.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

2.2.21.3. Consumes

  • /

2.2.21.4. Produces

  • application/json

2.2.21.5. Tags

  • oapiv1

2.2.22. partially update the specified ClusterPolicyBinding

PATCH /oapi/v1/clusterpolicybindings/{name}

2.2.22.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

name

name of the ClusterPolicyBinding

true

string

 

2.2.22.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.12, “v1.ClusterPolicyBinding”

2.2.22.3. Consumes

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

2.2.22.4. Produces

  • application/json

2.2.22.5. Tags

  • oapiv1

2.2.23. list objects of kind ClusterRoleBinding

GET /oapi/v1/clusterrolebindings

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

false

string

 

2.2.23.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.126, “v1.ClusterRoleBindingList”

2.2.23.3. Consumes

  • /

2.2.23.4. Produces

  • application/json

2.2.23.5. Tags

  • oapiv1

2.2.24. create a ClusterRoleBinding

POST /oapi/v1/clusterrolebindings

2.2.24.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.43, “v1.ClusterRoleBinding”

 

2.2.24.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.43, “v1.ClusterRoleBinding”

2.2.24.3. Consumes

  • /

2.2.24.4. Produces

  • application/json

2.2.24.5. Tags

  • oapiv1

2.2.25. read the specified ClusterRoleBinding

GET /oapi/v1/clusterrolebindings/{name}

2.2.25.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

PathParameter

name

name of the ClusterRoleBinding

true

string

 

2.2.25.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.43, “v1.ClusterRoleBinding”

2.2.25.3. Consumes

  • /

2.2.25.4. Produces

  • application/json

2.2.25.5. Tags

  • oapiv1

2.2.26. replace the specified ClusterRoleBinding

PUT /oapi/v1/clusterrolebindings/{name}

2.2.26.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.43, “v1.ClusterRoleBinding”

 

PathParameter

name

name of the ClusterRoleBinding

true

string

 

2.2.26.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.43, “v1.ClusterRoleBinding”

2.2.26.3. Consumes

  • /

2.2.26.4. Produces

  • application/json

2.2.26.5. Tags

  • oapiv1

2.2.27. delete a ClusterRoleBinding

DELETE /oapi/v1/clusterrolebindings/{name}

2.2.27.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

name

name of the ClusterRoleBinding

true

string

 

2.2.27.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

2.2.27.3. Consumes

  • /

2.2.27.4. Produces

  • application/json

2.2.27.5. Tags

  • oapiv1

2.2.28. partially update the specified ClusterRoleBinding

PATCH /oapi/v1/clusterrolebindings/{name}

2.2.28.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

name

name of the ClusterRoleBinding

true

string

 

2.2.28.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.43, “v1.ClusterRoleBinding”

2.2.28.3. Consumes

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

2.2.28.4. Produces

  • application/json

2.2.28.5. Tags

  • oapiv1

2.2.29. list objects of kind ClusterRole

GET /oapi/v1/clusterroles

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

false

string

 

2.2.29.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “v1.ClusterRoleList”

2.2.29.3. Consumes

  • /

2.2.29.4. Produces

  • application/json

2.2.29.5. Tags

  • oapiv1

2.2.30. create a ClusterRole

POST /oapi/v1/clusterroles

2.2.30.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.144, “v1.ClusterRole”

 

2.2.30.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.144, “v1.ClusterRole”

2.2.30.3. Consumes

  • /

2.2.30.4. Produces

  • application/json

2.2.30.5. Tags

  • oapiv1

2.2.31. read the specified ClusterRole

GET /oapi/v1/clusterroles/{name}

2.2.31.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

PathParameter

name

name of the ClusterRole

true

string

 

2.2.31.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.144, “v1.ClusterRole”

2.2.31.3. Consumes

  • /

2.2.31.4. Produces

  • application/json

2.2.31.5. Tags

  • oapiv1

2.2.32. replace the specified ClusterRole

PUT /oapi/v1/clusterroles/{name}

2.2.32.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.144, “v1.ClusterRole”

 

PathParameter

name

name of the ClusterRole

true

string

 

2.2.32.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.144, “v1.ClusterRole”

2.2.32.3. Consumes

  • /

2.2.32.4. Produces

  • application/json

2.2.32.5. Tags

  • oapiv1

2.2.33. delete a ClusterRole

DELETE /oapi/v1/clusterroles/{name}

2.2.33.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

name

name of the ClusterRole

true

string

 

2.2.33.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

2.2.33.3. Consumes

  • /

2.2.33.4. Produces

  • application/json

2.2.33.5. Tags

  • oapiv1

2.2.34. partially update the specified ClusterRole

PATCH /oapi/v1/clusterroles/{name}

2.2.34.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

name

name of the ClusterRole

true

string

 

2.2.34.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.144, “v1.ClusterRole”

2.2.34.3. Consumes

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

2.2.34.4. Produces

  • application/json

2.2.34.5. Tags

  • oapiv1

2.2.35. create a DeploymentConfigRollback

POST /oapi/v1/deploymentconfigrollbacks

2.2.35.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.67, “v1.DeploymentConfigRollback”

 

2.2.35.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.67, “v1.DeploymentConfigRollback”

2.2.35.3. Consumes

  • /

2.2.35.4. Produces

  • application/json

2.2.35.5. Tags

  • oapiv1

2.2.36. list or watch objects of kind DeploymentConfig

GET /oapi/v1/deploymentconfigs

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

false

string

 

2.2.36.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.51, “v1.DeploymentConfigList”

2.2.36.3. Consumes

  • /

2.2.36.4. Produces

  • application/json

2.2.36.5. Tags

  • oapiv1

2.2.37. create a DeploymentConfig

POST /oapi/v1/deploymentconfigs

2.2.37.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.31, “v1.DeploymentConfig”

 

2.2.37.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.31, “v1.DeploymentConfig”

2.2.37.3. Consumes

  • /

2.2.37.4. Produces

  • application/json

2.2.37.5. Tags

  • oapiv1

2.2.38. list or watch objects of kind Group

GET /oapi/v1/groups

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

false

string

 

2.2.38.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.5, “v1.GroupList”

2.2.38.3. Consumes

  • /

2.2.38.4. Produces

  • application/json

2.2.38.5. Tags

  • oapiv1

2.2.39. create a Group

POST /oapi/v1/groups

2.2.39.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.52, “v1.Group”

 

2.2.39.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.52, “v1.Group”

2.2.39.3. Consumes

  • /

2.2.39.4. Produces

  • application/json

2.2.39.5. Tags

  • oapiv1

2.2.40. read the specified Group

GET /oapi/v1/groups/{name}

2.2.40.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

PathParameter

name

name of the Group

true

string

 

2.2.40.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.52, “v1.Group”

2.2.40.3. Consumes

  • /

2.2.40.4. Produces

  • application/json

2.2.40.5. Tags

  • oapiv1

2.2.41. replace the specified Group

PUT /oapi/v1/groups/{name}

2.2.41.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.52, “v1.Group”

 

PathParameter

name

name of the Group

true

string

 

2.2.41.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.52, “v1.Group”

2.2.41.3. Consumes

  • /

2.2.41.4. Produces

  • application/json

2.2.41.5. Tags

  • oapiv1

2.2.42. delete a Group

DELETE /oapi/v1/groups/{name}

2.2.42.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

name

name of the Group

true

string

 

2.2.42.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

2.2.42.3. Consumes

  • /

2.2.42.4. Produces

  • application/json

2.2.42.5. Tags

  • oapiv1

2.2.43. partially update the specified Group

PATCH /oapi/v1/groups/{name}

2.2.43.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

name

name of the Group

true

string

 

2.2.43.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.52, “v1.Group”

2.2.43.3. Consumes

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

2.2.43.4. Produces

  • application/json

2.2.43.5. Tags

  • oapiv1

2.2.44. list or watch objects of kind HostSubnet

GET /oapi/v1/hostsubnets

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

false

string

 

2.2.44.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.4, “v1.HostSubnetList”

2.2.44.3. Consumes

  • /

2.2.44.4. Produces

  • application/json

2.2.44.5. Tags

  • oapiv1

2.2.45. create a HostSubnet

POST /oapi/v1/hostsubnets

2.2.45.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.11, “v1.HostSubnet”

 

2.2.45.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.11, “v1.HostSubnet”

2.2.45.3. Consumes

  • /

2.2.45.4. Produces

  • application/json

2.2.45.5. Tags

  • oapiv1

2.2.46. read the specified HostSubnet

GET /oapi/v1/hostsubnets/{name}

2.2.46.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

PathParameter

name

name of the HostSubnet

true

string

 

2.2.46.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.11, “v1.HostSubnet”

2.2.46.3. Consumes

  • /

2.2.46.4. Produces

  • application/json

2.2.46.5. Tags

  • oapiv1

2.2.47. replace the specified HostSubnet

PUT /oapi/v1/hostsubnets/{name}

2.2.47.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.11, “v1.HostSubnet”

 

PathParameter

name

name of the HostSubnet

true

string

 

2.2.47.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.11, “v1.HostSubnet”

2.2.47.3. Consumes

  • /

2.2.47.4. Produces

  • application/json

2.2.47.5. Tags

  • oapiv1

2.2.48. delete a HostSubnet

DELETE /oapi/v1/hostsubnets/{name}

2.2.48.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

name

name of the HostSubnet

true

string

 

2.2.48.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

2.2.48.3. Consumes

  • /

2.2.48.4. Produces

  • application/json

2.2.48.5. Tags

  • oapiv1

2.2.49. partially update the specified HostSubnet

PATCH /oapi/v1/hostsubnets/{name}

2.2.49.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

name

name of the HostSubnet

true

string

 

2.2.49.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.11, “v1.HostSubnet”

2.2.49.3. Consumes

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

2.2.49.4. Produces

  • application/json

2.2.49.5. Tags

  • oapiv1

2.2.50. list or watch objects of kind Identity

GET /oapi/v1/identities

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

false

string

 

2.2.50.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.89, “v1.IdentityList”

2.2.50.3. Consumes

  • /

2.2.50.4. Produces

  • application/json

2.2.50.5. Tags

  • oapiv1

2.2.51. create a Identity

POST /oapi/v1/identities

2.2.51.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.71, “v1.Identity”

 

2.2.51.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.71, “v1.Identity”

2.2.51.3. Consumes

  • /

2.2.51.4. Produces

  • application/json

2.2.51.5. Tags

  • oapiv1

2.2.52. read the specified Identity

GET /oapi/v1/identities/{name}

2.2.52.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

PathParameter

name

name of the Identity

true

string

 

2.2.52.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.71, “v1.Identity”

2.2.52.3. Consumes

  • /

2.2.52.4. Produces

  • application/json

2.2.52.5. Tags

  • oapiv1

2.2.53. replace the specified Identity

PUT /oapi/v1/identities/{name}

2.2.53.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.71, “v1.Identity”

 

PathParameter

name

name of the Identity

true

string

 

2.2.53.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.71, “v1.Identity”

2.2.53.3. Consumes

  • /

2.2.53.4. Produces

  • application/json

2.2.53.5. Tags

  • oapiv1

2.2.54. delete a Identity

DELETE /oapi/v1/identities/{name}

2.2.54.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

name

name of the Identity

true

string

 

2.2.54.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

2.2.54.3. Consumes

  • /

2.2.54.4. Produces

  • application/json

2.2.54.5. Tags

  • oapiv1

2.2.55. partially update the specified Identity

PATCH /oapi/v1/identities/{name}

2.2.55.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

name

name of the Identity

true

string

 

2.2.55.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.71, “v1.Identity”

2.2.55.3. Consumes

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

2.2.55.4. Produces

  • application/json

2.2.55.5. Tags

  • oapiv1

2.2.56. list or watch objects of kind Image

GET /oapi/v1/images

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

false

string

 

2.2.56.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.39, “v1.ImageList”

2.2.56.3. Consumes

  • /

2.2.56.4. Produces

  • application/json

2.2.56.5. Tags

  • oapiv1

2.2.57. create a Image

POST /oapi/v1/images

2.2.57.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.91, “v1.Image”

 

2.2.57.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.91, “v1.Image”

2.2.57.3. Consumes

  • /

2.2.57.4. Produces

  • application/json

2.2.57.5. Tags

  • oapiv1

2.2.58. read the specified Image

GET /oapi/v1/images/{name}

2.2.58.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

PathParameter

name

name of the Image

true

string

 

2.2.58.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.91, “v1.Image”

2.2.58.3. Consumes

  • /

2.2.58.4. Produces

  • application/json

2.2.58.5. Tags

  • oapiv1

2.2.59. delete a Image

DELETE /oapi/v1/images/{name}

2.2.59.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

name

name of the Image

true

string

 

2.2.59.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

2.2.59.3. Consumes

  • /

2.2.59.4. Produces

  • application/json

2.2.59.5. Tags

  • oapiv1

2.2.60. create a ImageStreamMapping

POST /oapi/v1/imagestreammappings

2.2.60.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.135, “v1.ImageStreamMapping”

 

2.2.60.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.135, “v1.ImageStreamMapping”

2.2.60.3. Consumes

  • /

2.2.60.4. Produces

  • application/json

2.2.60.5. Tags

  • oapiv1

2.2.61. list or watch objects of kind ImageStream

GET /oapi/v1/imagestreams

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

false

string

 

2.2.61.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.87, “v1.ImageStreamList”

2.2.61.3. Consumes

  • /

2.2.61.4. Produces

  • application/json

2.2.61.5. Tags

  • oapiv1

2.2.62. create a ImageStream

POST /oapi/v1/imagestreams

2.2.62.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.146, “v1.ImageStream”

 

2.2.62.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.146, “v1.ImageStream”

2.2.62.3. Consumes

  • /

2.2.62.4. Produces

  • application/json

2.2.62.5. Tags

  • oapiv1

2.2.63. create a LocalResourceAccessReview

POST /oapi/v1/localresourceaccessreviews

2.2.63.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.139, “v1.LocalResourceAccessReview”

 

2.2.63.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.139, “v1.LocalResourceAccessReview”

2.2.63.3. Consumes

  • /

2.2.63.4. Produces

  • application/json

2.2.63.5. Tags

  • oapiv1

2.2.64. create a LocalSubjectAccessReview

POST /oapi/v1/localsubjectaccessreviews

2.2.64.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.22, “v1.LocalSubjectAccessReview”

 

2.2.64.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.22, “v1.LocalSubjectAccessReview”

2.2.64.3. Consumes

  • /

2.2.64.4. Produces

  • application/json

2.2.64.5. Tags

  • oapiv1

2.2.65. list or watch objects of kind BuildConfig

GET /oapi/v1/namespaces/{namespace}/buildconfigs

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

false

string

 

PathParameter

namespace

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

true

string

 

2.2.65.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.34, “v1.BuildConfigList”

2.2.65.3. Consumes

  • /

2.2.65.4. Produces

  • application/json

2.2.65.5. Tags

  • oapiv1

2.2.66. create a BuildConfig

POST /oapi/v1/namespaces/{namespace}/buildconfigs

2.2.66.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.56, “v1.BuildConfig”

 

PathParameter

namespace

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

true

string

 

2.2.66.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.56, “v1.BuildConfig”

2.2.66.3. Consumes

  • /

2.2.66.4. Produces

  • application/json

2.2.66.5. Tags

  • oapiv1

2.2.67. read the specified BuildConfig

GET /oapi/v1/namespaces/{namespace}/buildconfigs/{name}

2.2.67.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 BuildConfig

true

string

 

2.2.67.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.56, “v1.BuildConfig”

2.2.67.3. Consumes

  • /

2.2.67.4. Produces

  • application/json

2.2.67.5. Tags

  • oapiv1

2.2.68. replace the specified BuildConfig

PUT /oapi/v1/namespaces/{namespace}/buildconfigs/{name}

2.2.68.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.56, “v1.BuildConfig”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the BuildConfig

true

string

 

2.2.68.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.56, “v1.BuildConfig”

2.2.68.3. Consumes

  • /

2.2.68.4. Produces

  • application/json

2.2.68.5. Tags

  • oapiv1

2.2.69. delete a BuildConfig

DELETE /oapi/v1/namespaces/{namespace}/buildconfigs/{name}

2.2.69.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the BuildConfig

true

string

 

2.2.69.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

2.2.69.3. Consumes

  • /

2.2.69.4. Produces

  • application/json

2.2.69.5. Tags

  • oapiv1

2.2.70. partially update the specified BuildConfig

PATCH /oapi/v1/namespaces/{namespace}/buildconfigs/{name}

2.2.70.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the BuildConfig

true

string

 

2.2.70.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.56, “v1.BuildConfig”

2.2.70.3. Consumes

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

2.2.70.4. Produces

  • application/json

2.2.70.5. Tags

  • oapiv1

2.2.71. create instantiate of a BuildRequest

POST /oapi/v1/namespaces/{namespace}/buildconfigs/{name}/instantiate

2.2.71.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.14, “v1.BuildRequest”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the BuildRequest

true

string

 

2.2.71.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.14, “v1.BuildRequest”

2.2.71.3. Consumes

  • /

2.2.71.4. Produces

  • application/json

2.2.71.5. Tags

  • oapiv1

2.2.72. connect POST requests to webhooks of Status

POST /oapi/v1/namespaces/{namespace}/buildconfigs/{name}/webhooks

2.2.72.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

URL path to use in 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 Status

true

string

 

2.2.72.2. Responses

HTTP CodeDescriptionSchema

default

success

string

2.2.72.3. Consumes

  • /

2.2.72.4. Produces

  • /

2.2.72.5. Tags

  • oapiv1

2.2.73. connect POST requests to webhooks of Status

POST /oapi/v1/namespaces/{namespace}/buildconfigs/{name}/webhooks/{path:*}

2.2.73.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

URL path to use in 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 Status

true

string

 

PathParameter

path:*

path to the resource

true

string

 

2.2.73.2. Responses

HTTP CodeDescriptionSchema

default

success

string

2.2.73.3. Consumes

  • /

2.2.73.4. Produces

  • /

2.2.73.5. Tags

  • oapiv1

2.2.74. list or watch objects of kind Build

GET /oapi/v1/namespaces/{namespace}/builds

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

false

string

 

PathParameter

namespace

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

true

string

 

2.2.74.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.94, “v1.BuildList”

2.2.74.3. Consumes

  • /

2.2.74.4. Produces

  • application/json

2.2.74.5. Tags

  • oapiv1

2.2.75. create a Build

POST /oapi/v1/namespaces/{namespace}/builds

2.2.75.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.26, “v1.Build”

 

PathParameter

namespace

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

true

string

 

2.2.75.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.26, “v1.Build”

2.2.75.3. Consumes

  • /

2.2.75.4. Produces

  • application/json

2.2.75.5. Tags

  • oapiv1

2.2.76. read the specified Build

GET /oapi/v1/namespaces/{namespace}/builds/{name}

2.2.76.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 Build

true

string

 

2.2.76.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.26, “v1.Build”

2.2.76.3. Consumes

  • /

2.2.76.4. Produces

  • application/json

2.2.76.5. Tags

  • oapiv1

2.2.77. replace the specified Build

PUT /oapi/v1/namespaces/{namespace}/builds/{name}

2.2.77.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.26, “v1.Build”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Build

true

string

 

2.2.77.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.26, “v1.Build”

2.2.77.3. Consumes

  • /

2.2.77.4. Produces

  • application/json

2.2.77.5. Tags

  • oapiv1

2.2.78. delete a Build

DELETE /oapi/v1/namespaces/{namespace}/builds/{name}

2.2.78.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Build

true

string

 

2.2.78.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

2.2.78.3. Consumes

  • /

2.2.78.4. Produces

  • application/json

2.2.78.5. Tags

  • oapiv1

2.2.79. partially update the specified Build

PATCH /oapi/v1/namespaces/{namespace}/builds/{name}

2.2.79.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Build

true

string

 

2.2.79.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.26, “v1.Build”

2.2.79.3. Consumes

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

2.2.79.4. Produces

  • application/json

2.2.79.5. Tags

  • oapiv1

2.2.80. create clone of a BuildRequest

POST /oapi/v1/namespaces/{namespace}/builds/{name}/clone

2.2.80.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.14, “v1.BuildRequest”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the BuildRequest

true

string

 

2.2.80.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.14, “v1.BuildRequest”

2.2.80.3. Consumes

  • /

2.2.80.4. Produces

  • application/json

2.2.80.5. Tags

  • oapiv1

2.2.81. read log of the specified BuildLog

GET /oapi/v1/namespaces/{namespace}/builds/{name}/log

2.2.81.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

follow

if true indicates that the log should be streamed; defaults to false

false

boolean

 

QueryParameter

nowait

if true indicates that the server should not wait for a log to be available before returning; defaults to false

false

boolean

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the BuildLog

true

string

 

2.2.81.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.66, “v1.BuildLog”

2.2.81.3. Consumes

  • /

2.2.81.4. Produces

  • application/json

2.2.81.5. Tags

  • oapiv1

2.2.82. create a DeploymentConfigRollback

POST /oapi/v1/namespaces/{namespace}/deploymentconfigrollbacks

2.2.82.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.67, “v1.DeploymentConfigRollback”

 

PathParameter

namespace

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

true

string

 

2.2.82.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.67, “v1.DeploymentConfigRollback”

2.2.82.3. Consumes

  • /

2.2.82.4. Produces

  • application/json

2.2.82.5. Tags

  • oapiv1

2.2.83. list or watch objects of kind DeploymentConfig

GET /oapi/v1/namespaces/{namespace}/deploymentconfigs

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

false

string

 

PathParameter

namespace

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

true

string

 

2.2.83.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.51, “v1.DeploymentConfigList”

2.2.83.3. Consumes

  • /

2.2.83.4. Produces

  • application/json

2.2.83.5. Tags

  • oapiv1

2.2.84. create a DeploymentConfig

POST /oapi/v1/namespaces/{namespace}/deploymentconfigs

2.2.84.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.31, “v1.DeploymentConfig”

 

PathParameter

namespace

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

true

string

 

2.2.84.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.31, “v1.DeploymentConfig”

2.2.84.3. Consumes

  • /

2.2.84.4. Produces

  • application/json

2.2.84.5. Tags

  • oapiv1

2.2.85. read the specified DeploymentConfig

GET /oapi/v1/namespaces/{namespace}/deploymentconfigs/{name}

2.2.85.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 DeploymentConfig

true

string

 

2.2.85.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.31, “v1.DeploymentConfig”

2.2.85.3. Consumes

  • /

2.2.85.4. Produces

  • application/json

2.2.85.5. Tags

  • oapiv1

2.2.86. replace the specified DeploymentConfig

PUT /oapi/v1/namespaces/{namespace}/deploymentconfigs/{name}

2.2.86.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.31, “v1.DeploymentConfig”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the DeploymentConfig

true

string

 

2.2.86.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.31, “v1.DeploymentConfig”

2.2.86.3. Consumes

  • /

2.2.86.4. Produces

  • application/json

2.2.86.5. Tags

  • oapiv1

2.2.87. delete a DeploymentConfig

DELETE /oapi/v1/namespaces/{namespace}/deploymentconfigs/{name}

2.2.87.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the DeploymentConfig

true

string

 

2.2.87.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

2.2.87.3. Consumes

  • /

2.2.87.4. Produces

  • application/json

2.2.87.5. Tags

  • oapiv1

2.2.88. partially update the specified DeploymentConfig

PATCH /oapi/v1/namespaces/{namespace}/deploymentconfigs/{name}

2.2.88.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the DeploymentConfig

true

string

 

2.2.88.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.31, “v1.DeploymentConfig”

2.2.88.3. Consumes

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

2.2.88.4. Produces

  • application/json

2.2.88.5. Tags

  • oapiv1

2.2.89. read the specified DeploymentConfig

GET /oapi/v1/namespaces/{namespace}/generatedeploymentconfigs/{name}

2.2.89.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 DeploymentConfig

true

string

 

2.2.89.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.31, “v1.DeploymentConfig”

2.2.89.3. Consumes

  • /

2.2.89.4. Produces

  • application/json

2.2.89.5. Tags

  • oapiv1

2.2.90. read the specified ImageStreamImage

GET /oapi/v1/namespaces/{namespace}/imagestreamimages/{name}

2.2.90.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 ImageStreamImage

true

string

 

2.2.90.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.92, “v1.ImageStreamImage”

2.2.90.3. Consumes

  • /

2.2.90.4. Produces

  • application/json

2.2.90.5. Tags

  • oapiv1

2.2.91. create a ImageStreamMapping

POST /oapi/v1/namespaces/{namespace}/imagestreammappings

2.2.91.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.135, “v1.ImageStreamMapping”

 

PathParameter

namespace

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

true

string

 

2.2.91.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.135, “v1.ImageStreamMapping”

2.2.91.3. Consumes

  • /

2.2.91.4. Produces

  • application/json

2.2.91.5. Tags

  • oapiv1

2.2.92. list or watch objects of kind ImageStream

GET /oapi/v1/namespaces/{namespace}/imagestreams

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

false

string

 

PathParameter

namespace

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

true

string

 

2.2.92.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.87, “v1.ImageStreamList”

2.2.92.3. Consumes

  • /

2.2.92.4. Produces

  • application/json

2.2.92.5. Tags

  • oapiv1

2.2.93. create a ImageStream

POST /oapi/v1/namespaces/{namespace}/imagestreams

2.2.93.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.146, “v1.ImageStream”

 

PathParameter

namespace

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

true

string

 

2.2.93.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.146, “v1.ImageStream”

2.2.93.3. Consumes

  • /

2.2.93.4. Produces

  • application/json

2.2.93.5. Tags

  • oapiv1

2.2.94. read the specified ImageStream

GET /oapi/v1/namespaces/{namespace}/imagestreams/{name}

2.2.94.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 ImageStream

true

string

 

2.2.94.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.146, “v1.ImageStream”

2.2.94.3. Consumes

  • /

2.2.94.4. Produces

  • application/json

2.2.94.5. Tags

  • oapiv1

2.2.95. replace the specified ImageStream

PUT /oapi/v1/namespaces/{namespace}/imagestreams/{name}

2.2.95.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.146, “v1.ImageStream”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the ImageStream

true

string

 

2.2.95.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.146, “v1.ImageStream”

2.2.95.3. Consumes

  • /

2.2.95.4. Produces

  • application/json

2.2.95.5. Tags

  • oapiv1

2.2.96. delete a ImageStream

DELETE /oapi/v1/namespaces/{namespace}/imagestreams/{name}

2.2.96.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the ImageStream

true

string

 

2.2.96.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

2.2.96.3. Consumes

  • /

2.2.96.4. Produces

  • application/json

2.2.96.5. Tags

  • oapiv1

2.2.97. partially update the specified ImageStream

PATCH /oapi/v1/namespaces/{namespace}/imagestreams/{name}

2.2.97.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the ImageStream

true

string

 

2.2.97.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.146, “v1.ImageStream”

2.2.97.3. Consumes

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

2.2.97.4. Produces

  • application/json

2.2.97.5. Tags

  • oapiv1

2.2.98. replace status of the specified ImageStream

PUT /oapi/v1/namespaces/{namespace}/imagestreams/{name}/status

2.2.98.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.146, “v1.ImageStream”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the ImageStream

true

string

 

2.2.98.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.146, “v1.ImageStream”

2.2.98.3. Consumes

  • /

2.2.98.4. Produces

  • application/json

2.2.98.5. Tags

  • oapiv1

2.2.99. read the specified ImageStreamTag

GET /oapi/v1/namespaces/{namespace}/imagestreamtags/{name}

2.2.99.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 ImageStreamTag

true

string

 

2.2.99.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.48, “v1.ImageStreamTag”

2.2.99.3. Consumes

  • /

2.2.99.4. Produces

  • application/json

2.2.99.5. Tags

  • oapiv1

2.2.100. delete a ImageStreamTag

DELETE /oapi/v1/namespaces/{namespace}/imagestreamtags/{name}

2.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 ImageStreamTag

true

string

 

2.2.100.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

2.2.100.3. Consumes

  • /

2.2.100.4. Produces

  • application/json

2.2.100.5. Tags

  • oapiv1

2.2.101. create a LocalResourceAccessReview

POST /oapi/v1/namespaces/{namespace}/localresourceaccessreviews

2.2.101.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.139, “v1.LocalResourceAccessReview”

 

PathParameter

namespace

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

true

string

 

2.2.101.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.139, “v1.LocalResourceAccessReview”

2.2.101.3. Consumes

  • /

2.2.101.4. Produces

  • application/json

2.2.101.5. Tags

  • oapiv1

2.2.102. create a LocalSubjectAccessReview

POST /oapi/v1/namespaces/{namespace}/localsubjectaccessreviews

2.2.102.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.22, “v1.LocalSubjectAccessReview”

 

PathParameter

namespace

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

true

string

 

2.2.102.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.22, “v1.LocalSubjectAccessReview”

2.2.102.3. Consumes

  • /

2.2.102.4. Produces

  • application/json

2.2.102.5. Tags

  • oapiv1

2.2.103. list or watch objects of kind Policy

GET /oapi/v1/namespaces/{namespace}/policies

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

false

string

 

PathParameter

namespace

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

true

string

 

2.2.103.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.21, “v1.PolicyList”

2.2.103.3. Consumes

  • /

2.2.103.4. Produces

  • application/json

2.2.103.5. Tags

  • oapiv1

2.2.104. create a Policy

POST /oapi/v1/namespaces/{namespace}/policies

2.2.104.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.150, “v1.Policy”

 

PathParameter

namespace

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

true

string

 

2.2.104.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.150, “v1.Policy”

2.2.104.3. Consumes

  • /

2.2.104.4. Produces

  • application/json

2.2.104.5. Tags

  • oapiv1

2.2.105. read the specified Policy

GET /oapi/v1/namespaces/{namespace}/policies/{name}

2.2.105.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 Policy

true

string

 

2.2.105.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.150, “v1.Policy”

2.2.105.3. Consumes

  • /

2.2.105.4. Produces

  • application/json

2.2.105.5. Tags

  • oapiv1

2.2.106. replace the specified Policy

PUT /oapi/v1/namespaces/{namespace}/policies/{name}

2.2.106.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.150, “v1.Policy”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Policy

true

string

 

2.2.106.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.150, “v1.Policy”

2.2.106.3. Consumes

  • /

2.2.106.4. Produces

  • application/json

2.2.106.5. Tags

  • oapiv1

2.2.107. delete a Policy

DELETE /oapi/v1/namespaces/{namespace}/policies/{name}

2.2.107.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Policy

true

string

 

2.2.107.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

2.2.107.3. Consumes

  • /

2.2.107.4. Produces

  • application/json

2.2.107.5. Tags

  • oapiv1

2.2.108. partially update the specified Policy

PATCH /oapi/v1/namespaces/{namespace}/policies/{name}

2.2.108.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Policy

true

string

 

2.2.108.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.150, “v1.Policy”

2.2.108.3. Consumes

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

2.2.108.4. Produces

  • application/json

2.2.108.5. Tags

  • oapiv1

2.2.109. list or watch objects of kind PolicyBinding

GET /oapi/v1/namespaces/{namespace}/policybindings

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

false

string

 

PathParameter

namespace

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

true

string

 

2.2.109.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.6, “v1.PolicyBindingList”

2.2.109.3. Consumes

  • /

2.2.109.4. Produces

  • application/json

2.2.109.5. Tags

  • oapiv1

2.2.110. create a PolicyBinding

POST /oapi/v1/namespaces/{namespace}/policybindings

2.2.110.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.151, “v1.PolicyBinding”

 

PathParameter

namespace

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

true

string

 

2.2.110.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.151, “v1.PolicyBinding”

2.2.110.3. Consumes

  • /

2.2.110.4. Produces

  • application/json

2.2.110.5. Tags

  • oapiv1

2.2.111. read the specified PolicyBinding

GET /oapi/v1/namespaces/{namespace}/policybindings/{name}

2.2.111.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 PolicyBinding

true

string

 

2.2.111.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.151, “v1.PolicyBinding”

2.2.111.3. Consumes

  • /

2.2.111.4. Produces

  • application/json

2.2.111.5. Tags

  • oapiv1

2.2.112. replace the specified PolicyBinding

PUT /oapi/v1/namespaces/{namespace}/policybindings/{name}

2.2.112.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.151, “v1.PolicyBinding”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the PolicyBinding

true

string

 

2.2.112.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.151, “v1.PolicyBinding”

2.2.112.3. Consumes

  • /

2.2.112.4. Produces

  • application/json

2.2.112.5. Tags

  • oapiv1

2.2.113. delete a PolicyBinding

DELETE /oapi/v1/namespaces/{namespace}/policybindings/{name}

2.2.113.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the PolicyBinding

true

string

 

2.2.113.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

2.2.113.3. Consumes

  • /

2.2.113.4. Produces

  • application/json

2.2.113.5. Tags

  • oapiv1

2.2.114. partially update the specified PolicyBinding

PATCH /oapi/v1/namespaces/{namespace}/policybindings/{name}

2.2.114.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the PolicyBinding

true

string

 

2.2.114.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.151, “v1.PolicyBinding”

2.2.114.3. Consumes

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

2.2.114.4. Produces

  • application/json

2.2.114.5. Tags

  • oapiv1

2.2.115. create a Template

POST /oapi/v1/namespaces/{namespace}/processedtemplates

2.2.115.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.73, “v1.Template”

 

PathParameter

namespace

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

true

string

 

2.2.115.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.73, “v1.Template”

2.2.115.3. Consumes

  • /

2.2.115.4. Produces

  • application/json

2.2.115.5. Tags

  • oapiv1

2.2.116. create a ResourceAccessReview

POST /oapi/v1/namespaces/{namespace}/resourceaccessreviews

2.2.116.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.157, “v1.ResourceAccessReview”

 

PathParameter

namespace

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

true

string

 

2.2.116.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.157, “v1.ResourceAccessReview”

2.2.116.3. Consumes

  • /

2.2.116.4. Produces

  • application/json

2.2.116.5. Tags

  • oapiv1

2.2.117. list objects of kind RoleBinding

GET /oapi/v1/namespaces/{namespace}/rolebindings

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

false

string

 

PathParameter

namespace

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

true

string

 

2.2.117.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.153, “v1.RoleBindingList”

2.2.117.3. Consumes

  • /

2.2.117.4. Produces

  • application/json

2.2.117.5. Tags

  • oapiv1

2.2.118. create a RoleBinding

POST /oapi/v1/namespaces/{namespace}/rolebindings

2.2.118.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.133, “v1.RoleBinding”

 

PathParameter

namespace

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

true

string

 

2.2.118.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.133, “v1.RoleBinding”

2.2.118.3. Consumes

  • /

2.2.118.4. Produces

  • application/json

2.2.118.5. Tags

  • oapiv1

2.2.119. read the specified RoleBinding

GET /oapi/v1/namespaces/{namespace}/rolebindings/{name}

2.2.119.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 RoleBinding

true

string

 

2.2.119.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.133, “v1.RoleBinding”

2.2.119.3. Consumes

  • /

2.2.119.4. Produces

  • application/json

2.2.119.5. Tags

  • oapiv1

2.2.120. replace the specified RoleBinding

PUT /oapi/v1/namespaces/{namespace}/rolebindings/{name}

2.2.120.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.133, “v1.RoleBinding”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the RoleBinding

true

string

 

2.2.120.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.133, “v1.RoleBinding”

2.2.120.3. Consumes

  • /

2.2.120.4. Produces

  • application/json

2.2.120.5. Tags

  • oapiv1

2.2.121. delete a RoleBinding

DELETE /oapi/v1/namespaces/{namespace}/rolebindings/{name}

2.2.121.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the RoleBinding

true

string

 

2.2.121.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

2.2.121.3. Consumes

  • /

2.2.121.4. Produces

  • application/json

2.2.121.5. Tags

  • oapiv1

2.2.122. partially update the specified RoleBinding

PATCH /oapi/v1/namespaces/{namespace}/rolebindings/{name}

2.2.122.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the RoleBinding

true

string

 

2.2.122.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.133, “v1.RoleBinding”

2.2.122.3. Consumes

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

2.2.122.4. Produces

  • application/json

2.2.122.5. Tags

  • oapiv1

2.2.123. list objects of kind Role

GET /oapi/v1/namespaces/{namespace}/roles

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

false

string

 

PathParameter

namespace

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

true

string

 

2.2.123.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.130, “v1.RoleList”

2.2.123.3. Consumes

  • /

2.2.123.4. Produces

  • application/json

2.2.123.5. Tags

  • oapiv1

2.2.124. create a Role

POST /oapi/v1/namespaces/{namespace}/roles

2.2.124.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.42, “v1.Role”

 

PathParameter

namespace

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

true

string

 

2.2.124.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.42, “v1.Role”

2.2.124.3. Consumes

  • /

2.2.124.4. Produces

  • application/json

2.2.124.5. Tags

  • oapiv1

2.2.125. read the specified Role

GET /oapi/v1/namespaces/{namespace}/roles/{name}

2.2.125.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 Role

true

string

 

2.2.125.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.42, “v1.Role”

2.2.125.3. Consumes

  • /

2.2.125.4. Produces

  • application/json

2.2.125.5. Tags

  • oapiv1

2.2.126. replace the specified Role

PUT /oapi/v1/namespaces/{namespace}/roles/{name}

2.2.126.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.42, “v1.Role”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Role

true

string

 

2.2.126.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.42, “v1.Role”

2.2.126.3. Consumes

  • /

2.2.126.4. Produces

  • application/json

2.2.126.5. Tags

  • oapiv1

2.2.127. delete a Role

DELETE /oapi/v1/namespaces/{namespace}/roles/{name}

2.2.127.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Role

true

string

 

2.2.127.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

2.2.127.3. Consumes

  • /

2.2.127.4. Produces

  • application/json

2.2.127.5. Tags

  • oapiv1

2.2.128. partially update the specified Role

PATCH /oapi/v1/namespaces/{namespace}/roles/{name}

2.2.128.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Role

true

string

 

2.2.128.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.42, “v1.Role”

2.2.128.3. Consumes

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

2.2.128.4. Produces

  • application/json

2.2.128.5. Tags

  • oapiv1

2.2.129. list or watch objects of kind Route

GET /oapi/v1/namespaces/{namespace}/routes

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

false

string

 

PathParameter

namespace

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

true

string

 

2.2.129.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.152, “v1.RouteList”

2.2.129.3. Consumes

  • /

2.2.129.4. Produces

  • application/json

2.2.129.5. Tags

  • oapiv1

2.2.130. create a Route

POST /oapi/v1/namespaces/{namespace}/routes

2.2.130.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.145, “v1.Route”

 

PathParameter

namespace

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

true

string

 

2.2.130.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.145, “v1.Route”

2.2.130.3. Consumes

  • /

2.2.130.4. Produces

  • application/json

2.2.130.5. Tags

  • oapiv1

2.2.131. read the specified Route

GET /oapi/v1/namespaces/{namespace}/routes/{name}

2.2.131.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 Route

true

string

 

2.2.131.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.145, “v1.Route”

2.2.131.3. Consumes

  • /

2.2.131.4. Produces

  • application/json

2.2.131.5. Tags

  • oapiv1

2.2.132. replace the specified Route

PUT /oapi/v1/namespaces/{namespace}/routes/{name}

2.2.132.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.145, “v1.Route”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Route

true

string

 

2.2.132.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.145, “v1.Route”

2.2.132.3. Consumes

  • /

2.2.132.4. Produces

  • application/json

2.2.132.5. Tags

  • oapiv1

2.2.133. delete a Route

DELETE /oapi/v1/namespaces/{namespace}/routes/{name}

2.2.133.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Route

true

string

 

2.2.133.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

2.2.133.3. Consumes

  • /

2.2.133.4. Produces

  • application/json

2.2.133.5. Tags

  • oapiv1

2.2.134. partially update the specified Route

PATCH /oapi/v1/namespaces/{namespace}/routes/{name}

2.2.134.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Route

true

string

 

2.2.134.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.145, “v1.Route”

2.2.134.3. Consumes

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

2.2.134.4. Produces

  • application/json

2.2.134.5. Tags

  • oapiv1

2.2.135. replace status of the specified Route

PUT /oapi/v1/namespaces/{namespace}/routes/{name}/status

2.2.135.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.145, “v1.Route”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Route

true

string

 

2.2.135.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.145, “v1.Route”

2.2.135.3. Consumes

  • /

2.2.135.4. Produces

  • application/json

2.2.135.5. Tags

  • oapiv1

2.2.136. create a SubjectAccessReview

POST /oapi/v1/namespaces/{namespace}/subjectaccessreviews

2.2.136.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.49, “v1.SubjectAccessReview”

 

PathParameter

namespace

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

true

string

 

2.2.136.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.49, “v1.SubjectAccessReview”

2.2.136.3. Consumes

  • /

2.2.136.4. Produces

  • application/json

2.2.136.5. Tags

  • oapiv1

2.2.137. list or watch objects of kind Template

GET /oapi/v1/namespaces/{namespace}/templates

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

false

string

 

PathParameter

namespace

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

true

string

 

2.2.137.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.54, “v1.TemplateList”

2.2.137.3. Consumes

  • /

2.2.137.4. Produces

  • application/json

2.2.137.5. Tags

  • oapiv1

2.2.138. create a Template

POST /oapi/v1/namespaces/{namespace}/templates

2.2.138.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.73, “v1.Template”

 

PathParameter

namespace

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

true

string

 

2.2.138.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.73, “v1.Template”

2.2.138.3. Consumes

  • /

2.2.138.4. Produces

  • application/json

2.2.138.5. Tags

  • oapiv1

2.2.139. read the specified Template

GET /oapi/v1/namespaces/{namespace}/templates/{name}

2.2.139.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 Template

true

string

 

2.2.139.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.73, “v1.Template”

2.2.139.3. Consumes

  • /

2.2.139.4. Produces

  • application/json

2.2.139.5. Tags

  • oapiv1

2.2.140. replace the specified Template

PUT /oapi/v1/namespaces/{namespace}/templates/{name}

2.2.140.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.73, “v1.Template”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Template

true

string

 

2.2.140.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.73, “v1.Template”

2.2.140.3. Consumes

  • /

2.2.140.4. Produces

  • application/json

2.2.140.5. Tags

  • oapiv1

2.2.141. delete a Template

DELETE /oapi/v1/namespaces/{namespace}/templates/{name}

2.2.141.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Template

true

string

 

2.2.141.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

2.2.141.3. Consumes

  • /

2.2.141.4. Produces

  • application/json

2.2.141.5. Tags

  • oapiv1

2.2.142. partially update the specified Template

PATCH /oapi/v1/namespaces/{namespace}/templates/{name}

2.2.142.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Template

true

string

 

2.2.142.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.73, “v1.Template”

2.2.142.3. Consumes

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

2.2.142.4. Produces

  • application/json

2.2.142.5. Tags

  • oapiv1

2.2.143. list or watch objects of kind NetNamespace

GET /oapi/v1/netnamespaces

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

false

string

 

2.2.143.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.16, “v1.NetNamespaceList”

2.2.143.3. Consumes

  • /

2.2.143.4. Produces

  • application/json

2.2.143.5. Tags

  • oapiv1

2.2.144. create a NetNamespace

POST /oapi/v1/netnamespaces

2.2.144.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.27, “v1.NetNamespace”

 

2.2.144.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.27, “v1.NetNamespace”

2.2.144.3. Consumes

  • /

2.2.144.4. Produces

  • application/json

2.2.144.5. Tags

  • oapiv1

2.2.145. read the specified NetNamespace

GET /oapi/v1/netnamespaces/{name}

2.2.145.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

PathParameter

name

name of the NetNamespace

true

string

 

2.2.145.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.27, “v1.NetNamespace”

2.2.145.3. Consumes

  • /

2.2.145.4. Produces

  • application/json

2.2.145.5. Tags

  • oapiv1

2.2.146. replace the specified NetNamespace

PUT /oapi/v1/netnamespaces/{name}

2.2.146.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.27, “v1.NetNamespace”

 

PathParameter

name

name of the NetNamespace

true

string

 

2.2.146.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.27, “v1.NetNamespace”

2.2.146.3. Consumes

  • /

2.2.146.4. Produces

  • application/json

2.2.146.5. Tags

  • oapiv1

2.2.147. delete a NetNamespace

DELETE /oapi/v1/netnamespaces/{name}

2.2.147.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

name

name of the NetNamespace

true

string

 

2.2.147.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

2.2.147.3. Consumes

  • /

2.2.147.4. Produces

  • application/json

2.2.147.5. Tags

  • oapiv1

2.2.148. partially update the specified NetNamespace

PATCH /oapi/v1/netnamespaces/{name}

2.2.148.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

name

name of the NetNamespace

true

string

 

2.2.148.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.27, “v1.NetNamespace”

2.2.148.3. Consumes

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

2.2.148.4. Produces

  • application/json

2.2.148.5. Tags

  • oapiv1

2.2.149. list objects of kind OAuthAccessToken

GET /oapi/v1/oauthaccesstokens

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

false

string

 

2.2.149.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.128, “v1.OAuthAccessTokenList”

2.2.149.3. Consumes

  • /

2.2.149.4. Produces

  • application/json

2.2.149.5. Tags

  • oapiv1

2.2.150. create a OAuthAccessToken

POST /oapi/v1/oauthaccesstokens

2.2.150.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.33, “v1.OAuthAccessToken”

 

2.2.150.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.33, “v1.OAuthAccessToken”

2.2.150.3. Consumes

  • /

2.2.150.4. Produces

  • application/json

2.2.150.5. Tags

  • oapiv1

2.2.151. read the specified OAuthAccessToken

GET /oapi/v1/oauthaccesstokens/{name}

2.2.151.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

PathParameter

name

name of the OAuthAccessToken

true

string

 

2.2.151.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.33, “v1.OAuthAccessToken”

2.2.151.3. Consumes

  • /

2.2.151.4. Produces

  • application/json

2.2.151.5. Tags

  • oapiv1

2.2.152. delete a OAuthAccessToken

DELETE /oapi/v1/oauthaccesstokens/{name}

2.2.152.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

name

name of the OAuthAccessToken

true

string

 

2.2.152.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

2.2.152.3. Consumes

  • /

2.2.152.4. Produces

  • application/json

2.2.152.5. Tags

  • oapiv1

2.2.153. list objects of kind OAuthAuthorizeToken

GET /oapi/v1/oauthauthorizetokens

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

false

string

 

2.2.153.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.53, “v1.OAuthAuthorizeTokenList”

2.2.153.3. Consumes

  • /

2.2.153.4. Produces

  • application/json

2.2.153.5. Tags

  • oapiv1

2.2.154. create a OAuthAuthorizeToken

POST /oapi/v1/oauthauthorizetokens

2.2.154.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.111, “v1.OAuthAuthorizeToken”

 

2.2.154.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.111, “v1.OAuthAuthorizeToken”

2.2.154.3. Consumes

  • /

2.2.154.4. Produces

  • application/json

2.2.154.5. Tags

  • oapiv1

2.2.155. read the specified OAuthAuthorizeToken

GET /oapi/v1/oauthauthorizetokens/{name}

2.2.155.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

PathParameter

name

name of the OAuthAuthorizeToken

true

string

 

2.2.155.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.111, “v1.OAuthAuthorizeToken”

2.2.155.3. Consumes

  • /

2.2.155.4. Produces

  • application/json

2.2.155.5. Tags

  • oapiv1

2.2.156. delete a OAuthAuthorizeToken

DELETE /oapi/v1/oauthauthorizetokens/{name}

2.2.156.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

name

name of the OAuthAuthorizeToken

true

string

 

2.2.156.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

2.2.156.3. Consumes

  • /

2.2.156.4. Produces

  • application/json

2.2.156.5. Tags

  • oapiv1

2.2.157. list or watch objects of kind OAuthClientAuthorization

GET /oapi/v1/oauthclientauthorizations

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

false

string

 

2.2.157.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.131, “v1.OAuthClientAuthorizationList”

2.2.157.3. Consumes

  • /

2.2.157.4. Produces

  • application/json

2.2.157.5. Tags

  • oapiv1

2.2.158. create a OAuthClientAuthorization

POST /oapi/v1/oauthclientauthorizations

2.2.158.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.62, “v1.OAuthClientAuthorization”

 

2.2.158.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.62, “v1.OAuthClientAuthorization”

2.2.158.3. Consumes

  • /

2.2.158.4. Produces

  • application/json

2.2.158.5. Tags

  • oapiv1

2.2.159. read the specified OAuthClientAuthorization

GET /oapi/v1/oauthclientauthorizations/{name}

2.2.159.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

PathParameter

name

name of the OAuthClientAuthorization

true

string

 

2.2.159.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.62, “v1.OAuthClientAuthorization”

2.2.159.3. Consumes

  • /

2.2.159.4. Produces

  • application/json

2.2.159.5. Tags

  • oapiv1

2.2.160. replace the specified OAuthClientAuthorization

PUT /oapi/v1/oauthclientauthorizations/{name}

2.2.160.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.62, “v1.OAuthClientAuthorization”

 

PathParameter

name

name of the OAuthClientAuthorization

true

string

 

2.2.160.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.62, “v1.OAuthClientAuthorization”

2.2.160.3. Consumes

  • /

2.2.160.4. Produces

  • application/json

2.2.160.5. Tags

  • oapiv1

2.2.161. delete a OAuthClientAuthorization

DELETE /oapi/v1/oauthclientauthorizations/{name}

2.2.161.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

name

name of the OAuthClientAuthorization

true

string

 

2.2.161.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

2.2.161.3. Consumes

  • /

2.2.161.4. Produces

  • application/json

2.2.161.5. Tags

  • oapiv1

2.2.162. partially update the specified OAuthClientAuthorization

PATCH /oapi/v1/oauthclientauthorizations/{name}

2.2.162.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

name

name of the OAuthClientAuthorization

true

string

 

2.2.162.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.62, “v1.OAuthClientAuthorization”

2.2.162.3. Consumes

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

2.2.162.4. Produces

  • application/json

2.2.162.5. Tags

  • oapiv1

2.2.163. list or watch objects of kind OAuthClient

GET /oapi/v1/oauthclients

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

false

string

 

2.2.163.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.44, “v1.OAuthClientList”

2.2.163.3. Consumes

  • /

2.2.163.4. Produces

  • application/json

2.2.163.5. Tags

  • oapiv1

2.2.164. create a OAuthClient

POST /oapi/v1/oauthclients

2.2.164.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.86, “v1.OAuthClient”

 

2.2.164.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.86, “v1.OAuthClient”

2.2.164.3. Consumes

  • /

2.2.164.4. Produces

  • application/json

2.2.164.5. Tags

  • oapiv1

2.2.165. read the specified OAuthClient

GET /oapi/v1/oauthclients/{name}

2.2.165.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

PathParameter

name

name of the OAuthClient

true

string

 

2.2.165.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.86, “v1.OAuthClient”

2.2.165.3. Consumes

  • /

2.2.165.4. Produces

  • application/json

2.2.165.5. Tags

  • oapiv1

2.2.166. replace the specified OAuthClient

PUT /oapi/v1/oauthclients/{name}

2.2.166.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.86, “v1.OAuthClient”

 

PathParameter

name

name of the OAuthClient

true

string

 

2.2.166.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.86, “v1.OAuthClient”

2.2.166.3. Consumes

  • /

2.2.166.4. Produces

  • application/json

2.2.166.5. Tags

  • oapiv1

2.2.167. delete a OAuthClient

DELETE /oapi/v1/oauthclients/{name}

2.2.167.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

name

name of the OAuthClient

true

string

 

2.2.167.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

2.2.167.3. Consumes

  • /

2.2.167.4. Produces

  • application/json

2.2.167.5. Tags

  • oapiv1

2.2.168. partially update the specified OAuthClient

PATCH /oapi/v1/oauthclients/{name}

2.2.168.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

name

name of the OAuthClient

true

string

 

2.2.168.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.86, “v1.OAuthClient”

2.2.168.3. Consumes

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

2.2.168.4. Produces

  • application/json

2.2.168.5. Tags

  • oapiv1

2.2.169. list or watch objects of kind Policy

GET /oapi/v1/policies

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

false

string

 

2.2.169.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.21, “v1.PolicyList”

2.2.169.3. Consumes

  • /

2.2.169.4. Produces

  • application/json

2.2.169.5. Tags

  • oapiv1

2.2.170. create a Policy

POST /oapi/v1/policies

2.2.170.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.150, “v1.Policy”

 

2.2.170.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.150, “v1.Policy”

2.2.170.3. Consumes

  • /

2.2.170.4. Produces

  • application/json

2.2.170.5. Tags

  • oapiv1

2.2.171. list or watch objects of kind PolicyBinding

GET /oapi/v1/policybindings

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

false

string

 

2.2.171.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.6, “v1.PolicyBindingList”

2.2.171.3. Consumes

  • /

2.2.171.4. Produces

  • application/json

2.2.171.5. Tags

  • oapiv1

2.2.172. create a PolicyBinding

POST /oapi/v1/policybindings

2.2.172.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.151, “v1.PolicyBinding”

 

2.2.172.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.151, “v1.PolicyBinding”

2.2.172.3. Consumes

  • /

2.2.172.4. Produces

  • application/json

2.2.172.5. Tags

  • oapiv1

2.2.173. create a Template

POST /oapi/v1/processedtemplates

2.2.173.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.73, “v1.Template”

 

2.2.173.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.73, “v1.Template”

2.2.173.3. Consumes

  • /

2.2.173.4. Produces

  • application/json

2.2.173.5. Tags

  • oapiv1

2.2.174. list objects of kind ProjectRequest

GET /oapi/v1/projectrequests

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

false

string

 

2.2.174.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

2.2.174.3. Consumes

  • /

2.2.174.4. Produces

  • application/json

2.2.174.5. Tags

  • oapiv1

2.2.175. create a ProjectRequest

POST /oapi/v1/projectrequests

2.2.175.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.32, “v1.ProjectRequest”

 

2.2.175.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.32, “v1.ProjectRequest”

2.2.175.3. Consumes

  • /

2.2.175.4. Produces

  • application/json

2.2.175.5. Tags

  • oapiv1

2.2.176. list objects of kind Project

GET /oapi/v1/projects

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

false

string

 

2.2.176.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.141, “v1.ProjectList”

2.2.176.3. Consumes

  • /

2.2.176.4. Produces

  • application/json

2.2.176.5. Tags

  • oapiv1

2.2.177. create a Project

POST /oapi/v1/projects

2.2.177.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.107, “v1.Project”

 

2.2.177.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.107, “v1.Project”

2.2.177.3. Consumes

  • /

2.2.177.4. Produces

  • application/json

2.2.177.5. Tags

  • oapiv1

2.2.178. read the specified Project

GET /oapi/v1/projects/{name}

2.2.178.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

PathParameter

name

name of the Project

true

string

 

2.2.178.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.107, “v1.Project”

2.2.178.3. Consumes

  • /

2.2.178.4. Produces

  • application/json

2.2.178.5. Tags

  • oapiv1

2.2.179. replace the specified Project

PUT /oapi/v1/projects/{name}

2.2.179.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.107, “v1.Project”

 

PathParameter

name

name of the Project

true

string

 

2.2.179.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.107, “v1.Project”

2.2.179.3. Consumes

  • /

2.2.179.4. Produces

  • application/json

2.2.179.5. Tags

  • oapiv1

2.2.180. delete a Project

DELETE /oapi/v1/projects/{name}

2.2.180.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

PathParameter

name

name of the Project

true

string

 

2.2.180.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

2.2.180.3. Consumes

  • /

2.2.180.4. Produces

  • application/json

2.2.180.5. Tags

  • oapiv1

2.2.181. partially update the specified Project

PATCH /oapi/v1/projects/{name}

2.2.181.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

name

name of the Project

true

string

 

2.2.181.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.107, “v1.Project”

2.2.181.3. Consumes

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

2.2.181.4. Produces

  • application/json

2.2.181.5. Tags

  • oapiv1

2.2.182. create a ResourceAccessReview

POST /oapi/v1/resourceaccessreviews

2.2.182.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.157, “v1.ResourceAccessReview”

 

2.2.182.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.157, “v1.ResourceAccessReview”

2.2.182.3. Consumes

  • /

2.2.182.4. Produces

  • application/json

2.2.182.5. Tags

  • oapiv1

2.2.183. list objects of kind RoleBinding

GET /oapi/v1/rolebindings

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

false

string

 

2.2.183.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.153, “v1.RoleBindingList”

2.2.183.3. Consumes

  • /

2.2.183.4. Produces

  • application/json

2.2.183.5. Tags

  • oapiv1

2.2.184. create a RoleBinding

POST /oapi/v1/rolebindings

2.2.184.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.133, “v1.RoleBinding”

 

2.2.184.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.133, “v1.RoleBinding”

2.2.184.3. Consumes

  • /

2.2.184.4. Produces

  • application/json

2.2.184.5. Tags

  • oapiv1

2.2.185. list objects of kind Role

GET /oapi/v1/roles

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

false

string

 

2.2.185.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.130, “v1.RoleList”

2.2.185.3. Consumes

  • /

2.2.185.4. Produces

  • application/json

2.2.185.5. Tags

  • oapiv1

2.2.186. create a Role

POST /oapi/v1/roles

2.2.186.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.42, “v1.Role”

 

2.2.186.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.42, “v1.Role”

2.2.186.3. Consumes

  • /

2.2.186.4. Produces

  • application/json

2.2.186.5. Tags

  • oapiv1

2.2.187. list or watch objects of kind Route

GET /oapi/v1/routes

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

false

string

 

2.2.187.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.152, “v1.RouteList”

2.2.187.3. Consumes

  • /

2.2.187.4. Produces

  • application/json

2.2.187.5. Tags

  • oapiv1

2.2.188. create a Route

POST /oapi/v1/routes

2.2.188.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.145, “v1.Route”

 

2.2.188.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.145, “v1.Route”

2.2.188.3. Consumes

  • /

2.2.188.4. Produces

  • application/json

2.2.188.5. Tags

  • oapiv1

2.2.189. create a SubjectAccessReview

POST /oapi/v1/subjectaccessreviews

2.2.189.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.49, “v1.SubjectAccessReview”

 

2.2.189.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.49, “v1.SubjectAccessReview”

2.2.189.3. Consumes

  • /

2.2.189.4. Produces

  • application/json

2.2.189.5. Tags

  • oapiv1

2.2.190. list or watch objects of kind Template

GET /oapi/v1/templates

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

false

string

 

2.2.190.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.54, “v1.TemplateList”

2.2.190.3. Consumes

  • /

2.2.190.4. Produces

  • application/json

2.2.190.5. Tags

  • oapiv1

2.2.191. create a Template

POST /oapi/v1/templates

2.2.191.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.73, “v1.Template”

 

2.2.191.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.73, “v1.Template”

2.2.191.3. Consumes

  • /

2.2.191.4. Produces

  • application/json

2.2.191.5. Tags

  • oapiv1

2.2.192. create a UserIdentityMapping

POST /oapi/v1/useridentitymappings

2.2.192.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.72, “v1.UserIdentityMapping”

 

2.2.192.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.72, “v1.UserIdentityMapping”

2.2.192.3. Consumes

  • /

2.2.192.4. Produces

  • application/json

2.2.192.5. Tags

  • oapiv1

2.2.193. read the specified UserIdentityMapping

GET /oapi/v1/useridentitymappings/{name}

2.2.193.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

PathParameter

name

name of the UserIdentityMapping

true

string

 

2.2.193.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.72, “v1.UserIdentityMapping”

2.2.193.3. Consumes

  • /

2.2.193.4. Produces

  • application/json

2.2.193.5. Tags

  • oapiv1

2.2.194. replace the specified UserIdentityMapping

PUT /oapi/v1/useridentitymappings/{name}

2.2.194.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.72, “v1.UserIdentityMapping”

 

PathParameter

name

name of the UserIdentityMapping

true

string

 

2.2.194.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.72, “v1.UserIdentityMapping”

2.2.194.3. Consumes

  • /

2.2.194.4. Produces

  • application/json

2.2.194.5. Tags

  • oapiv1

2.2.195. delete a UserIdentityMapping

DELETE /oapi/v1/useridentitymappings/{name}

2.2.195.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

PathParameter

name

name of the UserIdentityMapping

true

string

 

2.2.195.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

2.2.195.3. Consumes

  • /

2.2.195.4. Produces

  • application/json

2.2.195.5. Tags

  • oapiv1

2.2.196. partially update the specified UserIdentityMapping

PATCH /oapi/v1/useridentitymappings/{name}

2.2.196.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

name

name of the UserIdentityMapping

true

string

 

2.2.196.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.72, “v1.UserIdentityMapping”

2.2.196.3. Consumes

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

2.2.196.4. Produces

  • application/json

2.2.196.5. Tags

  • oapiv1

2.2.197. list or watch objects of kind User

GET /oapi/v1/users

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

false

string

 

2.2.197.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.78, “v1.UserList”

2.2.197.3. Consumes

  • /

2.2.197.4. Produces

  • application/json

2.2.197.5. Tags

  • oapiv1

2.2.198. create a User

POST /oapi/v1/users

2.2.198.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.10, “v1.User”

 

2.2.198.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.10, “v1.User”

2.2.198.3. Consumes

  • /

2.2.198.4. Produces

  • application/json

2.2.198.5. Tags

  • oapiv1

2.2.199. read the specified User

GET /oapi/v1/users/{name}

2.2.199.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

PathParameter

name

name of the User

true

string

 

2.2.199.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.10, “v1.User”

2.2.199.3. Consumes

  • /

2.2.199.4. Produces

  • application/json

2.2.199.5. Tags

  • oapiv1

2.2.200. replace the specified User

PUT /oapi/v1/users/{name}

2.2.200.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.10, “v1.User”

 

PathParameter

name

name of the User

true

string

 

2.2.200.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.10, “v1.User”

2.2.200.3. Consumes

  • /

2.2.200.4. Produces

  • application/json

2.2.200.5. Tags

  • oapiv1

2.2.201. delete a User

DELETE /oapi/v1/users/{name}

2.2.201.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

name

name of the User

true

string

 

2.2.201.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

2.2.201.3. Consumes

  • /

2.2.201.4. Produces

  • application/json

2.2.201.5. Tags

  • oapiv1

2.2.202. partially update the specified User

PATCH /oapi/v1/users/{name}

2.2.202.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

name

name of the User

true

string

 

2.2.202.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.10, “v1.User”

2.2.202.3. Consumes

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

2.2.202.4. Produces

  • application/json

2.2.202.5. Tags

  • oapiv1

2.2.203. watch individual changes to a list of BuildConfig

GET /oapi/v1/watch/buildconfigs

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

false

string

 

2.2.203.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.203.3. Consumes

  • /

2.2.203.4. Produces

  • application/json

2.2.203.5. Tags

  • oapiv1

2.2.204. watch individual changes to a list of Build

GET /oapi/v1/watch/builds

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

false

string

 

2.2.204.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.204.3. Consumes

  • /

2.2.204.4. Produces

  • application/json

2.2.204.5. Tags

  • oapiv1

2.2.205. watch individual changes to a list of ClusterNetwork

GET /oapi/v1/watch/clusternetworks

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

false

string

 

2.2.205.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.205.3. Consumes

  • /

2.2.205.4. Produces

  • application/json

2.2.205.5. Tags

  • oapiv1

2.2.206. watch changes to an object of kind ClusterNetwork

GET /oapi/v1/watch/clusternetworks/{name}

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

false

string

 

PathParameter

name

name of the ClusterNetwork

true

string

 

2.2.206.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.206.3. Consumes

  • /

2.2.206.4. Produces

  • application/json

2.2.206.5. Tags

  • oapiv1

2.2.207. watch individual changes to a list of ClusterPolicy

GET /oapi/v1/watch/clusterpolicies

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

false

string

 

2.2.207.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.207.3. Consumes

  • /

2.2.207.4. Produces

  • application/json

2.2.207.5. Tags

  • oapiv1

2.2.208. watch changes to an object of kind ClusterPolicy

GET /oapi/v1/watch/clusterpolicies/{name}

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

false

string

 

PathParameter

name

name of the ClusterPolicy

true

string

 

2.2.208.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.208.3. Consumes

  • /

2.2.208.4. Produces

  • application/json

2.2.208.5. Tags

  • oapiv1

2.2.209. watch individual changes to a list of ClusterPolicyBinding

GET /oapi/v1/watch/clusterpolicybindings

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

false

string

 

2.2.209.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.209.3. Consumes

  • /

2.2.209.4. Produces

  • application/json

2.2.209.5. Tags

  • oapiv1

2.2.210. watch changes to an object of kind ClusterPolicyBinding

GET /oapi/v1/watch/clusterpolicybindings/{name}

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

false

string

 

PathParameter

name

name of the ClusterPolicyBinding

true

string

 

2.2.210.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.210.3. Consumes

  • /

2.2.210.4. Produces

  • application/json

2.2.210.5. Tags

  • oapiv1

2.2.211. watch individual changes to a list of DeploymentConfig

GET /oapi/v1/watch/deploymentconfigs

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

false

string

 

2.2.211.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.211.3. Consumes

  • /

2.2.211.4. Produces

  • application/json

2.2.211.5. Tags

  • oapiv1

2.2.212. watch individual changes to a list of Group

GET /oapi/v1/watch/groups

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

false

string

 

2.2.212.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.212.3. Consumes

  • /

2.2.212.4. Produces

  • application/json

2.2.212.5. Tags

  • oapiv1

2.2.213. watch changes to an object of kind Group

GET /oapi/v1/watch/groups/{name}

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

false

string

 

PathParameter

name

name of the Group

true

string

 

2.2.213.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.213.3. Consumes

  • /

2.2.213.4. Produces

  • application/json

2.2.213.5. Tags

  • oapiv1

2.2.214. watch individual changes to a list of HostSubnet

GET /oapi/v1/watch/hostsubnets

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

false

string

 

2.2.214.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.214.3. Consumes

  • /

2.2.214.4. Produces

  • application/json

2.2.214.5. Tags

  • oapiv1

2.2.215. watch changes to an object of kind HostSubnet

GET /oapi/v1/watch/hostsubnets/{name}

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

false

string

 

PathParameter

name

name of the HostSubnet

true

string

 

2.2.215.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.215.3. Consumes

  • /

2.2.215.4. Produces

  • application/json

2.2.215.5. Tags

  • oapiv1

2.2.216. watch individual changes to a list of Identity

GET /oapi/v1/watch/identities

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

false

string

 

2.2.216.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.216.3. Consumes

  • /

2.2.216.4. Produces

  • application/json

2.2.216.5. Tags

  • oapiv1

2.2.217. watch changes to an object of kind Identity

GET /oapi/v1/watch/identities/{name}

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

false

string

 

PathParameter

name

name of the Identity

true

string

 

2.2.217.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.217.3. Consumes

  • /

2.2.217.4. Produces

  • application/json

2.2.217.5. Tags

  • oapiv1

2.2.218. watch individual changes to a list of Image

GET /oapi/v1/watch/images

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

false

string

 

2.2.218.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.218.3. Consumes

  • /

2.2.218.4. Produces

  • application/json

2.2.218.5. Tags

  • oapiv1

2.2.219. watch changes to an object of kind Image

GET /oapi/v1/watch/images/{name}

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

false

string

 

PathParameter

name

name of the Image

true

string

 

2.2.219.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.219.3. Consumes

  • /

2.2.219.4. Produces

  • application/json

2.2.219.5. Tags

  • oapiv1

2.2.220. watch individual changes to a list of ImageStream

GET /oapi/v1/watch/imagestreams

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

false

string

 

2.2.220.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.220.3. Consumes

  • /

2.2.220.4. Produces

  • application/json

2.2.220.5. Tags

  • oapiv1

2.2.221. watch individual changes to a list of BuildConfig

GET /oapi/v1/watch/namespaces/{namespace}/buildconfigs

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

false

string

 

PathParameter

namespace

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

true

string

 

2.2.221.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.221.3. Consumes

  • /

2.2.221.4. Produces

  • application/json

2.2.221.5. Tags

  • oapiv1

2.2.222. watch changes to an object of kind BuildConfig

GET /oapi/v1/watch/namespaces/{namespace}/buildconfigs/{name}

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

false

string

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the BuildConfig

true

string

 

2.2.222.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.222.3. Consumes

  • /

2.2.222.4. Produces

  • application/json

2.2.222.5. Tags

  • oapiv1

2.2.223. watch individual changes to a list of Build

GET /oapi/v1/watch/namespaces/{namespace}/builds

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

false

string

 

PathParameter

namespace

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

true

string

 

2.2.223.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.223.3. Consumes

  • /

2.2.223.4. Produces

  • application/json

2.2.223.5. Tags

  • oapiv1

2.2.224. watch changes to an object of kind Build

GET /oapi/v1/watch/namespaces/{namespace}/builds/{name}

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

false

string

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Build

true

string

 

2.2.224.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.224.3. Consumes

  • /

2.2.224.4. Produces

  • application/json

2.2.224.5. Tags

  • oapiv1

2.2.225. watch individual changes to a list of DeploymentConfig

GET /oapi/v1/watch/namespaces/{namespace}/deploymentconfigs

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

false

string

 

PathParameter

namespace

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

true

string

 

2.2.225.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.225.3. Consumes

  • /

2.2.225.4. Produces

  • application/json

2.2.225.5. Tags

  • oapiv1

2.2.226. watch changes to an object of kind DeploymentConfig

GET /oapi/v1/watch/namespaces/{namespace}/deploymentconfigs/{name}

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

false

string

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the DeploymentConfig

true

string

 

2.2.226.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.226.3. Consumes

  • /

2.2.226.4. Produces

  • application/json

2.2.226.5. Tags

  • oapiv1

2.2.227. watch individual changes to a list of ImageStream

GET /oapi/v1/watch/namespaces/{namespace}/imagestreams

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

false

string

 

PathParameter

namespace

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

true

string

 

2.2.227.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.227.3. Consumes

  • /

2.2.227.4. Produces

  • application/json

2.2.227.5. Tags

  • oapiv1

2.2.228. watch changes to an object of kind ImageStream

GET /oapi/v1/watch/namespaces/{namespace}/imagestreams/{name}

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

false

string

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the ImageStream

true

string

 

2.2.228.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.228.3. Consumes

  • /

2.2.228.4. Produces

  • application/json

2.2.228.5. Tags

  • oapiv1

2.2.229. watch individual changes to a list of Policy

GET /oapi/v1/watch/namespaces/{namespace}/policies

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

false

string

 

PathParameter

namespace

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

true

string

 

2.2.229.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.229.3. Consumes

  • /

2.2.229.4. Produces

  • application/json

2.2.229.5. Tags

  • oapiv1

2.2.230. watch changes to an object of kind Policy

GET /oapi/v1/watch/namespaces/{namespace}/policies/{name}

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

false

string

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Policy

true

string

 

2.2.230.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.230.3. Consumes

  • /

2.2.230.4. Produces

  • application/json

2.2.230.5. Tags

  • oapiv1

2.2.231. watch individual changes to a list of PolicyBinding

GET /oapi/v1/watch/namespaces/{namespace}/policybindings

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

false

string

 

PathParameter

namespace

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

true

string

 

2.2.231.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.231.3. Consumes

  • /

2.2.231.4. Produces

  • application/json

2.2.231.5. Tags

  • oapiv1

2.2.232. watch changes to an object of kind PolicyBinding

GET /oapi/v1/watch/namespaces/{namespace}/policybindings/{name}

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

false

string

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the PolicyBinding

true

string

 

2.2.232.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.232.3. Consumes

  • /

2.2.232.4. Produces

  • application/json

2.2.232.5. Tags

  • oapiv1

2.2.233. watch individual changes to a list of Route

GET /oapi/v1/watch/namespaces/{namespace}/routes

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

false

string

 

PathParameter

namespace

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

true

string

 

2.2.233.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.233.3. Consumes

  • /

2.2.233.4. Produces

  • application/json

2.2.233.5. Tags

  • oapiv1

2.2.234. watch changes to an object of kind Route

GET /oapi/v1/watch/namespaces/{namespace}/routes/{name}

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

false

string

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Route

true

string

 

2.2.234.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.234.3. Consumes

  • /

2.2.234.4. Produces

  • application/json

2.2.234.5. Tags

  • oapiv1

2.2.235. watch individual changes to a list of Template

GET /oapi/v1/watch/namespaces/{namespace}/templates

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

false

string

 

PathParameter

namespace

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

true

string

 

2.2.235.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.235.3. Consumes

  • /

2.2.235.4. Produces

  • application/json

2.2.235.5. Tags

  • oapiv1

2.2.236. watch changes to an object of kind Template

GET /oapi/v1/watch/namespaces/{namespace}/templates/{name}

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

false

string

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Template

true

string

 

2.2.236.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.236.3. Consumes

  • /

2.2.236.4. Produces

  • application/json

2.2.236.5. Tags

  • oapiv1

2.2.237. watch individual changes to a list of NetNamespace

GET /oapi/v1/watch/netnamespaces

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

false

string

 

2.2.237.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.237.3. Consumes

  • /

2.2.237.4. Produces

  • application/json

2.2.237.5. Tags

  • oapiv1

2.2.238. watch changes to an object of kind NetNamespace

GET /oapi/v1/watch/netnamespaces/{name}

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

false

string

 

PathParameter

name

name of the NetNamespace

true

string

 

2.2.238.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.238.3. Consumes

  • /

2.2.238.4. Produces

  • application/json

2.2.238.5. Tags

  • oapiv1

2.2.239. watch individual changes to a list of OAuthClientAuthorization

GET /oapi/v1/watch/oauthclientauthorizations

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

false

string

 

2.2.239.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.239.3. Consumes

  • /

2.2.239.4. Produces

  • application/json

2.2.239.5. Tags

  • oapiv1

2.2.240. watch changes to an object of kind OAuthClientAuthorization

GET /oapi/v1/watch/oauthclientauthorizations/{name}

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

false

string

 

PathParameter

name

name of the OAuthClientAuthorization

true

string

 

2.2.240.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.240.3. Consumes

  • /

2.2.240.4. Produces

  • application/json

2.2.240.5. Tags

  • oapiv1

2.2.241. watch individual changes to a list of OAuthClient

GET /oapi/v1/watch/oauthclients

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

false

string

 

2.2.241.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.241.3. Consumes

  • /

2.2.241.4. Produces

  • application/json

2.2.241.5. Tags

  • oapiv1

2.2.242. watch changes to an object of kind OAuthClient

GET /oapi/v1/watch/oauthclients/{name}

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

false

string

 

PathParameter

name

name of the OAuthClient

true

string

 

2.2.242.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.242.3. Consumes

  • /

2.2.242.4. Produces

  • application/json

2.2.242.5. Tags

  • oapiv1

2.2.243. watch individual changes to a list of Policy

GET /oapi/v1/watch/policies

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

false

string

 

2.2.243.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.243.3. Consumes

  • /

2.2.243.4. Produces

  • application/json

2.2.243.5. Tags

  • oapiv1

2.2.244. watch individual changes to a list of PolicyBinding

GET /oapi/v1/watch/policybindings

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

false

string

 

2.2.244.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.244.3. Consumes

  • /

2.2.244.4. Produces

  • application/json

2.2.244.5. Tags

  • oapiv1

2.2.245. watch individual changes to a list of Route

GET /oapi/v1/watch/routes

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

false

string

 

2.2.245.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.245.3. Consumes

  • /

2.2.245.4. Produces

  • application/json

2.2.245.5. Tags

  • oapiv1

2.2.246. watch individual changes to a list of Template

GET /oapi/v1/watch/templates

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

false

string

 

2.2.246.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.246.3. Consumes

  • /

2.2.246.4. Produces

  • application/json

2.2.246.5. Tags

  • oapiv1

2.2.247. watch individual changes to a list of User

GET /oapi/v1/watch/users

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

false

string

 

2.2.247.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.247.3. Consumes

  • /

2.2.247.4. Produces

  • application/json

2.2.247.5. Tags

  • oapiv1

2.2.248. watch changes to an object of kind User

GET /oapi/v1/watch/users/{name}

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

false

string

 

PathParameter

name

name of the User

true

string

 

2.2.248.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

2.2.248.3. Consumes

  • /

2.2.248.4. Produces

  • application/json

2.2.248.5. Tags

  • oapiv1

2.3. Definitions

2.3.1. v1.MetadataVolumeSource

NameDescriptionRequiredSchemaDefault

items

list of metadata files

false

Section 2.3.60, “v1.MetadataFile” array

 

2.3.2. v1.TCPSocketAction

NameDescriptionRequiredSchemaDefault

port

number or name of the port to access on the container; number must be in the range 1 to 65535; name must be an IANA_SVC_NAME

true

string

 

2.3.3. v1.GitBuildSource

NameDescriptionRequiredSchemaDefault

uri

points to the source that will be built, structure of the source will depend on the type of build to run

true

string

 

ref

identifies the branch/tag/ref to build

false

string

 

httpProxy

specifies a http proxy to be used during git clone operations

false

string

 

httpsProxy

specifies a https proxy to be used during git clone operations

false

string

 

2.3.4. v1.HostSubnetList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.24, “v1.ListMeta”

 

items

list of host subnets

true

Section 2.3.11, “v1.HostSubnet” array

 

2.3.5. v1.GroupList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.24, “v1.ListMeta”

 

items

list of groups

true

Section 2.3.52, “v1.Group” array

 

2.3.6. v1.PolicyBindingList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.24, “v1.ListMeta”

 

items

list of policy bindings

true

Section 2.3.151, “v1.PolicyBinding” array

 

2.3.7. v1.ClusterRoleList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.24, “v1.ListMeta”

 

items

list of cluster roles

true

Section 2.3.144, “v1.ClusterRole” array

 

2.3.8. v1.Capability

2.3.9. v1.SourceRevision

NameDescriptionRequiredSchemaDefault

type

type of the build source

true

string

 

git

information about git-based build source

false

Section 2.3.80, “v1.GitSourceRevision”

 

2.3.10. v1.User

Upon log in, every user of the system receives a User and Identity resource. Administrators may directly manipulate the attributes of the users for their own tracking, or set groups via the API. The user name is unique and is chosen based on the value provided by the identity provider - if a user already exists with the incoming name, the user name may have a number appended to it.

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

fullName

full name of user

false

string

 

identities

list of identities

true

string array

 

groups

list of groups

true

string array

 

2.3.11. v1.HostSubnet

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

host

Name of the host that is registered at the master. A lease will be sought after this name.

true

string

 

hostIP

IP address to be used as vtep by other hosts in the overlay network

true

string

 

subnet

Actual subnet CIDR lease assigned to the host

true

string

 

2.3.12. v1.ClusterPolicyBinding

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

lastModified

last time any part of the object was created, updated, or deleted

true

string (date-time)

 

policyRef

reference to the cluster policy that this cluster policy binding’s role bindings may reference

true

Section 2.3.122, “v1.ObjectReference”

 

roleBindings

all the role bindings held by this policy, mapped by role name

true

Section 2.3.103, “v1.NamedClusterRoleBinding” array

 

2.3.13. v1.BuildStatus

NameDescriptionRequiredSchemaDefault

phase

observed point in the build lifecycle

true

string

 

cancelled

describes if a canceling event was triggered for the build

false

boolean

false

message

human-readable message indicating details about why the build has this status

false

string

 

startTimestamp

server time when this build started running in a pod

false

string (date-time)

 

completionTimestamp

server time when the pod running this build stopped running

false

string (date-time)

 

duration

amount of time the build has been running

false

time.Duration

 

config

reference to build config from which this build was derived

false

Section 2.3.122, “v1.ObjectReference”

 

2.3.14. v1.BuildRequest

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

revision

information from the source for a specific repo snapshot

false

Section 2.3.9, “v1.SourceRevision”

 

triggeredByImage

image that triggered this build

false

Section 2.3.122, “v1.ObjectReference”

 

from

ImageStreamTag that triggered this build

false

Section 2.3.122, “v1.ObjectReference”

 

lastVersion

LastVersion of the BuildConfig that triggered this build

false

integer (int32)

 

2.3.15. v1.HostPathVolumeSource

NameDescriptionRequiredSchemaDefault

path

path of the directory on the host; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#hostpath

true

string

 

2.3.16. v1.NetNamespaceList

NetNamespaceList represents a list of NetNamespace objects. NetNamespace captures information about a segregated network namespace for an entire cluster. When a group of pods, or a project, or a group of projects get a NetNamespace assigned then the openshift-sdn’s multitenant plugin ensures network layer isolation of traffic from other NetNamespaces.

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.24, “v1.ListMeta”

 

items

list of net namespaces

true

Section 2.3.27, “v1.NetNamespace” array

 

2.3.17. v1.Parameter

NameDescriptionRequiredSchemaDefault

name

name of the parameter

true

string

 

displayName

optional: provides human readable name for the parameter

false

string

 

description

optional: describes the parameter

false

string

 

value

optional: holds the parameter data. if specified, the generator is ignored. the value replaces all occurrences of the parameter ${Name} expression during template to config transformation

false

string

 

generate

optional: generate specifies the generator to be used to generate random string from an input value specified by the from field. the result string is stored in the value field. if not specified, the value field is untouched

false

string

 

from

input value for the generator

false

string

 

required

indicates the parameter must have a non-empty value or be generated

false

boolean

false

2.3.18. v1.Volume

NameDescriptionRequiredSchemaDefault

name

volume name; must be a DNS_LABEL and unique within the pod; see http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names

true

string

 

hostPath

pre-existing host file or directory; generally for privileged system daemons or other agents tied to the host; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#hostpath

false

Section 2.3.15, “v1.HostPathVolumeSource”

 

emptyDir

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

false

Section 2.3.96, “v1.EmptyDirVolumeSource”

 

gcePersistentDisk

GCE disk resource attached to the host machine on demand; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk

false

Section 2.3.74, “v1.GCEPersistentDiskVolumeSource”

 

awsElasticBlockStore

AWS disk resource attached to the host machine on demand; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore

false

Section 2.3.137, “v1.AWSElasticBlockStoreVolumeSource”

 

gitRepo

git repository at a particular revision

false

Section 2.3.105, “v1.GitRepoVolumeSource”

 

secret

secret to populate volume; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#secrets

false

Section 2.3.35, “v1.SecretVolumeSource”

 

nfs

NFS volume that will be mounted in the host machine; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs

false

Section 2.3.28, “v1.NFSVolumeSource”

 

iscsi

iSCSI disk attached to host machine on demand; see http://releases.k8s.io/HEAD/examples/iscsi/README.md

false

Section 2.3.104, “v1.ISCSIVolumeSource”

 

glusterfs

Glusterfs volume that will be mounted on the host machine; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md

false

Section 2.3.158, “v1.GlusterfsVolumeSource”

 

persistentVolumeClaim

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

false

Section 2.3.47, “v1.PersistentVolumeClaimVolumeSource”

 

rbd

rados block volume that will be mounted on the host machine; see http://releases.k8s.io/HEAD/examples/rbd/README.md

false

Section 2.3.63, “v1.RBDVolumeSource”

 

cephfs

Ceph filesystem that will be mounted on the host machine

false

Section 2.3.29, “v1.CephFSVolumeSource”

 

metadata

Metadata volume containing information about the pod

false

Section 2.3.1, “v1.MetadataVolumeSource”

 

2.3.19. v1.RouteStatus

2.3.20. v1.BuildTriggerPolicy

NameDescriptionRequiredSchemaDefault

type

type of build trigger

true

string

 

github

parameters for a GitHub webhook type of trigger

false

Section 2.3.100, “v1.WebHookTrigger”

 

generic

parameters for a Generic webhook type of trigger

false

Section 2.3.100, “v1.WebHookTrigger”

 

imageChange

parameters for an ImageChange type of trigger

false

Section 2.3.148, “v1.ImageChangeTrigger”

 

2.3.21. v1.PolicyList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.24, “v1.ListMeta”

 

items

list of policies

true

Section 2.3.150, “v1.Policy” array

 

2.3.22. v1.LocalSubjectAccessReview

Local Subject Access Reviews are objects that allow you to determine whether a given user or group can perform a particular action in a given namespace. Leaving user and groups empty allows you determine whether the identity making the request can perform the action.

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

namespace

namespace of the action being requested

true

string

 

verb

one of get, list, watch, create, update, delete

true

string

 

resource

one of the existing resource types

true

string

 

resourceName

name of the resource being requested for a get or delete

true

string

 

content

actual content of the request for create and update

false

string

 

user

optional, if both user and groups are empty, the current authenticated user is used

true

string

 

groups

optional, list of groups to which the user belongs

true

string array

 

2.3.23. v1.DeleteOptions

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

gracePeriodSeconds

the duration in seconds to wait before deleting this object; defaults to a per object value if not specified; zero means delete immediately

true

integer (int64)

 

2.3.24. v1.ListMeta

NameDescriptionRequiredSchemaDefault

selfLink

URL for the object; populated by the system, read-only

false

string

 

resourceVersion

string that identifies the internal version of this object that can be used by clients to determine when objects have changed; populated by the system, read-only; value must be treated as opaque by clients and passed unmodified back to the server: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

 

2.3.25. v1.PodTemplateSpec

NameDescriptionRequiredSchemaDefault

metadata

standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.106, “v1.ObjectMeta”

 

spec

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

false

Section 2.3.61, “v1.PodSpec”

 

2.3.26. v1.Build

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

spec

specification of the desired behavior for a build

false

Section 2.3.112, “v1.BuildSpec”

 

status

most recently observed status of a build as populated by the system

false

Section 2.3.13, “v1.BuildStatus”

 

2.3.27. v1.NetNamespace

NetNamespace represents a segregated network namespace for an entire cluster. When a group of pods, or a project, or a group of projects get a NetNamespace assigned then the openshift-sdn’s multitenant plugin ensures network layer isolation of traffic from other NetNamespaces.

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

netname

Name of the network namespace.

true

string

 

netid

NetID of the network namespace assigned to each overlay network packet.

true

uint

 

2.3.28. v1.NFSVolumeSource

NameDescriptionRequiredSchemaDefault

server

the hostname or IP address of the NFS server; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs

true

string

 

path

the path that is exported by the NFS server; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs

true

string

 

readOnly

forces the NFS export to be mounted with read-only permissions; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs

false

boolean

false

2.3.29. v1.CephFSVolumeSource

NameDescriptionRequiredSchemaDefault

monitors

a collection of Ceph monitors

true

string array

 

user

rados user name; default is admin; optional

false

string

 

secretFile

path to secret for rados user; default is /etc/ceph/user.secret; optional

false

string

 

secretRef

name of a secret to authenticate the user; if provided overrides keyring; optional

false

Section 2.3.110, “v1.LocalObjectReference”

 

readOnly

Ceph fs to be mounted with read-only permissions

false

boolean

false

2.3.30. v1.Capabilities

NameDescriptionRequiredSchemaDefault

add

added capabilities

false

Section 2.3.8, “v1.Capability” array

 

drop

dropped capabilities

false

Section 2.3.8, “v1.Capability” array

 

2.3.31. v1.DeploymentConfig

Deployment Configs define the template for a pod and manages deploying new images or configuration changes. A single deployment configuration is usually analogous to a single micro-service. Can support many different deployment patterns, including full restart, customizable rolling updates, and fully custom behaviors, as well as pre- and post- deployment hooks. Each individual deployment is represented as a replication controller.

A deployment is "triggered" when its configuration is changed or a tag in an Image Stream is changed. Triggers can be disabled to allow manual control over a deployment. The "strategy"determines how the deployment is carried out and may be changed at any time.

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

spec

a desired deployment state and how to deploy it

true

Section 2.3.75, “v1.DeploymentConfigSpec”

 

status

the current state of the latest deployment

true

Section 2.3.108, “v1.DeploymentConfigStatus”

 

2.3.32. v1.ProjectRequest

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

displayName

display name to apply to a project

false

string

 

description

description to apply to a project

false

string

 

2.3.33. v1.OAuthAccessToken

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

clientName

references the client that created this token

false

string

 

expiresIn

is the seconds from creation time before this token expires

false

integer (int64)

 

scopes

list of requested scopes

false

string array

 

redirectURI

redirection URI associated with the token

false

string

 

userName

user name associated with this token

false

string

 

userUID

unique UID associated with this token

false

string

 

authorizeToken

contains the token that authorized this token

false

string

 

refreshToken

optional value by which this token can be renewed

false

string

 

2.3.34. v1.BuildConfigList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.24, “v1.ListMeta”

 

items

list of build configs

true

Section 2.3.56, “v1.BuildConfig” array

 

2.3.35. v1.SecretVolumeSource

NameDescriptionRequiredSchemaDefault

secretName

secretName is the name of a secret in the pod’s namespace; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#secrets

true

string

 

2.3.36. v1.SecretSpec

A SecretSpec specifies a secret and its corresponding mount point for a custom builder. The specified secret must be assigned to the service account that will run the build.

NameDescriptionRequiredSchemaDefault

secretSource

a reference to a secret

true

Section 2.3.110, “v1.LocalObjectReference”

 

mountPath

path within the container at which the secret should be mounted

true

string

 

2.3.37. v1.ResourceRequirements

NameDescriptionRequiredSchemaDefault

limits

Maximum amount of compute resources allowed; see http://releases.k8s.io/HEAD/docs/design/resources.md#resource-specifications

false

Section 2.3.161, “any”

 

requests

Minimum amount of resources requested; if Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value; see http://releases.k8s.io/HEAD/docs/design/resources.md#resource-specifications

false

Section 2.3.161, “any”

 

2.3.38. v1.ClusterNetworkList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.24, “v1.ListMeta”

 

items

list of cluster networks

true

Section 2.3.46, “v1.ClusterNetwork” array

 

2.3.39. v1.ImageList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.24, “v1.ListMeta”

 

items

list of image objects

true

Section 2.3.91, “v1.Image” array

 

2.3.40. v1.ImageStreamStatus

NameDescriptionRequiredSchemaDefault

dockerImageRepository

represents the effective location this stream may be accessed at, may be empty until the server determines where the repository is located

true

string

 

tags

historical record of images associated with each tag, the first entry is the currently tagged image

false

Section 2.3.115, “v1.NamedTagEventList” array

 

2.3.41. v1.TLSConfig

NameDescriptionRequiredSchemaDefault

termination

indicates termination type. if not set, any termination config will be ignored

false

string

 

certificate

provides certificate contents

false

string

 

key

provides key file contents

false

string

 

caCertificate

provides the cert authority certificate contents

false

string

 

destinationCACertificate

provides the contents of the ca certificate of the final destination. When using re-encrypt termination this file should be provided in order to have routers use it for health checks on the secure connection

false

string

 

2.3.42. v1.Role

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

rules

all the rules for this role

true

Section 2.3.81, “v1.PolicyRule” array

 

2.3.43. v1.ClusterRoleBinding

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

userNames

all user names directly bound to the role

true

string array

 

groupNames

all the groups directly bound to the role

true

string array

 

subjects

references to subjects bound to the role. Only User, Group, SystemUser, SystemGroup, and ServiceAccount are allowed.

true

Section 2.3.122, “v1.ObjectReference” array

 

roleRef

reference to the policy role

true

Section 2.3.122, “v1.ObjectReference”

 

2.3.44. v1.OAuthClientList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.24, “v1.ListMeta”

 

items

list of oauth clients

true

Section 2.3.86, “v1.OAuthClient” array

 

2.3.45. v1.ExecAction

NameDescriptionRequiredSchemaDefault

command

command line to execute inside the container; working directory for the command is root ('/') in the container’s file system; the command is exec’d, not run inside a shell; exit status of 0 is treated as live/healthy and non-zero is unhealthy

false

string array

 

2.3.46. v1.ClusterNetwork

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

network

CIDR string to specify the global overlay network’s L3 space

true

string

 

hostsubnetlength

number of bits to allocate to each host’s subnet e.g. 8 would mean a /24 network on the host

true

integer (int32)

 

serviceNetwork

CIDR string to specify the service network

true

string

 

2.3.47. v1.PersistentVolumeClaimVolumeSource

NameDescriptionRequiredSchemaDefault

claimName

the name of the claim in the same namespace to be mounted as a volume; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

true

string

 

readOnly

mount volume as read-only when true; default false

false

boolean

false

2.3.48. v1.ImageStreamTag

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

image

the image associated with the ImageStream and tag

true

Section 2.3.91, “v1.Image”

 

2.3.49. v1.SubjectAccessReview

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

namespace

namespace of the action being requested

true

string

 

verb

one of get, list, watch, create, update, delete

true

string

 

resource

one of the existing resource types

true

string

 

resourceName

name of the resource being requested for a get or delete

true

string

 

content

actual content of the request for create and update

false

string

 

user

optional, if both user and groups are empty, the current authenticated user is used

true

string

 

groups

optional, list of groups to which the user belongs

true

string array

 

2.3.50. v1.BuildStrategy

NameDescriptionRequiredSchemaDefault

type

identifies the type of build strategy

true

string

 

dockerStrategy

holds parameters for the Docker build strategy

false

Section 2.3.123, “v1.DockerBuildStrategy”

 

sourceStrategy

holds parameters to the Source build strategy

false

Section 2.3.118, “v1.SourceBuildStrategy”

 

customStrategy

holds parameters to the Custom build strategy

false

Section 2.3.140, “v1.CustomBuildStrategy”

 

2.3.51. v1.DeploymentConfigList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.24, “v1.ListMeta”

 

items

a list of deployment configs

true

Section 2.3.31, “v1.DeploymentConfig” array

 

2.3.52. v1.Group

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

users

list of users in this group

true

string array

 

2.3.53. v1.OAuthAuthorizeTokenList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.24, “v1.ListMeta”

 

items

list of oauth authorization tokens

true

Section 2.3.111, “v1.OAuthAuthorizeToken” array

 

2.3.54. v1.TemplateList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.24, “v1.ListMeta”

 

items

list of templates

true

Section 2.3.73, “v1.Template” array

 

2.3.55. v1.ProjectStatus

NameDescriptionRequiredSchemaDefault

phase

phase is the current lifecycle phase of the project

false

string

 

2.3.56. v1.BuildConfig

Build configurations define a build process for new Docker images. There are three types of builds possible - a Docker build using a Dockerfile, a Source-to-Image build that uses a specially prepared base image that accepts source code that it can make runnable, and a custom build that can run arbitrary Docker images as a base and accept the build parameters. Builds run on the cluster and on completion are pushed to the Docker registry specified in the "output" section. A build can be triggered via a webhook, when the base image changes, or when a user manually requests a new build be created.

Each build created by a build configuration is numbered and refers back to its parent configuration. Multiple builds can be triggered at once. Builds that do not have "output" set can be used to test code or run a verification build.

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

spec

holds all the input necessary to produce a new build, and the conditions when to trigger them

true

Section 2.3.134, “v1.BuildConfigSpec”

 

status

holds any relevant information about a build config derived by the system

true

Section 2.3.119, “v1.BuildConfigStatus”

 

2.3.57. v1.Handler

NameDescriptionRequiredSchemaDefault

exec

exec-based handler

false

Section 2.3.45, “v1.ExecAction”

 

httpGet

HTTP-based handler

false

Section 2.3.99, “v1.HTTPGetAction”

 

tcpSocket

TCP-based handler; TCP hooks not yet supported

false

Section 2.3.2, “v1.TCPSocketAction”

 

2.3.58. v1.Container

NameDescriptionRequiredSchemaDefault

name

name of the container; must be a DNS_LABEL and unique within the pod; cannot be updated

true

string

 

image

Docker image name; see http://releases.k8s.io/HEAD/docs/user-guide/images.md

false

string

 

command

entrypoint array; not executed within a shell; the Docker image’s entrypoint is used if this is not provided; cannot be updated; variable references $(VAR_NAME) are expanded using the container’s environment variables; if a variable cannot be resolved, the reference in the input string will be unchanged; the $(VAR_NAME) syntax can be escaped with a double , ie: (VAR_NAME) ; escaped references will never be expanded, regardless of whether the variable exists or not; see http://releases.k8s.io/HEAD/docs/user-guide/containers.md#containers-and-commands

false

string array

 

args

command array; the Docker image’s cmd is used if this is not provided; arguments to the entrypoint; cannot be updated; variable references $(VAR_NAME) are expanded using the container’s environment variables; if a variable cannot be resolved, the reference in the input string will be unchanged; the $(VAR_NAME) syntax can be escaped with a double , ie: (VAR_NAME) ; escaped references will never be expanded, regardless of whether the variable exists or not; see http://releases.k8s.io/HEAD/docs/user-guide/containers.md#containers-and-commands

false

string array

 

workingDir

container’s working directory; defaults to image’s default; cannot be updated

false

string

 

ports

list of ports to expose from the container; cannot be updated

false

Section 2.3.116, “v1.ContainerPort” array

 

env

list of environment variables to set in the container; cannot be updated

false

Section 2.3.149, “v1.EnvVar” array

 

resources

Compute Resources required by this container; cannot be updated; see http://releases.k8s.io/HEAD/docs/user-guide/compute-resources.md

false

Section 2.3.37, “v1.ResourceRequirements”

 

volumeMounts

pod volumes to mount into the container’s filesystem; cannot be updated

false

Section 2.3.83, “v1.VolumeMount” array

 

livenessProbe

periodic probe of container liveness; container will be restarted if the probe fails; cannot be updated; see http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes

false

Section 2.3.102, “v1.Probe”

 

readinessProbe

periodic probe of container service readiness; container will be removed from service endpoints if the probe fails; cannot be updated; see http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes

false

Section 2.3.102, “v1.Probe”

 

lifecycle

actions that the management system should take in response to container lifecycle events; cannot be updated

false

Section 2.3.129, “v1.Lifecycle”

 

terminationMessagePath

path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem; message written is intended to be brief final status, such as an assertion failure message; defaults to /dev/termination-log; cannot be updated

false

string

 

imagePullPolicy

image pull policy; one of Always, Never, IfNotPresent; defaults to Always if :latest tag is specified, or IfNotPresent otherwise; cannot be updated; see http://releases.k8s.io/HEAD/docs/user-guide/images.md#updating-images

false

string

 

securityContext

security options the pod should run with; see http://releases.k8s.io/HEAD/docs/design/security_context.md

false

Section 2.3.68, “v1.SecurityContext”

 

stdin

Whether this container should allocate a buffer for stdin in the container runtime; default is false

false

boolean

false

tty

Whether this container should allocate a TTY for itself, also requires 'stdin' to be true; default is false

false

boolean

false

2.3.59. v1.SourceControlUser

NameDescriptionRequiredSchemaDefault

name

name of the source control user

false

string

 

email

e-mail of the source control user

false

string

 

2.3.60. v1.MetadataFile

NameDescriptionRequiredSchemaDefault

name

the name of the file to be created

true

string

 

fieldRef

selects a field of the pod. Supported fields: metadata.annotations, metadata.labels, metadata.name, metadata.namespace

true

Section 2.3.127, “v1.ObjectFieldSelector”

 

2.3.61. v1.PodSpec

NameDescriptionRequiredSchemaDefault

volumes

list of volumes that can be mounted by containers belonging to the pod; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md

false

Section 2.3.18, “v1.Volume” array

 

containers

list of containers belonging to the pod; cannot be updated; containers cannot currently be added or removed; there must be at least one container in a Pod; see http://releases.k8s.io/HEAD/docs/user-guide/containers.md

true

Section 2.3.58, “v1.Container” array

 

restartPolicy

restart policy for all containers within the pod; one of Always, OnFailure, Never; defaults to Always; see http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#restartpolicy

false

string

 

terminationGracePeriodSeconds

optional duration in seconds the pod needs to terminate gracefully; may be decreased in delete request; value must be non-negative integer; the value zero indicates delete immediately; if this value is not set, the default grace period will be used instead; the grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal; set this value longer than the expected cleanup time for your process

false

integer (int64)

 

activeDeadlineSeconds

 

false

integer (int64)

 

dnsPolicy

DNS policy for containers within the pod; one of 'ClusterFirst' or 'Default'

false

string

 

nodeSelector

selector which must match a node’s labels for the pod to be scheduled on that node; see http://releases.k8s.io/HEAD/docs/user-guide/node-selection/README.md

false

Section 2.3.161, “any”

 

host

deprecated, use nodeName instead

false

string

 

serviceAccountName

name of the ServiceAccount to use to run this pod; see http://releases.k8s.io/HEAD/docs/design/service_accounts.md

false

string

 

serviceAccount

deprecated; use serviceAccountName instead

false

string

 

nodeName

node requested for this pod

false

string

 

hostNetwork

host networking requested for this pod

false

boolean

false

imagePullSecrets

list of references to secrets in the same namespace available for pulling the container images; see http://releases.k8s.io/HEAD/docs/user-guide/images.md#specifying-imagepullsecrets-on-a-pod

false

Section 2.3.110, “v1.LocalObjectReference” array

 

2.3.62. v1.OAuthClientAuthorization

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

clientName

references the client that created this authorization

false

string

 

userName

user name that authorized this client

false

string

 

userUID

unique UID associated with this authorization. userUID and userName must both match for this authorization to be valid

false

string

 

scopes

list of granted scopes

false

string array

 

2.3.63. v1.RBDVolumeSource

NameDescriptionRequiredSchemaDefault

monitors

a collection of Ceph monitors; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it

true

string array

 

image

rados image name; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it

true

string

 

fsType

file system type to mount, such as ext4, xfs, ntfs; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it

false

string

 

pool

rados pool name; default is rbd; optional; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it

true

string

 

user

rados user name; default is admin; optional; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it

true

string

 

keyring

keyring is the path to key ring for rados user; default is /etc/ceph/keyring; optional; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it

true

string

 

secretRef

name of a secret to authenticate the RBD user; if provided overrides keyring; optional; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it

true

Section 2.3.110, “v1.LocalObjectReference”

 

readOnly

rbd volume to be mounted with read-only permissions; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it

false

boolean

false

2.3.64. v1.RollingDeploymentStrategyParams

NameDescriptionRequiredSchemaDefault

updatePeriodSeconds

the time to wait between individual pod updates

false

integer (int64)

 

intervalSeconds

the time to wait between polling deployment status after update

false

integer (int64)

 

timeoutSeconds

the time to wait for updates before giving up

false

integer (int64)

 

updatePercent

the percentage of replicas to scale up or down each interval (negative value switches scale order to down/up instead of up/down)

false

integer (int32)

 

pre

a hook executed before the strategy starts the deployment

false

Section 2.3.79, “v1.LifecycleHook”

 

post

a hook executed after the strategy finishes the deployment

false

Section 2.3.79, “v1.LifecycleHook”

 

2.3.65. v1.ImageStreamSpec

NameDescriptionRequiredSchemaDefault

dockerImageRepository

optional field if specified this stream is backed by a Docker repository on this server

false

string

 

tags

map arbitrary string values to specific image locators

false

Section 2.3.85, “v1.NamedTagReference” array

 

2.3.66. v1.BuildLog

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.24, “v1.ListMeta”

 

2.3.67. v1.DeploymentConfigRollback

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

spec

options for rollback generation

true

Section 2.3.114, “v1.DeploymentConfigRollbackSpec”

 

2.3.68. v1.SecurityContext

NameDescriptionRequiredSchemaDefault

capabilities

the Linux capabilites that should be added or removed; see http://releases.k8s.io/HEAD/docs/design/security_context.md#security-context

false

Section 2.3.30, “v1.Capabilities”

 

privileged

run the container in privileged mode; see http://releases.k8s.io/HEAD/docs/design/security_context.md#security-context

false

boolean

false

seLinuxOptions

options that control the SELinux labels applied; see http://releases.k8s.io/HEAD/docs/design/security_context.md#security-context

false

Section 2.3.121, “v1.SELinuxOptions”

 

runAsUser

the user id that runs the first process in the container; see http://releases.k8s.io/HEAD/docs/design/security_context.md#security-context

false

integer (int64)

 

runAsNonRoot

indicates the container must be run as a non-root user either by specifying the runAsUser or in the image specification

false

boolean

false

2.3.69. v1.NamedRole

NameDescriptionRequiredSchemaDefault

name

name of the role

true

string

 

role

the role

true

Section 2.3.42, “v1.Role”

 

2.3.70. v1.StatusCause

NameDescriptionRequiredSchemaDefault

reason

machine-readable description of the cause of the error; if this value is empty there is no information available

false

string

 

message

human-readable description of the cause of the error; this field may be presented as-is to a reader

false

string

 

field

field of the resource that has caused this error, as named by its JSON serialization; may include dot and postfix notation for nested attributes; arrays are zero-indexed; fields may appear more than once in an array of causes due to fields having multiple errors

false

string

 

2.3.71. v1.Identity

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

providerName

source of identity information

true

string

 

providerUserName

uniquely represents this identity in the scope of the provider

true

string

 

user

reference to the user this identity is associated with. both name and uid must be set

true

Section 2.3.122, “v1.ObjectReference”

 

extra

extra information for this identity

false

Section 2.3.161, “any”

 

2.3.72. v1.UserIdentityMapping

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

identity

reference to an identity

false

Section 2.3.122, “v1.ObjectReference”

 

user

reference to a user

false

Section 2.3.122, “v1.ObjectReference”

 

2.3.73. v1.Template

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

objects

list of objects to include in the template

true

Section 2.3.147, “runtime.RawExtension” array

 

parameters

optional: list of parameters used during template to config transformation

false

Section 2.3.17, “v1.Parameter” array

 

labels

optional: list of labels that are applied to every object during the template to config transformation

false

Section 2.3.161, “any”

 

2.3.74. v1.GCEPersistentDiskVolumeSource

NameDescriptionRequiredSchemaDefault

pdName

unique name of the PD resource in GCE; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk

true

string

 

fsType

file system type to mount, such as ext4, xfs, ntfs; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk

true

string

 

partition

partition on the disk to mount (e.g., '1' for /dev/sda1); if omitted the plain device name (e.g., /dev/sda) will be mounted; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk

false

integer (int32)

 

readOnly

read-only if true, read-write otherwise (false or unspecified); see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk

false

boolean

false

2.3.75. v1.DeploymentConfigSpec

NameDescriptionRequiredSchemaDefault

strategy

how a deployment is executed

true

Section 2.3.156, “v1.DeploymentStrategy”

 

triggers

how new deployments are triggered

true

Section 2.3.124, “v1.DeploymentTriggerPolicy” array

 

replicas

the desired number of replicas

true

integer (int32)

 

selector

a label query over pods that should match the replicas count

true

Section 2.3.161, “any”

 

template

describes the pod that will be created if insufficient replicas are detected; takes precedence over a template reference

false

Section 2.3.25, “v1.PodTemplateSpec”

 

2.3.76. v1.ClusterPolicy

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

lastModified

last time any part of the object was created, updated, or deleted

true

string (date-time)

 

roles

all the roles held by this policy, mapped by role name

true

Section 2.3.109, “v1.NamedClusterRole” array

 

2.3.77. v1.EnvVarSource

NameDescriptionRequiredSchemaDefault

fieldRef

selects a field of the pod; only name and namespace are supported

true

Section 2.3.127, “v1.ObjectFieldSelector”

 

2.3.78. v1.UserList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.24, “v1.ListMeta”

 

items

list of users

true

Section 2.3.10, “v1.User” array

 

2.3.79. v1.LifecycleHook

NameDescriptionRequiredSchemaDefault

failurePolicy

what action to take if the hook fails

true

string

 

execNewPod

options for an ExecNewPodHook

false

Section 2.3.120, “v1.ExecNewPodHook”

 

2.3.80. v1.GitSourceRevision

NameDescriptionRequiredSchemaDefault

commit

hash identifying a specific commit

false

string

 

author

author of a specific commit

false

Section 2.3.59, “v1.SourceControlUser”

 

committer

committer of a specific commit

false

Section 2.3.59, “v1.SourceControlUser”

 

message

description of a specific commit

false

string

 

2.3.81. v1.PolicyRule

NameDescriptionRequiredSchemaDefault

verbs

list of verbs that apply to ALL the resourceKinds and attributeRestrictions contained in this rule. The verb * represents all kinds.

true

string array

 

attributeRestrictions

vary depending on what the authorizer supports. If the authorizer does not recognize how to handle the specified value, it should report an error.

false

string

 

resources

list of resources this rule applies to. * represents all resources.

true

string array

 

resourceNames

optional white list of names that the rule applies to. An empty set means that everything is allowed.

false

string array

 

nonResourceURLs

set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path.

false

string array

 

2.3.82. integer

2.3.83. v1.VolumeMount

NameDescriptionRequiredSchemaDefault

name

name of the volume to mount

true

string

 

readOnly

mounted read-only if true, read-write otherwise (false or unspecified)

false

boolean

false

mountPath

path within the container at which the volume should be mounted

true

string

 

2.3.84. v1.DeploymentCause

NameDescriptionRequiredSchemaDefault

type

the type of trigger that resulted in a new deployment

true

string

 

imageTrigger

image trigger details (if applicable)

false

Section 2.3.88, “v1.DeploymentCauseImageTrigger”

 

2.3.85. v1.NamedTagReference

NameDescriptionRequiredSchemaDefault

name

name of tag

true

string

 

annotations

annotations associated with images using this tag

false

Section 2.3.161, “any”

 

from

a reference to an image stream tag or image stream this tag should track

false

Section 2.3.122, “v1.ObjectReference”

 

2.3.86. v1.OAuthClient

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

secret

unique secret associated with a client

false

string

 

respondWithChallenges

indicates whether the client wants authentication needed responses made in the form of challenges instead of redirects

false

boolean

false

redirectURIs

valid redirection URIs associated with a client

false

string array

 

2.3.87. v1.ImageStreamList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.24, “v1.ListMeta”

 

items

list of image stream objects

true

Section 2.3.146, “v1.ImageStream” array

 

2.3.88. v1.DeploymentCauseImageTrigger

NameDescriptionRequiredSchemaDefault

from

a reference the changed object which triggered a deployment

true

Section 2.3.122, “v1.ObjectReference”

 

2.3.89. v1.IdentityList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.24, “v1.ListMeta”

 

items

list of identities

true

Section 2.3.71, “v1.Identity” array

 

2.3.90. patch.Object

represents an object patch, which may be any of: JSON patch (RFC 6902), JSON merge patch (RFC 7396), or the Kubernetes strategic merge patch

2.3.91. v1.Image

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

dockerImageReference

string that can be used to pull this image

false

string

 

dockerImageMetadata

metadata about this image

false

string

 

dockerImageMetadataVersion

conveys version of the object, if empty defaults to '1.0'

false

string

 

dockerImageManifest

raw JSON of the manifest

false

string

 

2.3.92. v1.ImageStreamImage

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

image

the image associated with the ImageStream and image name

true

Section 2.3.91, “v1.Image”

 

2.3.93. v1.RouteSpec

NameDescriptionRequiredSchemaDefault

host

optional: alias/dns that points to the service, must follow DNS 952 subdomain conventions

true

string

 

path

optional: path that the router watches to route traffic to the service

false

string

 

to

an object the route points to. only the service kind is allowed, and it will be defaulted to a service.

true

Section 2.3.122, “v1.ObjectReference”

 

tls

provides the ability to configure certificates and termination for the route

false

Section 2.3.41, “v1.TLSConfig”

 

2.3.94. v1.BuildList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.24, “v1.ListMeta”

 

items

list of builds

true

Section 2.3.26, “v1.Build” array

 

2.3.95. v1.RecreateDeploymentStrategyParams

NameDescriptionRequiredSchemaDefault

pre

a hook executed before the strategy starts the deployment

false

Section 2.3.79, “v1.LifecycleHook”

 

post

a hook executed after the strategy finishes the deployment

false

Section 2.3.79, “v1.LifecycleHook”

 

2.3.96. v1.EmptyDirVolumeSource

NameDescriptionRequiredSchemaDefault

medium

type of storage used to back the volume; must be an empty string (default) or Memory; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#emptydir

false

string

 

2.3.97. v1.BuildSource

NameDescriptionRequiredSchemaDefault

type

type of source control management system

true

string

 

git

optional information about git build source

false

Section 2.3.3, “v1.GitBuildSource”

 

contextDir

specifies sub-directory where the source code for the application exists, allows for sources to be built from a directory other than the root of a repository

false

string

 

sourceSecret

supported auth methods are: ssh-privatekey

false

Section 2.3.110, “v1.LocalObjectReference”

 

2.3.98. api.Patch

2.3.99. v1.HTTPGetAction

NameDescriptionRequiredSchemaDefault

path

path to access on the HTTP server

false

string

 

port

number or name of the port to access on the container; number must be in the range 1 to 65535; name must be an IANA_SVC_NAME

true

string

 

host

hostname to connect to; defaults to pod IP

false

string

 

scheme

scheme to connect with, must be HTTP or HTTPS, defaults to HTTP

false

string

 

2.3.100. v1.WebHookTrigger

NameDescriptionRequiredSchemaDefault

secret

secret used to validate requests

false

string

 

2.3.101. v1.DeploymentDetails

NameDescriptionRequiredSchemaDefault

message

a user specified change message

false

string

 

causes

extended data associated with all the causes for creating a new deployment

false

Section 2.3.84, “v1.DeploymentCause” array

 

2.3.102. v1.Probe

NameDescriptionRequiredSchemaDefault

exec

exec-based handler

false

Section 2.3.45, “v1.ExecAction”

 

httpGet

HTTP-based handler

false

Section 2.3.99, “v1.HTTPGetAction”

 

tcpSocket

TCP-based handler; TCP hooks not yet supported

false

Section 2.3.2, “v1.TCPSocketAction”

 

initialDelaySeconds

number of seconds after the container has started before liveness probes are initiated; see http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes

false

integer (int64)

 

timeoutSeconds

number of seconds after which liveness probes timeout; defaults to 1 second; see http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes

false

integer (int64)

 

2.3.103. v1.NamedClusterRoleBinding

NameDescriptionRequiredSchemaDefault

name

name of the cluster role binding

true

string

 

roleBinding

the cluster role binding

true

Section 2.3.43, “v1.ClusterRoleBinding”

 

2.3.104. v1.ISCSIVolumeSource

NameDescriptionRequiredSchemaDefault

targetPortal

iSCSI target portal

true

string

 

iqn

iSCSI Qualified Name

true

string

 

lun

iscsi target lun number

true

integer (int32)

 

fsType

file system type to mount, such as ext4, xfs, ntfs

true

string

 

readOnly

read-only if true, read-write otherwise (false or unspecified)

false

boolean

false

2.3.105. v1.GitRepoVolumeSource

NameDescriptionRequiredSchemaDefault

repository

repository URL

true

string

 

revision

commit hash for the specified revision

true

string

 

2.3.106. v1.ObjectMeta

NameDescriptionRequiredSchemaDefault

name

string that identifies an object. Must be unique within a namespace; cannot be updated; see http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names

false

string

 

generateName

an optional prefix to use to generate a unique name; has the same validation rules as name; optional, and is applied only name if is not specified; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#idempotency

false

string

 

namespace

namespace of the object; must be a DNS_LABEL; cannot be updated; see http://releases.k8s.io/HEAD/docs/user-guide/namespaces.md

false

string

 

selfLink

URL for the object; populated by the system, read-only

false

string

 

uid

unique UUID across space and time; populated by the system; read-only; see http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#uids

false

string

 

resourceVersion

string that identifies the internal version of this object that can be used by clients to determine when objects have changed; populated by the system, read-only; value must be treated as opaque by clients and passed unmodified back to the server: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

 

generation

a sequence number representing a specific generation of the desired state; populated by the system; read-only

false

integer (int64)

 

creationTimestamp

RFC 3339 date and time at which the object was created; populated by the system, read-only; null for lists; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

string (date-time)

 

deletionTimestamp

RFC 3339 date and time at which the object will be deleted; populated by the system when a graceful deletion is requested, read-only; if not set, graceful deletion of the object has not been requested; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

string (date-time)

 

labels

map of string keys and values that can be used to organize and categorize objects; may match selectors of replication controllers and services; see http://releases.k8s.io/HEAD/docs/user-guide/labels.md

false

Section 2.3.161, “any”

 

annotations

map of string keys and values that can be used by external tooling to store and retrieve arbitrary metadata about objects; see http://releases.k8s.io/HEAD/docs/user-guide/annotations.md

false

Section 2.3.161, “any”

 

2.3.107. v1.Project

Projects are the unit of isolation and collaboration in OpenShift. A project has one or more members, a quota on the resources that the project may consume, and the security controls on the resources in the project. Within a project, members may have different roles - project administrators can set membership, editors can create and manage the resources, and viewers can see but not access running containers. In a normal cluster project administrators are not able to alter their quotas - that is restricted to cluster administrators.

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

spec

spec defines the behavior of the Project

false

Section 2.3.159, “v1.ProjectSpec”

 

status

status describes the current status of a Project; read-only

false

Section 2.3.55, “v1.ProjectStatus”

 

2.3.108. v1.DeploymentConfigStatus

NameDescriptionRequiredSchemaDefault

latestVersion

used to determine whether the current deployment is out of sync

false

integer (int32)

 

details

reasons for the last update to the config

false

Section 2.3.101, “v1.DeploymentDetails”

 

2.3.109. v1.NamedClusterRole

NameDescriptionRequiredSchemaDefault

name

name of the cluster role

true

string

 

role

the cluster role

true

Section 2.3.144, “v1.ClusterRole”

 

2.3.110. v1.LocalObjectReference

NameDescriptionRequiredSchemaDefault

name

name of the referent; see http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names

false

string

 

2.3.111. v1.OAuthAuthorizeToken

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

clientName

references the client that created this token

false

string

 

expiresIn

seconds from creation time before this token expires

false

integer (int64)

 

scopes

list of requested scopes

false

string array

 

redirectURI

redirection URI associated with the token

false

string

 

state

state data from request

false

string

 

userName

user name associated with this token

false

string

 

userUID

unique UID associated with this token. userUID and userName must both match for this token to be valid

false

string

 

2.3.112. v1.BuildSpec

NameDescriptionRequiredSchemaDefault

serviceAccount

the name of the service account to use to run pods created by the build, pod will be allowed to use secrets referenced by the service account

false

string

 

source

describes the source control management system in use

false

Section 2.3.97, “v1.BuildSource”

 

revision

specific revision in the source repository

false

Section 2.3.9, “v1.SourceRevision”

 

strategy

defines how to perform a build

true

Section 2.3.50, “v1.BuildStrategy”

 

output

describes the output of a build that a strategy should produce

false

Section 2.3.125, “v1.BuildOutput”

 

resources

the desired compute resources the build should have

false

Section 2.3.37, “v1.ResourceRequirements”

 

2.3.113. v1.ClusterPolicyBindingList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.24, “v1.ListMeta”

 

items

list of cluster policy bindings

true

Section 2.3.12, “v1.ClusterPolicyBinding” array

 

2.3.114. v1.DeploymentConfigRollbackSpec

NameDescriptionRequiredSchemaDefault

from

a reference to a deployment, which is a ReplicationController

true

Section 2.3.122, “v1.ObjectReference”

 

includeTriggers

whether to include old config triggers in the rollback

true

boolean

false

includeTemplate

whether to include the old pod template spec in the rollback

true

boolean

false

includeReplicationMeta

whether to include the replica count and replica selector in the rollback

true

boolean

false

includeStrategy

whether to include the deployment strategy in the rollback

true

boolean

false

2.3.115. v1.NamedTagEventList

NameDescriptionRequiredSchemaDefault

tag

the tag

true

string

 

items

list of tag events related to the tag

true

Section 2.3.154, “v1.TagEvent” array

 

2.3.116. v1.ContainerPort

NameDescriptionRequiredSchemaDefault

name

name for the port that can be referred to by services; must be an IANA_SVC_NAME and unique within the pod

false

string

 

hostPort

number of port to expose on the host; most containers do not need this

false

integer (int32)

 

containerPort

number of port to expose on the pod’s IP address

true

integer (int32)

 

protocol

protocol for port; must be UDP or TCP; TCP if unspecified

false

string

 

hostIP

host IP to bind the port to

false

string

 

2.3.117. v1.NamedRoleBinding

NameDescriptionRequiredSchemaDefault

name

name of the roleBinding

true

string

 

roleBinding

the roleBinding

true

Section 2.3.133, “v1.RoleBinding”

 

2.3.118. v1.SourceBuildStrategy

NameDescriptionRequiredSchemaDefault

from

reference to an image stream, image stream tag, or image stream image from which the Docker image should be pulled

true

Section 2.3.122, “v1.ObjectReference”

 

pullSecret

supported type: dockercfg

false

Section 2.3.110, “v1.LocalObjectReference”

 

env

additional environment variables you want to pass into a builder container

false

Section 2.3.149, “v1.EnvVar” array

 

scripts

location of the source scripts

false

string

 

incremental

forces the source build to do incremental builds if true

false

boolean

false

forcePull

forces the source build to pull the image if true

false

boolean

false

2.3.119. v1.BuildConfigStatus

NameDescriptionRequiredSchemaDefault

lastVersion

used to inform about number of last triggered build

true

integer (int32)

 

2.3.120. v1.ExecNewPodHook

NameDescriptionRequiredSchemaDefault

command

the hook command and its arguments

true

string array

 

env

environment variables provided to the hook container

false

Section 2.3.149, “v1.EnvVar” array

 

containerName

the name of a container from the pod template whose image will be used for the hook container

true

string

 

2.3.121. v1.SELinuxOptions

NameDescriptionRequiredSchemaDefault

user

the user label to apply to the container; see http://releases.k8s.io/HEAD/docs/user-guide/labels.md

false

string

 

role

the role label to apply to the container; see http://releases.k8s.io/HEAD/docs/user-guide/labels.md

false

string

 

type

the type label to apply to the container; see http://releases.k8s.io/HEAD/docs/user-guide/labels.md

false

string

 

level

the level label to apply to the container; see http://releases.k8s.io/HEAD/docs/user-guide/labels.md

false

string

 

2.3.122. v1.ObjectReference

NameDescriptionRequiredSchemaDefault

kind

kind of the referent; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

namespace

namespace of the referent; see http://releases.k8s.io/HEAD/docs/user-guide/namespaces.md

false

string

 

name

name of the referent; see http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names

false

string

 

uid

uid of the referent; see http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#uids

false

string

 

apiVersion

API version of the referent

false

string

 

resourceVersion

specific resourceVersion to which this reference is made, if any: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

 

fieldPath

if referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]

false

string

 

2.3.123. v1.DockerBuildStrategy

NameDescriptionRequiredSchemaDefault

from

reference to image stream, image stream tag, or image stream image from which Docker image should be pulled, resulting image will be used in the FROM line for the Dockerfile for this build

false

Section 2.3.122, “v1.ObjectReference”

 

pullSecret

supported type: dockercfg

false

Section 2.3.110, “v1.LocalObjectReference”

 

noCache

if true, indicates that the Docker build must be executed with the --no-cache=true flag

false

boolean

false

env

additional environment variables you want to pass into a builder container

false

Section 2.3.149, “v1.EnvVar” array

 

forcePull

forces the source build to pull the image if true

false

boolean

false

2.3.124. v1.DeploymentTriggerPolicy

NameDescriptionRequiredSchemaDefault

type

the type of the trigger

false

string

 

imageChangeParams

input to the ImageChange trigger

false

Section 2.3.160, “v1.DeploymentTriggerImageChangeParams”

 

2.3.125. v1.BuildOutput

NameDescriptionRequiredSchemaDefault

to

The optional image stream to push the output of this build. The namespace may be empty, in which case, the image stream will be looked up based on the namespace of the build.

false

Section 2.3.122, “v1.ObjectReference”

 

pushSecret

supported type: dockercfg

false

Section 2.3.110, “v1.LocalObjectReference”

 

2.3.126. v1.ClusterRoleBindingList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.24, “v1.ListMeta”

 

items

list of cluster role bindings

true

Section 2.3.43, “v1.ClusterRoleBinding” array

 

2.3.127. v1.ObjectFieldSelector

NameDescriptionRequiredSchemaDefault

apiVersion

version of the schema that fieldPath is written in terms of; defaults to v1

false

string

 

fieldPath

path of the field to select in the specified API version

true

string

 

2.3.128. v1.OAuthAccessTokenList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.24, “v1.ListMeta”

 

items

list of oauth access tokens

true

Section 2.3.33, “v1.OAuthAccessToken” array

 

2.3.129. v1.Lifecycle

NameDescriptionRequiredSchemaDefault

postStart

called immediately after a container is started; if the handler fails, the container is terminated and restarted according to its restart policy; other management of the container blocks until the hook completes; see http://releases.k8s.io/HEAD/docs/user-guide/container-environment.md#hook-details

false

Section 2.3.57, “v1.Handler”

 

preStop

called before a container is terminated; the container is terminated after the handler completes; other management of the container blocks until the hook completes; see http://releases.k8s.io/HEAD/docs/user-guide/container-environment.md#hook-details

false

Section 2.3.57, “v1.Handler”

 

2.3.130. v1.RoleList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.24, “v1.ListMeta”

 

items

list of roles

true

Section 2.3.42, “v1.Role” array

 

2.3.131. v1.OAuthClientAuthorizationList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.24, “v1.ListMeta”

 

items

list of oauth client authorizations

true

Section 2.3.62, “v1.OAuthClientAuthorization” array

 

2.3.132. v1.Status

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.24, “v1.ListMeta”

 

status

status of the operation; either Success, or Failure; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

string

 

message

human-readable description of the status of this operation

false

string

 

reason

machine-readable description of why this operation is in the 'Failure' status; if this value is empty there is no information available; a reason clarifies an HTTP status code but does not override it

false

string

 

details

extended data associated with the reason; each reason may define its own extended details; this field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type

false

Section 2.3.143, “v1.StatusDetails”

 

code

suggested HTTP return code for this status; 0 if not set

false

integer (int32)

 

2.3.133. v1.RoleBinding

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

userNames

all the usernames directly bound to the role

true

string array

 

groupNames

all the groups directly bound to the role

true

string array

 

subjects

references to subjects bound to the role. Only User, Group, SystemUser, SystemGroup, and ServiceAccount are allowed.

true

Section 2.3.122, “v1.ObjectReference” array

 

roleRef

a reference to a role

true

Section 2.3.122, “v1.ObjectReference”

 

2.3.134. v1.BuildConfigSpec

NameDescriptionRequiredSchemaDefault

triggers

determines how new builds can be launched from a build config. if no triggers are defined, a new build can only occur as a result of an explicit client build creation.

true

Section 2.3.20, “v1.BuildTriggerPolicy” array

 

serviceAccount

the name of the service account to use to run pods created by the build, pod will be allowed to use secrets referenced by the service account

false

string

 

source

describes the source control management system in use

false

Section 2.3.97, “v1.BuildSource”

 

revision

specific revision in the source repository

false

Section 2.3.9, “v1.SourceRevision”

 

strategy

defines how to perform a build

true

Section 2.3.50, “v1.BuildStrategy”

 

output

describes the output of a build that a strategy should produce

false

Section 2.3.125, “v1.BuildOutput”

 

resources

the desired compute resources the build should have

false

Section 2.3.37, “v1.ResourceRequirements”

 

2.3.135. v1.ImageStreamMapping

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

image

a Docker image

true

Section 2.3.91, “v1.Image”

 

tag

string value this image can be located with inside the stream

true

string

 

2.3.136. json.WatchEvent

NameDescriptionRequiredSchemaDefault

type

the type of watch event; may be ADDED, MODIFIED, DELETED, or ERROR

false

string

 

object

the object being watched; will match the type of the resource endpoint or be a Status object if the type is ERROR

false

string

 

2.3.137. v1.AWSElasticBlockStoreVolumeSource

NameDescriptionRequiredSchemaDefault

volumeID

unique id of the PD resource in AWS; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore

true

string

 

fsType

file system type to mount, such as ext4, xfs, ntfs; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore

true

string

 

partition

partition on the disk to mount (e.g., '1' for /dev/sda1); if omitted the plain device name (e.g., /dev/sda) will be mounted; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore

false

integer (int32)

 

readOnly

read-only if true, read-write otherwise (false or unspecified); see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore

false

boolean

false

2.3.138. v1.ClusterPolicyList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.24, “v1.ListMeta”

 

items

list of cluster policies

true

Section 2.3.76, “v1.ClusterPolicy” array

 

2.3.139. v1.LocalResourceAccessReview

Local Resource Access Reviews are objects that allow you to determine which users and groups can perform a given action in a given namespace.

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

namespace

namespace of the action being requested

true

string

 

verb

one of get, list, watch, create, update, delete

true

string

 

resource

one of the existing resource types

true

string

 

resourceName

name of the resource being requested for a get or delete

true

string

 

content

actual content of the request for create and update

false

string

 

2.3.140. v1.CustomBuildStrategy

NameDescriptionRequiredSchemaDefault

from

reference to an image stream, image stream tag, or image stream image from which the Docker image should be pulled

true

Section 2.3.122, “v1.ObjectReference”

 

pullSecret

supported type: dockercfg

false

Section 2.3.110, “v1.LocalObjectReference”

 

env

additional environment variables you want to pass into a builder container

false

Section 2.3.149, “v1.EnvVar” array

 

exposeDockerSocket

allow running Docker commands (and build Docker images) from inside the container

false

boolean

false

forcePull

forces pulling of builder image from remote registry if true

false

boolean

false

secrets

a list of secrets to include in the build pod in addition to pull, push and source secrets

false

Section 2.3.36, “v1.SecretSpec” array

 

2.3.141. v1.ProjectList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.24, “v1.ListMeta”

 

items

list of projects

true

Section 2.3.107, “v1.Project” array

 

2.3.142. v1.CustomDeploymentStrategyParams

NameDescriptionRequiredSchemaDefault

image

a Docker image which can carry out a deployment

false

string

 

environment

environment variables provided to the deployment process container

false

Section 2.3.149, “v1.EnvVar” array

 

command

optionally overrides the container command (default is specified by the image)

false

string array

 

2.3.143. v1.StatusDetails

NameDescriptionRequiredSchemaDefault

name

the name attribute of the resource associated with the status StatusReason (when there is a single name which can be described)

false

string

 

kind

the kind attribute of the resource associated with the status StatusReason; on some operations may differ from the requested resource Kind; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

causes

the Causes array includes more details associated with the StatusReason failure; not all StatusReasons may provide detailed causes

false

Section 2.3.70, “v1.StatusCause” array

 

retryAfterSeconds

the number of seconds before the client should attempt to retry this operation

false

integer (int32)

 

2.3.144. v1.ClusterRole

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

rules

list of policy rules

true

Section 2.3.81, “v1.PolicyRule” array

 

2.3.145. v1.Route

A route allows developers to expose services through an HTTP(S) aware load balancing and proxy layer via a public DNS entry. The route may further specify TLS options and a certificate, or specify a public CNAME that the router should also accept for HTTP and HTTPS traffic. An administrator typically configures their router to be visible outside the cluster firewall, and may also add additional security, caching, or traffic controls on the service content. Routers usually talk directly to the service endpoints.

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

spec

desired state of the route

true

Section 2.3.93, “v1.RouteSpec”

 

status

current state of the route

true

Section 2.3.19, “v1.RouteStatus”

 

2.3.146. v1.ImageStream

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

spec

desired state of the stream

true

Section 2.3.65, “v1.ImageStreamSpec”

 

status

current state of the stream as observed by the system

false

Section 2.3.40, “v1.ImageStreamStatus”

 

2.3.147. runtime.RawExtension

this may be any JSON object with a 'kind' and 'apiVersion' field; and is preserved unmodified by processing

2.3.148. v1.ImageChangeTrigger

NameDescriptionRequiredSchemaDefault

lastTriggeredImageID

used internally to save last used image ID for build

false

string

 

from

reference to an ImageStreamTag that will trigger the build

false

Section 2.3.122, “v1.ObjectReference”

 

2.3.149. v1.EnvVar

NameDescriptionRequiredSchemaDefault

name

name of the environment variable; must be a C_IDENTIFIER

true

string

 

value

value of the environment variable; defaults to empty string; variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables; if a variable cannot be resolved, the reference in the input string will be unchanged; the $(VAR_NAME) syntax can be escaped with a double , ie: (VAR_NAME) ; escaped references will never be expanded, regardless of whether the variable exists or not

false

string

 

valueFrom

source for the environment variable’s value; cannot be used if value is not empty

false

Section 2.3.77, “v1.EnvVarSource”

 

2.3.150. v1.Policy

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

lastModified

last time that any part of the policy was created, updated, or deleted

true

string (date-time)

 

roles

roles held by this policy

true

Section 2.3.69, “v1.NamedRole” array

 

2.3.151. v1.PolicyBinding

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

lastModified

last time that any part of the object was created, updated, or deleted

true

string (date-time)

 

policyRef

reference to the policy that contains all the Roles that this object’s roleBindings may reference

true

Section 2.3.122, “v1.ObjectReference”

 

roleBindings

all roleBindings held by this policyBinding

true

Section 2.3.117, “v1.NamedRoleBinding” array

 

2.3.152. v1.RouteList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.24, “v1.ListMeta”

 

items

list of routes

true

Section 2.3.145, “v1.Route” array

 

2.3.153. v1.RoleBindingList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.24, “v1.ListMeta”

 

items

list of role bindings

true

Section 2.3.133, “v1.RoleBinding” array

 

2.3.154. v1.TagEvent

NameDescriptionRequiredSchemaDefault

created

when the event was created

true

string (date-time)

 

dockerImageReference

the string that can be used to pull this image

true

string

 

image

the image

true

string

 

2.3.155. v1.FinalizerName

2.3.156. v1.DeploymentStrategy

NameDescriptionRequiredSchemaDefault

type

the name of a deployment strategy

false

string

 

customParams

input to the Custom deployment strategy

false

Section 2.3.142, “v1.CustomDeploymentStrategyParams”

 

recreateParams

input to the Recreate deployment strategy

false

Section 2.3.95, “v1.RecreateDeploymentStrategyParams”

 

rollingParams

input to the Rolling deployment strategy

false

Section 2.3.64, “v1.RollingDeploymentStrategyParams”

 

resources

resource requirements to execute the deployment

false

Section 2.3.37, “v1.ResourceRequirements”

 

2.3.157. v1.ResourceAccessReview

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

namespace

namespace of the action being requested

true

string

 

verb

one of get, list, watch, create, update, delete

true

string

 

resource

one of the existing resource types

true

string

 

resourceName

name of the resource being requested for a get or delete

true

string

 

content

actual content of the request for create and update

false

string

 

2.3.158. v1.GlusterfsVolumeSource

NameDescriptionRequiredSchemaDefault

endpoints

gluster hosts endpoints name; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod

true

string

 

path

path to gluster volume; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod

true

string

 

readOnly

glusterfs volume to be mounted with read-only permissions; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod

false

boolean

false

2.3.159. v1.ProjectSpec

NameDescriptionRequiredSchemaDefault

finalizers

an opaque list of values that must be empty to permanently remove object from storage

false

Section 2.3.155, “v1.FinalizerName” array

 

2.3.160. v1.DeploymentTriggerImageChangeParams

NameDescriptionRequiredSchemaDefault

automatic

whether detection of a new tag value should trigger a deployment

false

boolean

false

containerNames

restricts tag updates to a set of container names in the pod

false

string array

 

from

a reference to an ImageRepository, ImageStream, or ImageStreamTag to watch for changes

true

Section 2.3.122, “v1.ObjectReference”

 

lastTriggeredImage

the last image to be triggered

false

string

 

2.3.161. any

Represents an untyped JSON map - see the description of the field for more info about the structure of this object.

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. create a Binding

POST /api/v1/bindings

3.2.1.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.103, “v1.Binding”

 

3.2.1.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.103, “v1.Binding”

3.2.1.3. Consumes

  • /

3.2.1.4. Produces

  • application/json

3.2.1.5. Tags

  • apiv1

3.2.2. list objects of kind ComponentStatus

GET /api/v1/componentstatuses

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

false

string

 

3.2.2.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.96, “v1.ComponentStatusList”

3.2.2.3. Consumes

  • /

3.2.2.4. Produces

  • application/json

3.2.2.5. Tags

  • apiv1

3.2.3. list or watch objects of kind Endpoints

GET /api/v1/endpoints

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

false

string

 

3.2.3.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.53, “v1.EndpointsList”

3.2.3.3. Consumes

  • /

3.2.3.4. Produces

  • application/json

3.2.3.5. Tags

  • apiv1

3.2.4. create a Endpoints

POST /api/v1/endpoints

3.2.4.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.89, “v1.Endpoints”

 

3.2.4.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.89, “v1.Endpoints”

3.2.4.3. Consumes

  • /

3.2.4.4. Produces

  • application/json

3.2.4.5. Tags

  • apiv1

3.2.5. list or watch objects of kind Event

GET /api/v1/events

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

false

string

 

3.2.5.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.79, “v1.EventList”

3.2.5.3. Consumes

  • /

3.2.5.4. Produces

  • application/json

3.2.5.5. Tags

  • apiv1

3.2.6. create a Event

POST /api/v1/events

3.2.6.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.9, “v1.Event”

 

3.2.6.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.9, “v1.Event”

3.2.6.3. Consumes

  • /

3.2.6.4. Produces

  • application/json

3.2.6.5. Tags

  • apiv1

3.2.7. list or watch objects of kind LimitRange

GET /api/v1/limitranges

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

false

string

 

3.2.7.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.41, “v1.LimitRangeList”

3.2.7.3. Consumes

  • /

3.2.7.4. Produces

  • application/json

3.2.7.5. Tags

  • apiv1

3.2.8. create a LimitRange

POST /api/v1/limitranges

3.2.8.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.113, “v1.LimitRange”

 

3.2.8.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.113, “v1.LimitRange”

3.2.8.3. Consumes

  • /

3.2.8.4. Produces

  • application/json

3.2.8.5. Tags

  • apiv1

3.2.9. list or watch objects of kind Namespace

GET /api/v1/namespaces

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

false

string

 

3.2.9.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.60, “v1.NamespaceList”

3.2.9.3. Consumes

  • /

3.2.9.4. Produces

  • application/json

3.2.9.5. Tags

  • apiv1

3.2.10. create a Namespace

POST /api/v1/namespaces

3.2.10.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.51, “v1.Namespace”

 

3.2.10.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.51, “v1.Namespace”

3.2.10.3. Consumes

  • /

3.2.10.4. Produces

  • application/json

3.2.10.5. Tags

  • apiv1

3.2.11. create a Binding

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

3.2.11.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.103, “v1.Binding”

 

PathParameter

namespace

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

true

string

 

3.2.11.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.103, “v1.Binding”

3.2.11.3. Consumes

  • /

3.2.11.4. Produces

  • application/json

3.2.11.5. Tags

  • apiv1

3.2.12. list objects of kind ComponentStatus

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

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

false

string

 

PathParameter

namespace

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

true

string

 

3.2.12.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.96, “v1.ComponentStatusList”

3.2.12.3. Consumes

  • /

3.2.12.4. Produces

  • application/json

3.2.12.5. Tags

  • apiv1

3.2.13. read the specified ComponentStatus

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

3.2.13.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 ComponentStatus

true

string

 

3.2.13.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.82, “v1.ComponentStatus”

3.2.13.3. Consumes

  • /

3.2.13.4. Produces

  • application/json

3.2.13.5. Tags

  • apiv1

3.2.14. list or watch objects of kind Endpoints

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

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

false

string

 

PathParameter

namespace

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

true

string

 

3.2.14.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.53, “v1.EndpointsList”

3.2.14.3. Consumes

  • /

3.2.14.4. Produces

  • application/json

3.2.14.5. Tags

  • apiv1

3.2.15. create a Endpoints

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

3.2.15.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.89, “v1.Endpoints”

 

PathParameter

namespace

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

true

string

 

3.2.15.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.89, “v1.Endpoints”

3.2.15.3. Consumes

  • /

3.2.15.4. Produces

  • application/json

3.2.15.5. Tags

  • apiv1

3.2.16. read the specified Endpoints

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

3.2.16.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 Endpoints

true

string

 

3.2.16.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.89, “v1.Endpoints”

3.2.16.3. Consumes

  • /

3.2.16.4. Produces

  • application/json

3.2.16.5. Tags

  • apiv1

3.2.17. replace the specified Endpoints

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

3.2.17.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.89, “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.17.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.89, “v1.Endpoints”

3.2.17.3. Consumes

  • /

3.2.17.4. Produces

  • application/json

3.2.17.5. Tags

  • apiv1

3.2.18. delete a Endpoints

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

3.2.18.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Endpoints

true

string

 

3.2.18.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

3.2.18.3. Consumes

  • /

3.2.18.4. Produces

  • application/json

3.2.18.5. Tags

  • apiv1

3.2.19. partially update the specified Endpoints

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

3.2.19.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.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.19.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.89, “v1.Endpoints”

3.2.19.3. Consumes

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

3.2.19.4. Produces

  • application/json

3.2.19.5. Tags

  • apiv1

3.2.20. list or watch objects of kind Event

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

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

false

string

 

PathParameter

namespace

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

true

string

 

3.2.20.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.79, “v1.EventList”

3.2.20.3. Consumes

  • /

3.2.20.4. Produces

  • application/json

3.2.20.5. Tags

  • apiv1

3.2.21. create a Event

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

3.2.21.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.9, “v1.Event”

 

PathParameter

namespace

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

true

string

 

3.2.21.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.9, “v1.Event”

3.2.21.3. Consumes

  • /

3.2.21.4. Produces

  • application/json

3.2.21.5. Tags

  • apiv1

3.2.22. read the specified Event

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

3.2.22.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 Event

true

string

 

3.2.22.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.9, “v1.Event”

3.2.22.3. Consumes

  • /

3.2.22.4. Produces

  • application/json

3.2.22.5. Tags

  • apiv1

3.2.23. replace the specified Event

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

3.2.23.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.9, “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.23.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.9, “v1.Event”

3.2.23.3. Consumes

  • /

3.2.23.4. Produces

  • application/json

3.2.23.5. Tags

  • apiv1

3.2.24. delete a Event

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

3.2.24.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 Event

true

string

 

3.2.24.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

3.2.24.3. Consumes

  • /

3.2.24.4. Produces

  • application/json

3.2.24.5. Tags

  • apiv1

3.2.25. partially update the specified Event

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

3.2.25.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.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.25.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.9, “v1.Event”

3.2.25.3. Consumes

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

3.2.25.4. Produces

  • application/json

3.2.25.5. Tags

  • apiv1

3.2.26. list or watch objects of kind LimitRange

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

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

false

string

 

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 3.3.41, “v1.LimitRangeList”

3.2.26.3. Consumes

  • /

3.2.26.4. Produces

  • application/json

3.2.26.5. Tags

  • apiv1

3.2.27. create a LimitRange

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

3.2.27.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.113, “v1.LimitRange”

 

PathParameter

namespace

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

true

string

 

3.2.27.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.113, “v1.LimitRange”

3.2.27.3. Consumes

  • /

3.2.27.4. Produces

  • application/json

3.2.27.5. Tags

  • apiv1

3.2.28. read the specified LimitRange

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

3.2.28.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 LimitRange

true

string

 

3.2.28.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.113, “v1.LimitRange”

3.2.28.3. Consumes

  • /

3.2.28.4. Produces

  • application/json

3.2.28.5. Tags

  • apiv1

3.2.29. replace the specified LimitRange

PUT /api/v1/namespaces/{namespace}/limitranges/{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.113, “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.29.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.113, “v1.LimitRange”

3.2.29.3. Consumes

  • /

3.2.29.4. Produces

  • application/json

3.2.29.5. Tags

  • apiv1

3.2.30. delete a LimitRange

DELETE /api/v1/namespaces/{namespace}/limitranges/{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.23, “v1.DeleteOptions”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the LimitRange

true

string

 

3.2.30.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

3.2.30.3. Consumes

  • /

3.2.30.4. Produces

  • application/json

3.2.30.5. Tags

  • apiv1

3.2.31. partially update the specified LimitRange

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

3.2.31.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.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.31.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.113, “v1.LimitRange”

3.2.31.3. Consumes

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

3.2.31.4. Produces

  • application/json

3.2.31.5. Tags

  • apiv1

3.2.32. list or watch objects of kind PersistentVolumeClaim

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

3.2.32.1. Description

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

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

false

string

 

PathParameter

namespace

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

true

string

 

3.2.32.3. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.81, “v1.PersistentVolumeClaimList”

3.2.32.4. Consumes

  • /

3.2.32.5. Produces

  • application/json

3.2.32.6. Tags

  • apiv1

3.2.33. create a PersistentVolumeClaim

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

3.2.33.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.24, “v1.PersistentVolumeClaim”

 

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 3.3.24, “v1.PersistentVolumeClaim”

3.2.33.3. Consumes

  • /

3.2.33.4. Produces

  • application/json

3.2.33.5. Tags

  • apiv1

3.2.34. read the specified PersistentVolumeClaim

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

3.2.34.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.34.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.24, “v1.PersistentVolumeClaim”

3.2.34.3. Consumes

  • /

3.2.34.4. Produces

  • application/json

3.2.34.5. Tags

  • apiv1

3.2.35. replace the specified PersistentVolumeClaim

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

3.2.35.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.24, “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.35.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.24, “v1.PersistentVolumeClaim”

3.2.35.3. Consumes

  • /

3.2.35.4. Produces

  • application/json

3.2.35.5. Tags

  • apiv1

3.2.36. delete a PersistentVolumeClaim

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

3.2.36.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the PersistentVolumeClaim

true

string

 

3.2.36.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

3.2.36.3. Consumes

  • /

3.2.36.4. Produces

  • application/json

3.2.36.5. Tags

  • apiv1

3.2.37. partially update the specified PersistentVolumeClaim

PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{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.98, “api.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.37.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.24, “v1.PersistentVolumeClaim”

3.2.37.3. Consumes

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

3.2.37.4. Produces

  • application/json

3.2.37.5. Tags

  • apiv1

3.2.38. replace status of the specified PersistentVolumeClaim

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

3.2.38.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.24, “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.38.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.24, “v1.PersistentVolumeClaim”

3.2.38.3. Consumes

  • /

3.2.38.4. Produces

  • application/json

3.2.38.5. Tags

  • apiv1

3.2.39. list or watch objects of kind Pod

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

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

false

string

 

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.69, “v1.PodList”

3.2.39.3. Consumes

  • /

3.2.39.4. Produces

  • application/json

3.2.39.5. Tags

  • apiv1

3.2.40. create a Pod

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

3.2.40.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.8, “v1.Pod”

 

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 3.3.8, “v1.Pod”

3.2.40.3. Consumes

  • /

3.2.40.4. Produces

  • application/json

3.2.40.5. Tags

  • apiv1

3.2.41. read the specified Pod

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

3.2.41.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.41.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.8, “v1.Pod”

3.2.41.3. Consumes

  • /

3.2.41.4. Produces

  • application/json

3.2.41.5. Tags

  • apiv1

3.2.42. replace the specified Pod

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

3.2.42.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.8, “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.42.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.8, “v1.Pod”

3.2.42.3. Consumes

  • /

3.2.42.4. Produces

  • application/json

3.2.42.5. Tags

  • apiv1

3.2.43. delete a Pod

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

3.2.43.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Pod

true

string

 

3.2.43.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

3.2.43.3. Consumes

  • /

3.2.43.4. Produces

  • application/json

3.2.43.5. Tags

  • apiv1

3.2.44. partially update the specified Pod

PATCH /api/v1/namespaces/{namespace}/pods/{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.98, “api.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.44.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.8, “v1.Pod”

3.2.44.3. Consumes

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

3.2.44.4. Produces

  • application/json

3.2.44.5. Tags

  • apiv1

3.2.45. connect GET requests to attach of Pod

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

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

allocate a terminal for this attach call; 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.45.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.45.3. Consumes

  • /

3.2.45.4. Produces

  • /

3.2.45.5. Tags

  • apiv1

3.2.46. connect POST requests to attach of Pod

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

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

allocate a terminal for this attach call; 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.46.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.46.3. Consumes

  • /

3.2.46.4. Produces

  • /

3.2.46.5. Tags

  • apiv1

3.2.47. create binding of a Binding

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

3.2.47.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.103, “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.47.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.103, “v1.Binding”

3.2.47.3. Consumes

  • /

3.2.47.4. Produces

  • application/json

3.2.47.5. Tags

  • apiv1

3.2.48. connect GET requests to exec of Pod

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

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

allocate a terminal for this exec call; 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

 

QueryParameter

command

the command to execute; argv array; not executed within a shell

false

ref

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Pod

true

string

 

3.2.48.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.48.3. Consumes

  • /

3.2.48.4. Produces

  • /

3.2.48.5. Tags

  • apiv1

3.2.49. connect POST requests to exec of Pod

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

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

allocate a terminal for this exec call; 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

 

QueryParameter

command

the command to execute; argv array; not executed within a shell

false

ref

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Pod

true

string

 

3.2.49.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.49.3. Consumes

  • /

3.2.49.4. Produces

  • /

3.2.49.5. Tags

  • apiv1

3.2.50. read log of the specified Pod

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

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

 

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.50.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.8, “v1.Pod”

3.2.50.3. Consumes

  • /

3.2.50.4. Produces

  • application/json

3.2.50.5. Tags

  • apiv1

3.2.51. connect GET requests to portforward of Pod

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

3.2.51.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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.51.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.51.3. Consumes

  • /

3.2.51.4. Produces

  • /

3.2.51.5. Tags

  • apiv1

3.2.52. connect POST requests to portforward of Pod

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

3.2.52.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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.52.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.52.3. Consumes

  • /

3.2.52.4. Produces

  • /

3.2.52.5. Tags

  • apiv1

3.2.53. connect GET requests to proxy of Pod

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

3.2.53.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

URL path to use in 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.53.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.53.3. Consumes

  • /

3.2.53.4. Produces

  • /

3.2.53.5. Tags

  • apiv1

3.2.54. connect PUT requests to proxy of Pod

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

3.2.54.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

URL path to use in 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.54.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.54.3. Consumes

  • /

3.2.54.4. Produces

  • /

3.2.54.5. Tags

  • apiv1

3.2.55. connect DELETE requests to proxy of Pod

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

3.2.55.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

URL path to use in 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.55.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.55.3. Consumes

  • /

3.2.55.4. Produces

  • /

3.2.55.5. Tags

  • apiv1

3.2.56. connect POST requests to proxy of Pod

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

3.2.56.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

URL path to use in 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.56.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.56.3. Consumes

  • /

3.2.56.4. Produces

  • /

3.2.56.5. Tags

  • apiv1

3.2.57. connect GET requests to proxy of Pod

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

3.2.57.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

URL path to use in 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.57.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.57.3. Consumes

  • /

3.2.57.4. Produces

  • /

3.2.57.5. Tags

  • apiv1

3.2.58. connect PUT requests to proxy of Pod

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

3.2.58.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

URL path to use in 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.58.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.58.3. Consumes

  • /

3.2.58.4. Produces

  • /

3.2.58.5. Tags

  • apiv1

3.2.59. connect DELETE requests to proxy of Pod

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

3.2.59.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

URL path to use in 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.59.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.59.3. Consumes

  • /

3.2.59.4. Produces

  • /

3.2.59.5. Tags

  • apiv1

3.2.60. connect POST requests to proxy of Pod

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

3.2.60.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

URL path to use in 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.60.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.60.3. Consumes

  • /

3.2.60.4. Produces

  • /

3.2.60.5. Tags

  • apiv1

3.2.61. replace status of the specified Pod

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

3.2.61.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.8, “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.61.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.8, “v1.Pod”

3.2.61.3. Consumes

  • /

3.2.61.4. Produces

  • application/json

3.2.61.5. Tags

  • apiv1

3.2.62. list or watch objects of kind PodTemplate

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

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

false

string

 

PathParameter

namespace

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

true

string

 

3.2.62.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.110, “v1.PodTemplateList”

3.2.62.3. Consumes

  • /

3.2.62.4. Produces

  • application/json

3.2.62.5. Tags

  • apiv1

3.2.63. create a PodTemplate

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

3.2.63.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.68, “v1.PodTemplate”

 

PathParameter

namespace

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

true

string

 

3.2.63.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.68, “v1.PodTemplate”

3.2.63.3. Consumes

  • /

3.2.63.4. Produces

  • application/json

3.2.63.5. Tags

  • apiv1

3.2.64. read the specified PodTemplate

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

3.2.64.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 PodTemplate

true

string

 

3.2.64.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.68, “v1.PodTemplate”

3.2.64.3. Consumes

  • /

3.2.64.4. Produces

  • application/json

3.2.64.5. Tags

  • apiv1

3.2.65. replace the specified PodTemplate

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

3.2.65.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.68, “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.65.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.68, “v1.PodTemplate”

3.2.65.3. Consumes

  • /

3.2.65.4. Produces

  • application/json

3.2.65.5. Tags

  • apiv1

3.2.66. delete a PodTemplate

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

3.2.66.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the PodTemplate

true

string

 

3.2.66.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

3.2.66.3. Consumes

  • /

3.2.66.4. Produces

  • application/json

3.2.66.5. Tags

  • apiv1

3.2.67. partially update the specified PodTemplate

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

3.2.67.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.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.67.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.68, “v1.PodTemplate”

3.2.67.3. Consumes

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

3.2.67.4. Produces

  • application/json

3.2.67.5. Tags

  • apiv1

3.2.68. list or watch objects of kind ReplicationController

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

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

false

string

 

PathParameter

namespace

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

true

string

 

3.2.68.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.6, “v1.ReplicationControllerList”

3.2.68.3. Consumes

  • /

3.2.68.4. Produces

  • application/json

3.2.68.5. Tags

  • apiv1

3.2.69. create a ReplicationController

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

3.2.69.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.59, “v1.ReplicationController”

 

PathParameter

namespace

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

true

string

 

3.2.69.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.59, “v1.ReplicationController”

3.2.69.3. Consumes

  • /

3.2.69.4. Produces

  • application/json

3.2.69.5. Tags

  • apiv1

3.2.70. read the specified ReplicationController

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

3.2.70.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.70.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.59, “v1.ReplicationController”

3.2.70.3. Consumes

  • /

3.2.70.4. Produces

  • application/json

3.2.70.5. Tags

  • apiv1

3.2.71. replace the specified ReplicationController

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

3.2.71.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.59, “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.71.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.59, “v1.ReplicationController”

3.2.71.3. Consumes

  • /

3.2.71.4. Produces

  • application/json

3.2.71.5. Tags

  • apiv1

3.2.72. delete a ReplicationController

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

3.2.72.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the ReplicationController

true

string

 

3.2.72.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

3.2.72.3. Consumes

  • /

3.2.72.4. Produces

  • application/json

3.2.72.5. Tags

  • apiv1

3.2.73. partially update the specified ReplicationController

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

3.2.73.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.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.73.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.59, “v1.ReplicationController”

3.2.73.3. Consumes

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

3.2.73.4. Produces

  • application/json

3.2.73.5. Tags

  • apiv1

3.2.74. list or watch objects of kind ResourceQuota

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

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

false

string

 

PathParameter

namespace

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

true

string

 

3.2.74.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.74, “v1.ResourceQuotaList”

3.2.74.3. Consumes

  • /

3.2.74.4. Produces

  • application/json

3.2.74.5. Tags

  • apiv1

3.2.75. create a ResourceQuota

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

3.2.75.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.106, “v1.ResourceQuota”

 

PathParameter

namespace

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

true

string

 

3.2.75.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.106, “v1.ResourceQuota”

3.2.75.3. Consumes

  • /

3.2.75.4. Produces

  • application/json

3.2.75.5. Tags

  • apiv1

3.2.76. read the specified ResourceQuota

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

3.2.76.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 ResourceQuota

true

string

 

3.2.76.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.106, “v1.ResourceQuota”

3.2.76.3. Consumes

  • /

3.2.76.4. Produces

  • application/json

3.2.76.5. Tags

  • apiv1

3.2.77. replace the specified ResourceQuota

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

3.2.77.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.106, “v1.ResourceQuota”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the ResourceQuota

true

string

 

3.2.77.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.106, “v1.ResourceQuota”

3.2.77.3. Consumes

  • /

3.2.77.4. Produces

  • application/json

3.2.77.5. Tags

  • apiv1

3.2.78. delete a ResourceQuota

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

3.2.78.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the ResourceQuota

true

string

 

3.2.78.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

3.2.78.3. Consumes

  • /

3.2.78.4. Produces

  • application/json

3.2.78.5. Tags

  • apiv1

3.2.79. partially update the specified ResourceQuota

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

3.2.79.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the ResourceQuota

true

string

 

3.2.79.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.106, “v1.ResourceQuota”

3.2.79.3. Consumes

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

3.2.79.4. Produces

  • application/json

3.2.79.5. Tags

  • apiv1

3.2.80. replace status of the specified ResourceQuota

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

3.2.80.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.106, “v1.ResourceQuota”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the ResourceQuota

true

string

 

3.2.80.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.106, “v1.ResourceQuota”

3.2.80.3. Consumes

  • /

3.2.80.4. Produces

  • application/json

3.2.80.5. Tags

  • apiv1

3.2.81. list or watch objects of kind Secret

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

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

false

string

 

PathParameter

namespace

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

true

string

 

3.2.81.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.16, “v1.SecretList”

3.2.81.3. Consumes

  • /

3.2.81.4. Produces

  • application/json

3.2.81.5. Tags

  • apiv1

3.2.82. create a Secret

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

3.2.82.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.87, “v1.Secret”

 

PathParameter

namespace

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

true

string

 

3.2.82.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.87, “v1.Secret”

3.2.82.3. Consumes

  • /

3.2.82.4. Produces

  • application/json

3.2.82.5. Tags

  • apiv1

3.2.83. read the specified Secret

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

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 Secret

true

string

 

3.2.83.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.87, “v1.Secret”

3.2.83.3. Consumes

  • /

3.2.83.4. Produces

  • application/json

3.2.83.5. Tags

  • apiv1

3.2.84. replace the specified Secret

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

3.2.84.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.87, “v1.Secret”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Secret

true

string

 

3.2.84.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.87, “v1.Secret”

3.2.84.3. Consumes

  • /

3.2.84.4. Produces

  • application/json

3.2.84.5. Tags

  • apiv1

3.2.85. delete a Secret

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

3.2.85.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Secret

true

string

 

3.2.85.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

3.2.85.3. Consumes

  • /

3.2.85.4. Produces

  • application/json

3.2.85.5. Tags

  • apiv1

3.2.86. partially update the specified Secret

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

3.2.86.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Secret

true

string

 

3.2.86.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.87, “v1.Secret”

3.2.86.3. Consumes

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

3.2.86.4. Produces

  • application/json

3.2.86.5. Tags

  • apiv1

3.2.87. list or watch objects of kind ServiceAccount

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

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

false

string

 

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.75, “v1.ServiceAccountList”

3.2.87.3. Consumes

  • /

3.2.87.4. Produces

  • application/json

3.2.87.5. Tags

  • apiv1

3.2.88. create a ServiceAccount

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

3.2.88.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.67, “v1.ServiceAccount”

 

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 3.3.67, “v1.ServiceAccount”

3.2.88.3. Consumes

  • /

3.2.88.4. Produces

  • application/json

3.2.88.5. Tags

  • apiv1

3.2.89. read the specified ServiceAccount

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

3.2.89.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 ServiceAccount

true

string

 

3.2.89.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.67, “v1.ServiceAccount”

3.2.89.3. Consumes

  • /

3.2.89.4. Produces

  • application/json

3.2.89.5. Tags

  • apiv1

3.2.90. replace the specified ServiceAccount

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

3.2.90.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.67, “v1.ServiceAccount”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the ServiceAccount

true

string

 

3.2.90.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.67, “v1.ServiceAccount”

3.2.90.3. Consumes

  • /

3.2.90.4. Produces

  • application/json

3.2.90.5. Tags

  • apiv1

3.2.91. delete a ServiceAccount

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

3.2.91.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the ServiceAccount

true

string

 

3.2.91.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

3.2.91.3. Consumes

  • /

3.2.91.4. Produces

  • application/json

3.2.91.5. Tags

  • apiv1

3.2.92. partially update the specified ServiceAccount

PATCH /api/v1/namespaces/{namespace}/serviceaccounts/{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.98, “api.Patch”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the ServiceAccount

true

string

 

3.2.92.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.67, “v1.ServiceAccount”

3.2.92.3. Consumes

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

3.2.92.4. Produces

  • application/json

3.2.92.5. Tags

  • apiv1

3.2.93. list or watch objects of kind Service

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

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

false

string

 

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.34, “v1.ServiceList”

3.2.93.3. Consumes

  • /

3.2.93.4. Produces

  • application/json

3.2.93.5. Tags

  • apiv1

3.2.94. create a Service

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

3.2.94.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.93, “v1.Service”

 

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.93, “v1.Service”

3.2.94.3. Consumes

  • /

3.2.94.4. Produces

  • application/json

3.2.94.5. Tags

  • apiv1

3.2.95. read the specified Service

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

3.2.95.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 Service

true

string

 

3.2.95.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.93, “v1.Service”

3.2.95.3. Consumes

  • /

3.2.95.4. Produces

  • application/json

3.2.95.5. Tags

  • apiv1

3.2.96. replace the specified Service

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

3.2.96.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.93, “v1.Service”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Service

true

string

 

3.2.96.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.93, “v1.Service”

3.2.96.3. Consumes

  • /

3.2.96.4. Produces

  • application/json

3.2.96.5. Tags

  • apiv1

3.2.97. delete a Service

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

3.2.97.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 Service

true

string

 

3.2.97.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

3.2.97.3. Consumes

  • /

3.2.97.4. Produces

  • application/json

3.2.97.5. Tags

  • apiv1

3.2.98. partially update the specified Service

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

3.2.98.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Service

true

string

 

3.2.98.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.93, “v1.Service”

3.2.98.3. Consumes

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

3.2.98.4. Produces

  • application/json

3.2.98.5. Tags

  • apiv1

3.2.99. read the specified Namespace

GET /api/v1/namespaces/{name}

3.2.99.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

PathParameter

name

name of the Namespace

true

string

 

3.2.99.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.51, “v1.Namespace”

3.2.99.3. Consumes

  • /

3.2.99.4. Produces

  • application/json

3.2.99.5. Tags

  • apiv1

3.2.100. replace the specified Namespace

PUT /api/v1/namespaces/{name}

3.2.100.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.51, “v1.Namespace”

 

PathParameter

name

name of the Namespace

true

string

 

3.2.100.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.51, “v1.Namespace”

3.2.100.3. Consumes

  • /

3.2.100.4. Produces

  • application/json

3.2.100.5. Tags

  • apiv1

3.2.101. delete a Namespace

DELETE /api/v1/namespaces/{name}

3.2.101.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

name

name of the Namespace

true

string

 

3.2.101.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

3.2.101.3. Consumes

  • /

3.2.101.4. Produces

  • application/json

3.2.101.5. Tags

  • apiv1

3.2.102. partially update the specified Namespace

PATCH /api/v1/namespaces/{name}

3.2.102.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

name

name of the Namespace

true

string

 

3.2.102.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.51, “v1.Namespace”

3.2.102.3. Consumes

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

3.2.102.4. Produces

  • application/json

3.2.102.5. Tags

  • apiv1

3.2.103. replace finalize of the specified Namespace

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

3.2.103.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.51, “v1.Namespace”

 

PathParameter

name

name of the Namespace

true

string

 

3.2.103.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.51, “v1.Namespace”

3.2.103.3. Consumes

  • /

3.2.103.4. Produces

  • application/json

3.2.103.5. Tags

  • apiv1

3.2.104. replace status of the specified Namespace

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

3.2.104.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.51, “v1.Namespace”

 

PathParameter

name

name of the Namespace

true

string

 

3.2.104.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.51, “v1.Namespace”

3.2.104.3. Consumes

  • /

3.2.104.4. Produces

  • application/json

3.2.104.5. Tags

  • apiv1

3.2.105. list or watch objects of kind Node

GET /api/v1/nodes

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

false

string

 

3.2.105.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.54, “v1.NodeList”

3.2.105.3. Consumes

  • /

3.2.105.4. Produces

  • application/json

3.2.105.5. Tags

  • apiv1

3.2.106. create a Node

POST /api/v1/nodes

3.2.106.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.104, “v1.Node”

 

3.2.106.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.104, “v1.Node”

3.2.106.3. Consumes

  • /

3.2.106.4. Produces

  • application/json

3.2.106.5. Tags

  • apiv1

3.2.107. read the specified Node

GET /api/v1/nodes/{name}

3.2.107.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

PathParameter

name

name of the Node

true

string

 

3.2.107.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.104, “v1.Node”

3.2.107.3. Consumes

  • /

3.2.107.4. Produces

  • application/json

3.2.107.5. Tags

  • apiv1

3.2.108. replace the specified Node

PUT /api/v1/nodes/{name}

3.2.108.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.104, “v1.Node”

 

PathParameter

name

name of the Node

true

string

 

3.2.108.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.104, “v1.Node”

3.2.108.3. Consumes

  • /

3.2.108.4. Produces

  • application/json

3.2.108.5. Tags

  • apiv1

3.2.109. delete a Node

DELETE /api/v1/nodes/{name}

3.2.109.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

name

name of the Node

true

string

 

3.2.109.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

3.2.109.3. Consumes

  • /

3.2.109.4. Produces

  • application/json

3.2.109.5. Tags

  • apiv1

3.2.110. partially update the specified Node

PATCH /api/v1/nodes/{name}

3.2.110.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

name

name of the Node

true

string

 

3.2.110.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.104, “v1.Node”

3.2.110.3. Consumes

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

3.2.110.4. Produces

  • application/json

3.2.110.5. Tags

  • apiv1

3.2.111. replace status of the specified Node

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

3.2.111.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.104, “v1.Node”

 

PathParameter

name

name of the Node

true

string

 

3.2.111.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.104, “v1.Node”

3.2.111.3. Consumes

  • /

3.2.111.4. Produces

  • application/json

3.2.111.5. Tags

  • apiv1

3.2.112. list or watch objects of kind PersistentVolumeClaim

GET /api/v1/persistentvolumeclaims

3.2.112.1. Description

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

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

false

string

 

3.2.112.3. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.81, “v1.PersistentVolumeClaimList”

3.2.112.4. Consumes

  • /

3.2.112.5. Produces

  • application/json

3.2.112.6. Tags

  • apiv1

3.2.113. create a PersistentVolumeClaim

POST /api/v1/persistentvolumeclaims

3.2.113.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.24, “v1.PersistentVolumeClaim”

 

3.2.113.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.24, “v1.PersistentVolumeClaim”

3.2.113.3. Consumes

  • /

3.2.113.4. Produces

  • application/json

3.2.113.5. Tags

  • apiv1

3.2.114. list or watch objects of kind PersistentVolume

GET /api/v1/persistentvolumes

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

false

string

 

3.2.114.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.35, “v1.PersistentVolumeList”

3.2.114.3. Consumes

  • /

3.2.114.4. Produces

  • application/json

3.2.114.5. Tags

  • apiv1

3.2.115. create a PersistentVolume

POST /api/v1/persistentvolumes

3.2.115.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.1, “v1.PersistentVolume”

 

3.2.115.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.1, “v1.PersistentVolume”

3.2.115.3. Consumes

  • /

3.2.115.4. Produces

  • application/json

3.2.115.5. Tags

  • apiv1

3.2.116. read the specified PersistentVolume

GET /api/v1/persistentvolumes/{name}

3.2.116.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

PathParameter

name

name of the PersistentVolume

true

string

 

3.2.116.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.1, “v1.PersistentVolume”

3.2.116.3. Consumes

  • /

3.2.116.4. Produces

  • application/json

3.2.116.5. Tags

  • apiv1

3.2.117. replace the specified PersistentVolume

PUT /api/v1/persistentvolumes/{name}

3.2.117.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.1, “v1.PersistentVolume”

 

PathParameter

name

name of the PersistentVolume

true

string

 

3.2.117.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.1, “v1.PersistentVolume”

3.2.117.3. Consumes

  • /

3.2.117.4. Produces

  • application/json

3.2.117.5. Tags

  • apiv1

3.2.118. delete a PersistentVolume

DELETE /api/v1/persistentvolumes/{name}

3.2.118.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

name

name of the PersistentVolume

true

string

 

3.2.118.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

3.2.118.3. Consumes

  • /

3.2.118.4. Produces

  • application/json

3.2.118.5. Tags

  • apiv1

3.2.119. partially update the specified PersistentVolume

PATCH /api/v1/persistentvolumes/{name}

3.2.119.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

name

name of the PersistentVolume

true

string

 

3.2.119.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.1, “v1.PersistentVolume”

3.2.119.3. Consumes

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

3.2.119.4. Produces

  • application/json

3.2.119.5. Tags

  • apiv1

3.2.120. replace status of the specified PersistentVolume

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

3.2.120.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.1, “v1.PersistentVolume”

 

PathParameter

name

name of the PersistentVolume

true

string

 

3.2.120.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.1, “v1.PersistentVolume”

3.2.120.3. Consumes

  • /

3.2.120.4. Produces

  • application/json

3.2.120.5. Tags

  • apiv1

3.2.121. list or watch objects of kind Pod

GET /api/v1/pods

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

false

string

 

3.2.121.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.69, “v1.PodList”

3.2.121.3. Consumes

  • /

3.2.121.4. Produces

  • application/json

3.2.121.5. Tags

  • apiv1

3.2.122. create a Pod

POST /api/v1/pods

3.2.122.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.8, “v1.Pod”

 

3.2.122.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.8, “v1.Pod”

3.2.122.3. Consumes

  • /

3.2.122.4. Produces

  • application/json

3.2.122.5. Tags

  • apiv1

3.2.123. list or watch objects of kind PodTemplate

GET /api/v1/podtemplates

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

false

string

 

3.2.123.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.110, “v1.PodTemplateList”

3.2.123.3. Consumes

  • /

3.2.123.4. Produces

  • application/json

3.2.123.5. Tags

  • apiv1

3.2.124. create a PodTemplate

POST /api/v1/podtemplates

3.2.124.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.68, “v1.PodTemplate”

 

3.2.124.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.68, “v1.PodTemplate”

3.2.124.3. Consumes

  • /

3.2.124.4. Produces

  • application/json

3.2.124.5. Tags

  • apiv1

3.2.125. proxy GET requests to Pod

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

3.2.125.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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.125.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.125.3. Consumes

  • /

3.2.125.4. Produces

  • /

3.2.125.5. Tags

  • apiv1

3.2.126. proxy PUT requests to Pod

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

3.2.126.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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.126.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.126.3. Consumes

  • /

3.2.126.4. Produces

  • /

3.2.126.5. Tags

  • apiv1

3.2.127. proxy DELETE requests to Pod

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

3.2.127.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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.127.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.127.3. Consumes

  • /

3.2.127.4. Produces

  • /

3.2.127.5. Tags

  • apiv1

3.2.128. proxy POST requests to Pod

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

3.2.128.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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.128.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.128.3. Consumes

  • /

3.2.128.4. Produces

  • /

3.2.128.5. Tags

  • apiv1

3.2.129. proxy GET requests to Pod

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

3.2.129.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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.129.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.129.3. Consumes

  • /

3.2.129.4. Produces

  • /

3.2.129.5. Tags

  • apiv1

3.2.130. proxy PUT requests to Pod

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

3.2.130.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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.130.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.130.3. Consumes

  • /

3.2.130.4. Produces

  • /

3.2.130.5. Tags

  • apiv1

3.2.131. proxy DELETE requests to Pod

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

3.2.131.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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.131.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.131.3. Consumes

  • /

3.2.131.4. Produces

  • /

3.2.131.5. Tags

  • apiv1

3.2.132. proxy POST requests to Pod

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

3.2.132.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

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.132.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.132.3. Consumes

  • /

3.2.132.4. Produces

  • /

3.2.132.5. Tags

  • apiv1

3.2.133. proxy GET requests to Service

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

3.2.133.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Service

true

string

 

3.2.133.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.133.3. Consumes

  • /

3.2.133.4. Produces

  • /

3.2.133.5. Tags

  • apiv1

3.2.134. proxy PUT requests to Service

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

3.2.134.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Service

true

string

 

3.2.134.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.134.3. Consumes

  • /

3.2.134.4. Produces

  • /

3.2.134.5. Tags

  • apiv1

3.2.135. proxy DELETE requests to Service

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

3.2.135.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Service

true

string

 

3.2.135.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.135.3. Consumes

  • /

3.2.135.4. Produces

  • /

3.2.135.5. Tags

  • apiv1

3.2.136. proxy POST requests to Service

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

3.2.136.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Service

true

string

 

3.2.136.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.136.3. Consumes

  • /

3.2.136.4. Produces

  • /

3.2.136.5. Tags

  • apiv1

3.2.137. proxy GET requests to Service

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

3.2.137.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Service

true

string

 

PathParameter

path:*

path to the resource

true

string

 

3.2.137.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.137.3. Consumes

  • /

3.2.137.4. Produces

  • /

3.2.137.5. Tags

  • apiv1

3.2.138. proxy PUT requests to Service

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

3.2.138.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Service

true

string

 

PathParameter

path:*

path to the resource

true

string

 

3.2.138.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.138.3. Consumes

  • /

3.2.138.4. Produces

  • /

3.2.138.5. Tags

  • apiv1

3.2.139. proxy DELETE requests to Service

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

3.2.139.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Service

true

string

 

PathParameter

path:*

path to the resource

true

string

 

3.2.139.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.139.3. Consumes

  • /

3.2.139.4. Produces

  • /

3.2.139.5. Tags

  • apiv1

3.2.140. proxy POST requests to Service

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

3.2.140.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Service

true

string

 

PathParameter

path:*

path to the resource

true

string

 

3.2.140.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.140.3. Consumes

  • /

3.2.140.4. Produces

  • /

3.2.140.5. Tags

  • apiv1

3.2.141. proxy GET requests to Node

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

3.2.141.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

 

3.2.141.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.141.3. Consumes

  • /

3.2.141.4. Produces

  • /

3.2.141.5. Tags

  • apiv1

3.2.142. proxy PUT requests to Node

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

3.2.142.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

 

3.2.142.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.142.3. Consumes

  • /

3.2.142.4. Produces

  • /

3.2.142.5. Tags

  • apiv1

3.2.143. proxy DELETE requests to Node

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

3.2.143.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

 

3.2.143.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.143.3. Consumes

  • /

3.2.143.4. Produces

  • /

3.2.143.5. Tags

  • apiv1

3.2.144. proxy POST requests to Node

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

3.2.144.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

 

3.2.144.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.144.3. Consumes

  • /

3.2.144.4. Produces

  • /

3.2.144.5. Tags

  • apiv1

3.2.145. proxy GET requests to Node

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

3.2.145.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

 

PathParameter

path:*

path to the resource

true

string

 

3.2.145.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.145.3. Consumes

  • /

3.2.145.4. Produces

  • /

3.2.145.5. Tags

  • apiv1

3.2.146. proxy PUT requests to Node

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

3.2.146.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

 

PathParameter

path:*

path to the resource

true

string

 

3.2.146.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.146.3. Consumes

  • /

3.2.146.4. Produces

  • /

3.2.146.5. Tags

  • apiv1

3.2.147. proxy DELETE requests to Node

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

3.2.147.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

 

PathParameter

path:*

path to the resource

true

string

 

3.2.147.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.147.3. Consumes

  • /

3.2.147.4. Produces

  • /

3.2.147.5. Tags

  • apiv1

3.2.148. proxy POST requests to Node

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

3.2.148.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

 

PathParameter

path:*

path to the resource

true

string

 

3.2.148.2. Responses

HTTP CodeDescriptionSchema

default

success

string

3.2.148.3. Consumes

  • /

3.2.148.4. Produces

  • /

3.2.148.5. Tags

  • apiv1

3.2.149. list or watch objects of kind ReplicationController

GET /api/v1/replicationcontrollers

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

false

string

 

3.2.149.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.6, “v1.ReplicationControllerList”

3.2.149.3. Consumes

  • /

3.2.149.4. Produces

  • application/json

3.2.149.5. Tags

  • apiv1

3.2.150. create a ReplicationController

POST /api/v1/replicationcontrollers

3.2.150.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.59, “v1.ReplicationController”

 

3.2.150.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.59, “v1.ReplicationController”

3.2.150.3. Consumes

  • /

3.2.150.4. Produces

  • application/json

3.2.150.5. Tags

  • apiv1

3.2.151. list or watch objects of kind ResourceQuota

GET /api/v1/resourcequotas

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

false

string

 

3.2.151.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.74, “v1.ResourceQuotaList”

3.2.151.3. Consumes

  • /

3.2.151.4. Produces

  • application/json

3.2.151.5. Tags

  • apiv1

3.2.152. create a ResourceQuota

POST /api/v1/resourcequotas

3.2.152.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.106, “v1.ResourceQuota”

 

3.2.152.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.106, “v1.ResourceQuota”

3.2.152.3. Consumes

  • /

3.2.152.4. Produces

  • application/json

3.2.152.5. Tags

  • apiv1

3.2.153. list or watch objects of kind Secret

GET /api/v1/secrets

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

false

string

 

3.2.153.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.16, “v1.SecretList”

3.2.153.3. Consumes

  • /

3.2.153.4. Produces

  • application/json

3.2.153.5. Tags

  • apiv1

3.2.154. create a Secret

POST /api/v1/secrets

3.2.154.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.87, “v1.Secret”

 

3.2.154.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.87, “v1.Secret”

3.2.154.3. Consumes

  • /

3.2.154.4. Produces

  • application/json

3.2.154.5. Tags

  • apiv1

3.2.155. list or watch objects of kind SecurityContextConstraints

GET /api/v1/securitycontextconstraints

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

false

string

 

3.2.155.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.25, “v1.SecurityContextConstraintsList”

3.2.155.3. Consumes

  • /

3.2.155.4. Produces

  • application/json

3.2.155.5. Tags

  • apiv1

3.2.156. create a SecurityContextConstraints

POST /api/v1/securitycontextconstraints

3.2.156.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.61, “v1.SecurityContextConstraints”

 

3.2.156.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.61, “v1.SecurityContextConstraints”

3.2.156.3. Consumes

  • /

3.2.156.4. Produces

  • application/json

3.2.156.5. Tags

  • apiv1

3.2.157. read the specified SecurityContextConstraints

GET /api/v1/securitycontextconstraints/{name}

3.2.157.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

PathParameter

name

name of the SecurityContextConstraints

true

string

 

3.2.157.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.61, “v1.SecurityContextConstraints”

3.2.157.3. Consumes

  • /

3.2.157.4. Produces

  • application/json

3.2.157.5. Tags

  • apiv1

3.2.158. replace the specified SecurityContextConstraints

PUT /api/v1/securitycontextconstraints/{name}

3.2.158.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.61, “v1.SecurityContextConstraints”

 

PathParameter

name

name of the SecurityContextConstraints

true

string

 

3.2.158.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.61, “v1.SecurityContextConstraints”

3.2.158.3. Consumes

  • /

3.2.158.4. Produces

  • application/json

3.2.158.5. Tags

  • apiv1

3.2.159. delete a SecurityContextConstraints

DELETE /api/v1/securitycontextconstraints/{name}

3.2.159.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.23, “v1.DeleteOptions”

 

PathParameter

name

name of the SecurityContextConstraints

true

string

 

3.2.159.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.Status”

3.2.159.3. Consumes

  • /

3.2.159.4. Produces

  • application/json

3.2.159.5. Tags

  • apiv1

3.2.160. partially update the specified SecurityContextConstraints

PATCH /api/v1/securitycontextconstraints/{name}

3.2.160.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “api.Patch”

 

PathParameter

name

name of the SecurityContextConstraints

true

string

 

3.2.160.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.61, “v1.SecurityContextConstraints”

3.2.160.3. Consumes

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

3.2.160.4. Produces

  • application/json

3.2.160.5. Tags

  • apiv1

3.2.161. list or watch objects of kind ServiceAccount

GET /api/v1/serviceaccounts

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

false

string

 

3.2.161.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.75, “v1.ServiceAccountList”

3.2.161.3. Consumes

  • /

3.2.161.4. Produces

  • application/json

3.2.161.5. Tags

  • apiv1

3.2.162. create a ServiceAccount

POST /api/v1/serviceaccounts

3.2.162.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.67, “v1.ServiceAccount”

 

3.2.162.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.67, “v1.ServiceAccount”

3.2.162.3. Consumes

  • /

3.2.162.4. Produces

  • application/json

3.2.162.5. Tags

  • apiv1

3.2.163. list or watch objects of kind Service

GET /api/v1/services

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

false

string

 

3.2.163.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.34, “v1.ServiceList”

3.2.163.3. Consumes

  • /

3.2.163.4. Produces

  • application/json

3.2.163.5. Tags

  • apiv1

3.2.164. create a Service

POST /api/v1/services

3.2.164.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 3.3.93, “v1.Service”

 

3.2.164.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 3.3.93, “v1.Service”

3.2.164.3. Consumes

  • /

3.2.164.4. Produces

  • application/json

3.2.164.5. Tags

  • apiv1

3.2.165. watch individual changes to a list of Endpoints

GET /api/v1/watch/endpoints

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

false

string

 

3.2.165.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.165.3. Consumes

  • /

3.2.165.4. Produces

  • application/json

3.2.165.5. Tags

  • apiv1

3.2.166. watch individual changes to a list of Event

GET /api/v1/watch/events

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

false

string

 

3.2.166.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.166.3. Consumes

  • /

3.2.166.4. Produces

  • application/json

3.2.166.5. Tags

  • apiv1

3.2.167. watch individual changes to a list of LimitRange

GET /api/v1/watch/limitranges

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

false

string

 

3.2.167.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.167.3. Consumes

  • /

3.2.167.4. Produces

  • application/json

3.2.167.5. Tags

  • apiv1

3.2.168. watch individual changes to a list of Namespace

GET /api/v1/watch/namespaces

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

false

string

 

3.2.168.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.168.3. Consumes

  • /

3.2.168.4. Produces

  • application/json

3.2.168.5. Tags

  • apiv1

3.2.169. watch individual changes to a list of Endpoints

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

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

false

string

 

PathParameter

namespace

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

true

string

 

3.2.169.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.169.3. Consumes

  • /

3.2.169.4. Produces

  • application/json

3.2.169.5. Tags

  • apiv1

3.2.170. watch changes to an object of kind Endpoints

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

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

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.170.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.170.3. Consumes

  • /

3.2.170.4. Produces

  • application/json

3.2.170.5. Tags

  • apiv1

3.2.171. watch individual changes to a list of Event

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

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

false

string

 

PathParameter

namespace

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

true

string

 

3.2.171.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.171.3. Consumes

  • /

3.2.171.4. Produces

  • application/json

3.2.171.5. Tags

  • apiv1

3.2.172. watch changes to an object of kind Event

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

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

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.172.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.172.3. Consumes

  • /

3.2.172.4. Produces

  • application/json

3.2.172.5. Tags

  • apiv1

3.2.173. watch individual changes to a list of LimitRange

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

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

false

string

 

PathParameter

namespace

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

true

string

 

3.2.173.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.173.3. Consumes

  • /

3.2.173.4. Produces

  • application/json

3.2.173.5. Tags

  • apiv1

3.2.174. watch changes to an object of kind LimitRange

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

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

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.174.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.174.3. Consumes

  • /

3.2.174.4. Produces

  • application/json

3.2.174.5. Tags

  • apiv1

3.2.175. watch individual changes to a list of PersistentVolumeClaim

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

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

false

string

 

PathParameter

namespace

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

true

string

 

3.2.175.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.175.3. Consumes

  • /

3.2.175.4. Produces

  • application/json

3.2.175.5. Tags

  • apiv1

3.2.176. watch changes to an object of kind PersistentVolumeClaim

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

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

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.176.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.176.3. Consumes

  • /

3.2.176.4. Produces

  • application/json

3.2.176.5. Tags

  • apiv1

3.2.177. watch individual changes to a list of Pod

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

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

false

string

 

PathParameter

namespace

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

true

string

 

3.2.177.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.177.3. Consumes

  • /

3.2.177.4. Produces

  • application/json

3.2.177.5. Tags

  • apiv1

3.2.178. watch changes to an object of kind Pod

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

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

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.178.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.178.3. Consumes

  • /

3.2.178.4. Produces

  • application/json

3.2.178.5. Tags

  • apiv1

3.2.179. watch individual changes to a list of PodTemplate

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

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

false

string

 

PathParameter

namespace

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

true

string

 

3.2.179.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.179.3. Consumes

  • /

3.2.179.4. Produces

  • application/json

3.2.179.5. Tags

  • apiv1

3.2.180. watch changes to an object of kind PodTemplate

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

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

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.180.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.180.3. Consumes

  • /

3.2.180.4. Produces

  • application/json

3.2.180.5. Tags

  • apiv1

3.2.181. watch individual changes to a list of ReplicationController

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

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

false

string

 

PathParameter

namespace

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

true

string

 

3.2.181.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.181.3. Consumes

  • /

3.2.181.4. Produces

  • application/json

3.2.181.5. Tags

  • apiv1

3.2.182. watch changes to an object of kind ReplicationController

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

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

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.182.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.182.3. Consumes

  • /

3.2.182.4. Produces

  • application/json

3.2.182.5. Tags

  • apiv1

3.2.183. watch individual changes to a list of ResourceQuota

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

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

false

string

 

PathParameter

namespace

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

true

string

 

3.2.183.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.183.3. Consumes

  • /

3.2.183.4. Produces

  • application/json

3.2.183.5. Tags

  • apiv1

3.2.184. watch changes to an object of kind ResourceQuota

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

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

false

string

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the ResourceQuota

true

string

 

3.2.184.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.184.3. Consumes

  • /

3.2.184.4. Produces

  • application/json

3.2.184.5. Tags

  • apiv1

3.2.185. watch individual changes to a list of Secret

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

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

false

string

 

PathParameter

namespace

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

true

string

 

3.2.185.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.185.3. Consumes

  • /

3.2.185.4. Produces

  • application/json

3.2.185.5. Tags

  • apiv1

3.2.186. watch changes to an object of kind Secret

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

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

false

string

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Secret

true

string

 

3.2.186.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.186.3. Consumes

  • /

3.2.186.4. Produces

  • application/json

3.2.186.5. Tags

  • apiv1

3.2.187. watch individual changes to a list of ServiceAccount

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

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

false

string

 

PathParameter

namespace

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

true

string

 

3.2.187.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.187.3. Consumes

  • /

3.2.187.4. Produces

  • application/json

3.2.187.5. Tags

  • apiv1

3.2.188. watch changes to an object of kind ServiceAccount

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

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

false

string

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the ServiceAccount

true

string

 

3.2.188.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.188.3. Consumes

  • /

3.2.188.4. Produces

  • application/json

3.2.188.5. Tags

  • apiv1

3.2.189. watch individual changes to a list of Service

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

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

false

string

 

PathParameter

namespace

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

true

string

 

3.2.189.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.189.3. Consumes

  • /

3.2.189.4. Produces

  • application/json

3.2.189.5. Tags

  • apiv1

3.2.190. watch changes to an object of kind Service

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

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

false

string

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Service

true

string

 

3.2.190.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.190.3. Consumes

  • /

3.2.190.4. Produces

  • application/json

3.2.190.5. Tags

  • apiv1

3.2.191. watch changes to an object of kind Namespace

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

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

false

string

 

PathParameter

name

name of the Namespace

true

string

 

3.2.191.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.191.3. Consumes

  • /

3.2.191.4. Produces

  • application/json

3.2.191.5. Tags

  • apiv1

3.2.192. watch individual changes to a list of Node

GET /api/v1/watch/nodes

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

false

string

 

3.2.192.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.192.3. Consumes

  • /

3.2.192.4. Produces

  • application/json

3.2.192.5. Tags

  • apiv1

3.2.193. watch changes to an object of kind Node

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

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

false

string

 

PathParameter

name

name of the Node

true

string

 

3.2.193.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.193.3. Consumes

  • /

3.2.193.4. Produces

  • application/json

3.2.193.5. Tags

  • apiv1

3.2.194. watch individual changes to a list of PersistentVolumeClaim

GET /api/v1/watch/persistentvolumeclaims

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

false

string

 

3.2.194.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.194.3. Consumes

  • /

3.2.194.4. Produces

  • application/json

3.2.194.5. Tags

  • apiv1

3.2.195. watch individual changes to a list of PersistentVolume

GET /api/v1/watch/persistentvolumes

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

false

string

 

3.2.195.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.195.3. Consumes

  • /

3.2.195.4. Produces

  • application/json

3.2.195.5. Tags

  • apiv1

3.2.196. watch changes to an object of kind PersistentVolume

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

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

false

string

 

PathParameter

name

name of the PersistentVolume

true

string

 

3.2.196.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.196.3. Consumes

  • /

3.2.196.4. Produces

  • application/json

3.2.196.5. Tags

  • apiv1

3.2.197. watch individual changes to a list of Pod

GET /api/v1/watch/pods

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

false

string

 

3.2.197.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.197.3. Consumes

  • /

3.2.197.4. Produces

  • application/json

3.2.197.5. Tags

  • apiv1

3.2.198. watch individual changes to a list of PodTemplate

GET /api/v1/watch/podtemplates

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

false

string

 

3.2.198.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.198.3. Consumes

  • /

3.2.198.4. Produces

  • application/json

3.2.198.5. Tags

  • apiv1

3.2.199. watch individual changes to a list of ReplicationController

GET /api/v1/watch/replicationcontrollers

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

false

string

 

3.2.199.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.199.3. Consumes

  • /

3.2.199.4. Produces

  • application/json

3.2.199.5. Tags

  • apiv1

3.2.200. watch individual changes to a list of ResourceQuota

GET /api/v1/watch/resourcequotas

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

false

string

 

3.2.200.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.200.3. Consumes

  • /

3.2.200.4. Produces

  • application/json

3.2.200.5. Tags

  • apiv1

3.2.201. watch individual changes to a list of Secret

GET /api/v1/watch/secrets

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

false

string

 

3.2.201.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.201.3. Consumes

  • /

3.2.201.4. Produces

  • application/json

3.2.201.5. Tags

  • apiv1

3.2.202. watch individual changes to a list of SecurityContextConstraints

GET /api/v1/watch/securitycontextconstraints

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

false

string

 

3.2.202.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.202.3. Consumes

  • /

3.2.202.4. Produces

  • application/json

3.2.202.5. Tags

  • apiv1

3.2.203. watch changes to an object of kind SecurityContextConstraints

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

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

false

string

 

PathParameter

name

name of the SecurityContextConstraints

true

string

 

3.2.203.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.203.3. Consumes

  • /

3.2.203.4. Produces

  • application/json

3.2.203.5. Tags

  • apiv1

3.2.204. watch individual changes to a list of ServiceAccount

GET /api/v1/watch/serviceaccounts

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

false

string

 

3.2.204.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.204.3. Consumes

  • /

3.2.204.4. Produces

  • application/json

3.2.204.5. Tags

  • apiv1

3.2.205. watch individual changes to a list of Service

GET /api/v1/watch/services

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

false

string

 

3.2.205.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.136, “json.WatchEvent”

3.2.205.3. Consumes

  • /

3.2.205.4. Produces

  • application/json

3.2.205.5. Tags

  • apiv1

3.3. Definitions

3.3.1. v1.PersistentVolume

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

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

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.106, “v1.ObjectMeta”

 

spec

specification of a persistent volume as provisioned by an administrator; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistent-volumes

false

Section 3.3.30, “v1.PersistentVolumeSpec”

 

status

current status of a persistent volume; populated by the system, read-only; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistent-volumes

false

Section 3.3.45, “v1.PersistentVolumeStatus”

 

3.3.2. v1.MetadataVolumeSource

NameDescriptionRequiredSchemaDefault

items

list of metadata files

false

Section 2.3.60, “v1.MetadataFile” array

 

3.3.3. v1.TCPSocketAction

NameDescriptionRequiredSchemaDefault

port

number or name of the port to access on the container; number must be in the range 1 to 65535; name must be an IANA_SVC_NAME

true

string

 

3.3.4. v1.ResourceQuotaStatus

NameDescriptionRequiredSchemaDefault

hard

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

false

Section 2.3.161, “any”

 

used

used is the current observed total usage of the resource in the namespace

false

Section 2.3.161, “any”

 

3.3.5. v1.ContainerStateTerminated

NameDescriptionRequiredSchemaDefault

exitCode

exit status from the last termination of the container

true

integer (int32)

 

signal

signal from the last termination of the container

false

integer (int32)

 

reason

(brief) reason from the last termination of the container

false

string

 

message

message regarding the last termination of the container

false

string

 

startedAt

time at which previous execution of the container started

false

string (date-time)

 

finishedAt

time at which the container last terminated

false

string (date-time)

 

containerID

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

false

string

 

3.3.6. v1.ReplicationControllerList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.24, “v1.ListMeta”

 

items

list of replication controllers; see http://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md

true

Section 3.3.59, “v1.ReplicationController” array

 

3.3.7. v1.Capability

3.3.8. v1.Pod

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

See the Kubernetes pod documentation for more information.

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.106, “v1.ObjectMeta”

 

spec

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

false

Section 2.3.61, “v1.PodSpec”

 

status

most recently observed status of the pod; populated by the system, read-only; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

Section 3.3.91, “v1.PodStatus”

 

3.3.9. v1.Event

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

true

Section 2.3.106, “v1.ObjectMeta”

 

involvedObject

object this event is about

true

Section 2.3.122, “v1.ObjectReference”

 

reason

short, machine understandable string that gives the reason for the transition into the object’s current status

false

string

 

message

human-readable description of the status of this operation

false

string

 

source

component reporting this event

false

Section 3.3.55, “v1.EventSource”

 

firstTimestamp

the time at which the event was first recorded

false

string (date-time)

 

lastTimestamp

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

false

string (date-time)

 

count

the number of times this event has occurred

false

integer (int32)

 

3.3.10. v1.HostPathVolumeSource

NameDescriptionRequiredSchemaDefault

path

path of the directory on the host; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#hostpath

true

string

 

3.3.11. v1.Volume

NameDescriptionRequiredSchemaDefault

name

volume name; must be a DNS_LABEL and unique within the pod; see http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names

true

string

 

hostPath

pre-existing host file or directory; generally for privileged system daemons or other agents tied to the host; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#hostpath

false

Section 2.3.15, “v1.HostPathVolumeSource”

 

emptyDir

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

false

Section 2.3.96, “v1.EmptyDirVolumeSource”

 

gcePersistentDisk

GCE disk resource attached to the host machine on demand; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk

false

Section 2.3.74, “v1.GCEPersistentDiskVolumeSource”

 

awsElasticBlockStore

AWS disk resource attached to the host machine on demand; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore

false

Section 2.3.137, “v1.AWSElasticBlockStoreVolumeSource”

 

gitRepo

git repository at a particular revision

false

Section 2.3.105, “v1.GitRepoVolumeSource”

 

secret

secret to populate volume; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#secrets

false

Section 2.3.35, “v1.SecretVolumeSource”

 

nfs

NFS volume that will be mounted in the host machine; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs

false

Section 2.3.28, “v1.NFSVolumeSource”

 

iscsi

iSCSI disk attached to host machine on demand; see http://releases.k8s.io/HEAD/examples/iscsi/README.md

false

Section 2.3.104, “v1.ISCSIVolumeSource”

 

glusterfs

Glusterfs volume that will be mounted on the host machine; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md

false

Section 2.3.158, “v1.GlusterfsVolumeSource”

 

persistentVolumeClaim

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

false

Section 2.3.47, “v1.PersistentVolumeClaimVolumeSource”

 

rbd

rados block volume that will be mounted on the host machine; see http://releases.k8s.io/HEAD/examples/rbd/README.md

false

Section 2.3.63, “v1.RBDVolumeSource”

 

cephfs

Ceph filesystem that will be mounted on the host machine

false

Section 2.3.29, “v1.CephFSVolumeSource”

 

metadata

Metadata volume containing information about the pod

false

Section 2.3.1, “v1.MetadataVolumeSource”

 

3.3.12. v1.ContainerStateRunning

NameDescriptionRequiredSchemaDefault

startedAt

time at which the container was last (re-)started

false

string (date-time)

 

3.3.13. v1.DeleteOptions

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

gracePeriodSeconds

the duration in seconds to wait before deleting this object; defaults to a per object value if not specified; zero means delete immediately

true

integer (int64)

 

3.3.14. v1.ListMeta

NameDescriptionRequiredSchemaDefault

selfLink

URL for the object; populated by the system, read-only

false

string

 

resourceVersion

string that identifies the internal version of this object that can be used by clients to determine when objects have changed; populated by the system, read-only; value must be treated as opaque by clients and passed unmodified back to the server: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

 

3.3.15. v1.PodTemplateSpec

NameDescriptionRequiredSchemaDefault

metadata

standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.106, “v1.ObjectMeta”

 

spec

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

false

Section 2.3.61, “v1.PodSpec”

 

3.3.16. v1.SecretList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.24, “v1.ListMeta”

 

items

items is a list of secret objects; see http://releases.k8s.io/HEAD/docs/user-guide/secrets.md

true

Section 3.3.87, “v1.Secret” array

 

3.3.17. v1.NFSVolumeSource

NameDescriptionRequiredSchemaDefault

server

the hostname or IP address of the NFS server; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs

true

string

 

path

the path that is exported by the NFS server; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs

true

string

 

readOnly

forces the NFS export to be mounted with read-only permissions; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs

false

boolean

false

3.3.18. v1.CephFSVolumeSource

NameDescriptionRequiredSchemaDefault

monitors

a collection of Ceph monitors

true

string array

 

user

rados user name; default is admin; optional

false

string

 

secretFile

path to secret for rados user; default is /etc/ceph/user.secret; optional

false

string

 

secretRef

name of a secret to authenticate the user; if provided overrides keyring; optional

false

Section 2.3.110, “v1.LocalObjectReference”

 

readOnly

Ceph fs to be mounted with read-only permissions

false

boolean

false

3.3.19. v1.Capabilities

NameDescriptionRequiredSchemaDefault

add

added capabilities

false

Section 2.3.8, “v1.Capability” array

 

drop

dropped capabilities

false

Section 2.3.8, “v1.Capability” array

 

3.3.20. v1.ComponentCondition

NameDescriptionRequiredSchemaDefault

type

type of component condition, currently only Healthy

true

string

 

status

current status of this component condition, one of True, False, Unknown

true

string

 

message

health check message received from the component

false

string

 

error

error code from health check attempt (if any)

false

string

 

3.3.21. v1.ServiceStatus

NameDescriptionRequiredSchemaDefault

loadBalancer

status of load-balancer

false

Section 3.3.80, “v1.LoadBalancerStatus”

 

3.3.22. v1.SecretVolumeSource

NameDescriptionRequiredSchemaDefault

secretName

secretName is the name of a secret in the pod’s namespace; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#secrets

true

string

 

3.3.23. v1.ResourceRequirements

NameDescriptionRequiredSchemaDefault

limits

Maximum amount of compute resources allowed; see http://releases.k8s.io/HEAD/docs/design/resources.md#resource-specifications

false

Section 2.3.161, “any”

 

requests

Minimum amount of resources requested; if Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value; see http://releases.k8s.io/HEAD/docs/design/resources.md#resource-specifications

false

Section 2.3.161, “any”

 

3.3.24. v1.PersistentVolumeClaim

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

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.106, “v1.ObjectMeta”

 

spec

the desired characteristics of a volume; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

false

Section 3.3.58, “v1.PersistentVolumeClaimSpec”

 

status

the current status of a persistent volume claim; read-only; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

false

Section 3.3.115, “v1.PersistentVolumeClaimStatus”

 

3.3.25. v1.SecurityContextConstraintsList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.24, “v1.ListMeta”

 

items

 

true

Section 3.3.61, “v1.SecurityContextConstraints” array

 

3.3.26. v1.NamespaceStatus

NameDescriptionRequiredSchemaDefault

phase

phase is the current lifecycle phase of the namespace; see http://releases.k8s.io/HEAD/docs/design/namespaces.md#phases

false

string

 

3.3.27. v1.PersistentVolumeAccessMode

3.3.28. v1.ResourceQuotaSpec

NameDescriptionRequiredSchemaDefault

hard

hard is the set of desired hard limits for each named resource; see http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota

false

Section 2.3.161, “any”

 

3.3.29. v1.RunAsUserStrategyOptions

NameDescriptionRequiredSchemaDefault

type

strategy used to generate RunAsUser

false

string

 

uid

the uid to always run as; required for MustRunAs

false

integer (int64)

 

uidRangeMin

min value for range based allocators

false

integer (int64)

 

uidRangeMax

max value for range based allocators

false

integer (int64)

 

3.3.30. v1.PersistentVolumeSpec

NameDescriptionRequiredSchemaDefault

capacity

a description of the persistent volume’s resources and capacity; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#capacity

false

Section 2.3.161, “any”

 

gcePersistentDisk

GCE disk resource provisioned by an admin; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk

false

Section 2.3.74, “v1.GCEPersistentDiskVolumeSource”

 

awsElasticBlockStore

AWS disk resource provisioned by an admin; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore

false

Section 2.3.137, “v1.AWSElasticBlockStoreVolumeSource”

 

hostPath

a HostPath provisioned by a developer or tester; for development use only; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#hostpath

false

Section 2.3.15, “v1.HostPathVolumeSource”

 

glusterfs

Glusterfs volume resource provisioned by an admin; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md

false

Section 2.3.158, “v1.GlusterfsVolumeSource”

 

nfs

NFS volume resource provisioned by an admin; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs

false

Section 2.3.28, “v1.NFSVolumeSource”

 

rbd

rados block volume that will be mounted on the host machine; see http://releases.k8s.io/HEAD/examples/rbd/README.md

false

Section 2.3.63, “v1.RBDVolumeSource”

 

iscsi

an iSCSI disk resource provisioned by an admin

false

Section 2.3.104, “v1.ISCSIVolumeSource”

 

cephfs

Ceph filesystem that will be mounted on the host machine

false

Section 2.3.29, “v1.CephFSVolumeSource”

 

accessModes

all ways the volume can be mounted; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#access-modes

false

Section 3.3.27, “v1.PersistentVolumeAccessMode” array

 

claimRef

when bound, a reference to the bound claim; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#binding

false

Section 2.3.122, “v1.ObjectReference”

 

persistentVolumeReclaimPolicy

what happens to a volume when released from its claim; Valid options are Retain (default) and Recycle. Recyling must be supported by the volume plugin underlying this persistent volume. See http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#recycling-policy

false

string

 

3.3.31. v1.ExecAction

NameDescriptionRequiredSchemaDefault

command

command line to execute inside the container; working directory for the command is root ('/') in the container’s file system; the command is exec’d, not run inside a shell; exit status of 0 is treated as live/healthy and non-zero is unhealthy

false

string array

 

3.3.32. v1.PersistentVolumeClaimVolumeSource

NameDescriptionRequiredSchemaDefault

claimName

the name of the claim in the same namespace to be mounted as a volume; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

true

string

 

readOnly

mount volume as read-only when true; default false

false

boolean

false

3.3.33. v1.ServiceSpec

NameDescriptionRequiredSchemaDefault

ports

ports exposed by the service; see http://releases.k8s.io/HEAD/docs/user-guide/services.md#virtual-ips-and-service-proxies

true

Section 3.3.49, “v1.ServicePort” array

 

selector

label keys and values that must match in order to receive traffic for this service; if empty, all pods are selected, if not specified, endpoints must be manually specified; see http://releases.k8s.io/HEAD/docs/user-guide/services.md#overview

false

Section 2.3.161, “any”

 

portalIP

deprecated, use clusterIP instead

false

string

 

clusterIP

IP address of the service; usually assigned by the system; if specified, it will be allocated to the service if unused or else creation of the service will fail; cannot be updated; 'None' can be specified for a headless service when proxying is not required; see http://releases.k8s.io/HEAD/docs/user-guide/services.md#virtual-ips-and-service-proxies

false

string

 

type

type of this service; must be ClusterIP, NodePort, or LoadBalancer; defaults to ClusterIP; see http://releases.k8s.io/HEAD/docs/user-guide/services.md#external-services

false

string

 

deprecatedPublicIPs

deprecated. externally visible IPs (e.g. load balancers) that should be proxied to this service

false

string array

 

sessionAffinity

enable client IP based session affinity; must be ClientIP or None; defaults to None; see http://releases.k8s.io/HEAD/docs/user-guide/services.md#virtual-ips-and-service-proxies

false

string

 

3.3.34. v1.ServiceList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.24, “v1.ListMeta”

 

items

list of services

true

Section 3.3.93, “v1.Service” array

 

3.3.35. v1.PersistentVolumeList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

Section 2.3.24, “v1.ListMeta”

 

items

list of persistent volumes; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md

false

Section 3.3.1, “v1.PersistentVolume” array

 

3.3.36. v1.ContainerStatus

NameDescriptionRequiredSchemaDefault

name

name of the container; must be a DNS_LABEL and unique within the pod; cannot be updated

true

string

 

state

details about the container’s current condition

false

Section 3.3.88, “v1.ContainerState”

 

lastState

details about the container’s last termination condition

false

Section 3.3.88, “v1.ContainerState”

 

ready

specifies whether the container has passed its readiness probe

true

boolean

false

restartCount

the number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed

true

integer (int32)

 

image

image of the container; see http://releases.k8s.io/HEAD/docs/user-guide/images.md

true

string

 

imageID

ID of the container’s image

true

string

 

containerID

container’s ID in the format 'docker://<container_id>'; see http://releases.k8s.io/HEAD/docs/user-guide/container-environment.md#container-information

false

string

 

3.3.37. v1.Handler

NameDescriptionRequiredSchemaDefault

exec

exec-based handler

false

Section 2.3.45, “v1.ExecAction”

 

httpGet

HTTP-based handler

false

Section 2.3.99, “v1.HTTPGetAction”

 

tcpSocket

TCP-based handler; TCP hooks not yet supported

false

Section 2.3.2, “v1.TCPSocketAction”

 

3.3.38. v1.NodeAddress

NameDescriptionRequiredSchemaDefault

type

node address type, one of Hostname, ExternalIP or InternalIP

true

string

 

address

the node address

true

string

 

3.3.39. v1.EndpointPort

NameDescriptionRequiredSchemaDefault

name

name of this port

false

string

 

port

port number of the endpoint

true

integer (int32)

 

protocol

protocol for this port; must be UDP or TCP; TCP if unspecified

false

string

 

3.3.40. v1.EndpointSubset

NameDescriptionRequiredSchemaDefault

addresses

IP addresses which offer the related ports

false

Section 3.3.101, “v1.EndpointAddress” array

 

ports

port numbers available on the related IP addresses

false

Section 3.3.39, “v1.EndpointPort” array

 

3.3.41. v1.LimitRangeList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.24, “v1.ListMeta”

 

items

items is a list of LimitRange objects; see http://releases.k8s.io/HEAD/docs/design/admission_control_limit_range.md

true

Section 3.3.113, “v1.LimitRange” array

 

3.3.42. v1.Container

NameDescriptionRequiredSchemaDefault

name

name of the container; must be a DNS_LABEL and unique within the pod; cannot be updated

true

string

 

image

Docker image name; see http://releases.k8s.io/HEAD/docs/user-guide/images.md

false

string

 

command

entrypoint array; not executed within a shell; the Docker image’s entrypoint is used if this is not provided; cannot be updated; variable references $(VAR_NAME) are expanded using the container’s environment variables; if a variable cannot be resolved, the reference in the input string will be unchanged; the $(VAR_NAME) syntax can be escaped with a double , ie: (VAR_NAME) ; escaped references will never be expanded, regardless of whether the variable exists or not; see http://releases.k8s.io/HEAD/docs/user-guide/containers.md#containers-and-commands

false

string array

 

args

command array; the Docker image’s cmd is used if this is not provided; arguments to the entrypoint; cannot be updated; variable references $(VAR_NAME) are expanded using the container’s environment variables; if a variable cannot be resolved, the reference in the input string will be unchanged; the $(VAR_NAME) syntax can be escaped with a double , ie: (VAR_NAME) ; escaped references will never be expanded, regardless of whether the variable exists or not; see http://releases.k8s.io/HEAD/docs/user-guide/containers.md#containers-and-commands

false

string array

 

workingDir

container’s working directory; defaults to image’s default; cannot be updated

false

string

 

ports

list of ports to expose from the container; cannot be updated

false

Section 2.3.116, “v1.ContainerPort” array

 

env

list of environment variables to set in the container; cannot be updated

false

Section 2.3.149, “v1.EnvVar” array

 

resources

Compute Resources required by this container; cannot be updated; see http://releases.k8s.io/HEAD/docs/user-guide/compute-resources.md

false

Section 2.3.37, “v1.ResourceRequirements”

 

volumeMounts

pod volumes to mount into the container’s filesystem; cannot be updated

false

Section 2.3.83, “v1.VolumeMount” array

 

livenessProbe

periodic probe of container liveness; container will be restarted if the probe fails; cannot be updated; see http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes

false

Section 2.3.102, “v1.Probe”

 

readinessProbe

periodic probe of container service readiness; container will be removed from service endpoints if the probe fails; cannot be updated; see http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes

false

Section 2.3.102, “v1.Probe”

 

lifecycle

actions that the management system should take in response to container lifecycle events; cannot be updated

false

Section 2.3.129, “v1.Lifecycle”

 

terminationMessagePath

path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem; message written is intended to be brief final status, such as an assertion failure message; defaults to /dev/termination-log; cannot be updated

false

string

 

imagePullPolicy

image pull policy; one of Always, Never, IfNotPresent; defaults to Always if :latest tag is specified, or IfNotPresent otherwise; cannot be updated; see http://releases.k8s.io/HEAD/docs/user-guide/images.md#updating-images

false

string

 

securityContext

security options the pod should run with; see http://releases.k8s.io/HEAD/docs/design/security_context.md

false

Section 2.3.68, “v1.SecurityContext”

 

stdin

Whether this container should allocate a buffer for stdin in the container runtime; default is false

false

boolean

false

tty

Whether this container should allocate a TTY for itself, also requires 'stdin' to be true; default is false

false

boolean

false

3.3.43. v1.MetadataFile

NameDescriptionRequiredSchemaDefault

name

the name of the file to be created

true

string

 

fieldRef

selects a field of the pod. Supported fields: metadata.annotations, metadata.labels, metadata.name, metadata.namespace

true

Section 2.3.127, “v1.ObjectFieldSelector”

 

3.3.44. v1.PodSpec

NameDescriptionRequiredSchemaDefault

volumes

list of volumes that can be mounted by containers belonging to the pod; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md

false

Section 2.3.18, “v1.Volume” array

 

containers

list of containers belonging to the pod; cannot be updated; containers cannot currently be added or removed; there must be at least one container in a Pod; see http://releases.k8s.io/HEAD/docs/user-guide/containers.md

true

Section 2.3.58, “v1.Container” array

 

restartPolicy

restart policy for all containers within the pod; one of Always, OnFailure, Never; defaults to Always; see http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#restartpolicy

false

string

 

terminationGracePeriodSeconds

optional duration in seconds the pod needs to terminate gracefully; may be decreased in delete request; value must be non-negative integer; the value zero indicates delete immediately; if this value is not set, the default grace period will be used instead; the grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal; set this value longer than the expected cleanup time for your process

false

integer (int64)

 

activeDeadlineSeconds

 

false

integer (int64)

 

dnsPolicy

DNS policy for containers within the pod; one of 'ClusterFirst' or 'Default'

false

string

 

nodeSelector

selector which must match a node’s labels for the pod to be scheduled on that node; see http://releases.k8s.io/HEAD/docs/user-guide/node-selection/README.md

false

Section 2.3.161, “any”

 

host

deprecated, use nodeName instead

false

string

 

serviceAccountName

name of the ServiceAccount to use to run this pod; see http://releases.k8s.io/HEAD/docs/design/service_accounts.md

false

string

 

serviceAccount

deprecated; use serviceAccountName instead

false

string

 

nodeName

node requested for this pod

false

string

 

hostNetwork

host networking requested for this pod

false

boolean

false

imagePullSecrets

list of references to secrets in the same namespace available for pulling the container images; see http://releases.k8s.io/HEAD/docs/user-guide/images.md#specifying-imagepullsecrets-on-a-pod

false

Section 2.3.110, “v1.LocalObjectReference” array

 

3.3.45. v1.PersistentVolumeStatus

NameDescriptionRequiredSchemaDefault

phase

the current phase of a persistent volume; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#phase

false

string

 

message

human-readable message indicating details about why the volume is in this state

false

string

 

reason

(brief) reason the volume is not is not available

false

string

 

3.3.46. v1.RBDVolumeSource

NameDescriptionRequiredSchemaDefault

monitors

a collection of Ceph monitors; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it

true

string array

 

image

rados image name; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it

true

string

 

fsType

file system type to mount, such as ext4, xfs, ntfs; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it

false

string

 

pool

rados pool name; default is rbd; optional; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it

true

string

 

user

rados user name; default is admin; optional; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it

true

string

 

keyring

keyring is the path to key ring for rados user; default is /etc/ceph/keyring; optional; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it

true

string

 

secretRef

name of a secret to authenticate the RBD user; if provided overrides keyring; optional; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it

true

Section 2.3.110, “v1.LocalObjectReference”

 

readOnly

rbd volume to be mounted with read-only permissions; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it

false

boolean

false

3.3.47. v1.LoadBalancerIngress

NameDescriptionRequiredSchemaDefault

ip

IP address of ingress point

false

string

 

hostname

hostname of ingress point

false

string

 

3.3.48. v1.SecurityContext

NameDescriptionRequiredSchemaDefault

capabilities

the Linux capabilites that should be added or removed; see http://releases.k8s.io/HEAD/docs/design/security_context.md#security-context

false

Section 2.3.30, “v1.Capabilities”

 

privileged

run the container in privileged mode; see http://releases.k8s.io/HEAD/docs/design/security_context.md#security-context

false

boolean

false

seLinuxOptions

options that control the SELinux labels applied; see http://releases.k8s.io/HEAD/docs/design/security_context.md#security-context

false

Section 2.3.121, “v1.SELinuxOptions”

 

runAsUser

the user id that runs the first process in the container; see http://releases.k8s.io/HEAD/docs/design/security_context.md#security-context

false

integer (int64)

 

runAsNonRoot

indicates the container must be run as a non-root user either by specifying the runAsUser or in the image specification

false

boolean

false

3.3.49. v1.ServicePort

NameDescriptionRequiredSchemaDefault

name

the name of this port; optional if only one port is defined

false

string

 

protocol

the protocol used by this port; must be UDP or TCP; TCP if unspecified

false

string

 

port

the port number that is exposed

true

integer (int32)

 

targetPort

number or name of the port to access on the pods targeted by the service; defaults to the service port; number must be in the range 1 to 65535; name must be an IANA_SVC_NAME; see http://releases.k8s.io/HEAD/docs/user-guide/services.md#defining-a-service

false

string

 

nodePort

the port on each node on which this service is exposed when type=NodePort or LoadBalancer; usually assigned by the system; if specified, it will be allocated to the service if unused or else creation of the service will fail; see http://releases.k8s.io/HEAD/docs/user-guide/services.md#type—​nodeport

true

integer (int32)

 

3.3.50. v1.StatusCause

NameDescriptionRequiredSchemaDefault

reason

machine-readable description of the cause of the error; if this value is empty there is no information available

false

string

 

message

human-readable description of the cause of the error; this field may be presented as-is to a reader

false

string

 

field

field of the resource that has caused this error, as named by its JSON serialization; may include dot and postfix notation for nested attributes; arrays are zero-indexed; fields may appear more than once in an array of causes due to fields having multiple errors

false

string

 

3.3.51. v1.Namespace

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.106, “v1.ObjectMeta”

 

spec

spec defines the behavior of the Namespace; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

Section 3.3.77, “v1.NamespaceSpec”

 

status

status describes the current status of a Namespace; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

Section 3.3.26, “v1.NamespaceStatus”

 

3.3.52. v1.GCEPersistentDiskVolumeSource

NameDescriptionRequiredSchemaDefault

pdName

unique name of the PD resource in GCE; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk

true

string

 

fsType

file system type to mount, such as ext4, xfs, ntfs; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk

true

string

 

partition

partition on the disk to mount (e.g., '1' for /dev/sda1); if omitted the plain device name (e.g., /dev/sda) will be mounted; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk

false

integer (int32)

 

readOnly

read-only if true, read-write otherwise (false or unspecified); see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk

false

boolean

false

3.3.53. v1.EndpointsList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.24, “v1.ListMeta”

 

items

list of endpoints

true

Section 3.3.89, “v1.Endpoints” array

 

3.3.54. v1.NodeList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.24, “v1.ListMeta”

 

items

list of nodes

true

Section 3.3.104, “v1.Node” array

 

3.3.55. v1.EventSource

NameDescriptionRequiredSchemaDefault

component

component that generated the event

false

string

 

host

name of the host where the event is generated

false

string

 

3.3.56. v1.EnvVarSource

NameDescriptionRequiredSchemaDefault

fieldRef

selects a field of the pod; only name and namespace are supported

true

Section 2.3.127, “v1.ObjectFieldSelector”

 

3.3.57. v1.LimitRangeSpec

NameDescriptionRequiredSchemaDefault

limits

limits is the list of LimitRangeItem objects that are enforced

true

Section 3.3.111, “v1.LimitRangeItem” array

 

3.3.58. v1.PersistentVolumeClaimSpec

NameDescriptionRequiredSchemaDefault

accessModes

the desired access modes the volume should have; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#access-modes-1

false

Section 3.3.27, “v1.PersistentVolumeAccessMode” array

 

resources

the desired resources the volume should have; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#resources

false

Section 2.3.37, “v1.ResourceRequirements”

 

volumeName

the binding reference to the persistent volume backing this claim

false

string

 

3.3.59. v1.ReplicationController

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.106, “v1.ObjectMeta”

 

spec

specification of the desired behavior of the replication controller; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

Section 3.3.108, “v1.ReplicationControllerSpec”

 

status

most recently observed status of the replication controller; populated by the system, read-only; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

Section 3.3.64, “v1.ReplicationControllerStatus”

 

3.3.60. v1.NamespaceList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.24, “v1.ListMeta”

 

items

items is the list of Namespace objects in the list; see http://releases.k8s.io/HEAD/docs/user-guide/namespaces.md

true

Section 3.3.51, “v1.Namespace” array

 

3.3.61. v1.SecurityContextConstraints

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

 

false

Section 2.3.106, “v1.ObjectMeta”

 

allowPrivilegedContainer

allow containers to run as privileged

true

boolean

false

allowedCapabilities

capabilities that are allowed to be added

true

Section 2.3.8, “v1.Capability” array

 

allowHostDirVolumePlugin

allow the use of the host dir volume plugin

true

boolean

false

allowHostNetwork

allow the use of the hostNetwork in the pod spec

true

boolean

false

allowHostPorts

allow the use of the host ports in the containers

true

boolean

false

seLinuxContext

strategy used to generate SELinuxOptions

false

Section 3.3.90, “v1.SELinuxContextStrategyOptions”

 

runAsUser

strategy used to generate RunAsUser

false

Section 3.3.29, “v1.RunAsUserStrategyOptions”

 

users

users allowed to use this SecurityContextConstraints

false

string array

 

groups

groups allowed to use this SecurityContextConstraints

false

string array

 

3.3.62. v1.VolumeMount

NameDescriptionRequiredSchemaDefault

name

name of the volume to mount

true

string

 

readOnly

mounted read-only if true, read-write otherwise (false or unspecified)

false

boolean

false

mountPath

path within the container at which the volume should be mounted

true

string

 

3.3.63. v1.NodeStatus

NameDescriptionRequiredSchemaDefault

capacity

compute resource capacity of the node; see http://releases.k8s.io/HEAD/docs/user-guide/compute-resources.md

false

Section 2.3.161, “any”

 

phase

most recently observed lifecycle phase of the node; see http://releases.k8s.io/HEAD/docs/admin/node.md#node-phase

false

string

 

conditions

list of node conditions observed; see http://releases.k8s.io/HEAD/docs/admin/node.md#node-condition

false

Section 3.3.66, “v1.NodeCondition” array

 

addresses

list of addresses reachable to the node; see http://releases.k8s.io/HEAD/docs/admin/node.md#node-addresses

false

Section 3.3.38, “v1.NodeAddress” array

 

nodeInfo

set of ids/uuids to uniquely identify the node; see http://releases.k8s.io/HEAD/docs/admin/node.md#node-info

false

Section 3.3.99, “v1.NodeSystemInfo”

 

3.3.64. v1.ReplicationControllerStatus

NameDescriptionRequiredSchemaDefault

replicas

most recently observed number of replicas; see http://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md#what-is-a-replication-controller

true

integer (int32)

 

observedGeneration

reflects the generation of the most recently observed replication controller

false

integer (int64)

 

3.3.65. v1.PodCondition

NameDescriptionRequiredSchemaDefault

type

kind of the condition, currently only Ready; see http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#pod-conditions

true

string

 

status

status of the condition, one of True, False, Unknown; see http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#pod-conditions

true

string

 

3.3.66. v1.NodeCondition

NameDescriptionRequiredSchemaDefault

type

type of node condition, currently only Ready

true

string

 

status

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

true

string

 

lastHeartbeatTime

last time we got an update on a given condition

false

string (date-time)

 

lastTransitionTime

last time the condition transit from one status to another

false

string (date-time)

 

reason

(brief) reason for the condition’s last transition

false

string

 

message

human readable message indicating details about last transition

false

string

 

3.3.67. v1.ServiceAccount

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.106, “v1.ObjectMeta”

 

secrets

list of secrets that can be used by pods running as this service account; see http://releases.k8s.io/HEAD/docs/user-guide/secrets.md

false

Section 2.3.122, “v1.ObjectReference” array

 

imagePullSecrets

list of references to secrets in the same namespace available for pulling container images; see http://releases.k8s.io/HEAD/docs/user-guide/secrets.md#manually-specifying-an-imagepullsecret

false

Section 2.3.110, “v1.LocalObjectReference” array

 

3.3.68. v1.PodTemplate

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.106, “v1.ObjectMeta”

 

template

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

false

Section 2.3.25, “v1.PodTemplateSpec”

 

3.3.69. v1.PodList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

Section 2.3.24, “v1.ListMeta”

 

items

list of pods; see http://releases.k8s.io/HEAD/docs/user-guide/pods.md

true

Section 3.3.8, “v1.Pod” array

 

3.3.70. v1.EmptyDirVolumeSource

NameDescriptionRequiredSchemaDefault

medium

type of storage used to back the volume; must be an empty string (default) or Memory; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#emptydir

false

string

 

3.3.71. v1.NodeSpec

NameDescriptionRequiredSchemaDefault

podCIDR

pod IP range assigned to the node

false

string

 

externalID

deprecated. External ID assigned to the node by some machine database (e.g. a cloud provider). Defaults to node name when empty.

false

string

 

providerID

ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID>

false

string

 

unschedulable

disable pod scheduling on the node; see http://releases.k8s.io/HEAD/docs/admin/node.md#manual-node-administration

false

boolean

false

3.3.72. api.Patch

3.3.73. v1.HTTPGetAction

NameDescriptionRequiredSchemaDefault

path

path to access on the HTTP server

false

string

 

port

number or name of the port to access on the container; number must be in the range 1 to 65535; name must be an IANA_SVC_NAME

true

string

 

host

hostname to connect to; defaults to pod IP

false

string

 

scheme

scheme to connect with, must be HTTP or HTTPS, defaults to HTTP

false

string

 

3.3.74. v1.ResourceQuotaList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.24, “v1.ListMeta”

 

items

items is a list of ResourceQuota objects; see http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota

true

Section 3.3.106, “v1.ResourceQuota” array

 

3.3.75. v1.ServiceAccountList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.24, “v1.ListMeta”

 

items

list of ServiceAccounts; see http://releases.k8s.io/HEAD/docs/design/service_accounts.md#service-accounts

true

Section 3.3.67, “v1.ServiceAccount” array

 

3.3.76. v1.Probe

NameDescriptionRequiredSchemaDefault

exec

exec-based handler

false

Section 2.3.45, “v1.ExecAction”

 

httpGet

HTTP-based handler

false

Section 2.3.99, “v1.HTTPGetAction”

 

tcpSocket

TCP-based handler; TCP hooks not yet supported

false

Section 2.3.2, “v1.TCPSocketAction”

 

initialDelaySeconds

number of seconds after the container has started before liveness probes are initiated; see http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes

false

integer (int64)

 

timeoutSeconds

number of seconds after which liveness probes timeout; defaults to 1 second; see http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes

false

integer (int64)

 

3.3.77. v1.NamespaceSpec

NameDescriptionRequiredSchemaDefault

finalizers

an opaque list of values that must be empty to permanently remove object from storage; see http://releases.k8s.io/HEAD/docs/design/namespaces.md#finalizers

false

Section 2.3.155, “v1.FinalizerName” array

 

3.3.78. v1.ISCSIVolumeSource

NameDescriptionRequiredSchemaDefault

targetPortal

iSCSI target portal

true

string

 

iqn

iSCSI Qualified Name

true

string

 

lun

iscsi target lun number

true

integer (int32)

 

fsType

file system type to mount, such as ext4, xfs, ntfs

true

string

 

readOnly

read-only if true, read-write otherwise (false or unspecified)

false

boolean

false

3.3.79. v1.EventList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.24, “v1.ListMeta”

 

items

list of events

true

Section 3.3.9, “v1.Event” array

 

3.3.80. v1.LoadBalancerStatus

NameDescriptionRequiredSchemaDefault

ingress

load-balancer ingress points

false

Section 3.3.47, “v1.LoadBalancerIngress” array

 

3.3.81. v1.PersistentVolumeClaimList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

Section 2.3.24, “v1.ListMeta”

 

items

a list of persistent volume claims; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

false

Section 3.3.24, “v1.PersistentVolumeClaim” array

 

3.3.82. v1.ComponentStatus

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.106, “v1.ObjectMeta”

 

conditions

list of component conditions observed

false

Section 3.3.20, “v1.ComponentCondition” array

 

3.3.83. v1.GitRepoVolumeSource

NameDescriptionRequiredSchemaDefault

repository

repository URL

true

string

 

revision

commit hash for the specified revision

true

string

 

3.3.84. v1.ObjectMeta

NameDescriptionRequiredSchemaDefault

name

string that identifies an object. Must be unique within a namespace; cannot be updated; see http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names

false

string

 

generateName

an optional prefix to use to generate a unique name; has the same validation rules as name; optional, and is applied only name if is not specified; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#idempotency

false

string

 

namespace

namespace of the object; must be a DNS_LABEL; cannot be updated; see http://releases.k8s.io/HEAD/docs/user-guide/namespaces.md

false

string

 

selfLink

URL for the object; populated by the system, read-only

false

string

 

uid

unique UUID across space and time; populated by the system; read-only; see http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#uids

false

string

 

resourceVersion

string that identifies the internal version of this object that can be used by clients to determine when objects have changed; populated by the system, read-only; value must be treated as opaque by clients and passed unmodified back to the server: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

 

generation

a sequence number representing a specific generation of the desired state; populated by the system; read-only

false

integer (int64)

 

creationTimestamp

RFC 3339 date and time at which the object was created; populated by the system, read-only; null for lists; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

string (date-time)

 

deletionTimestamp

RFC 3339 date and time at which the object will be deleted; populated by the system when a graceful deletion is requested, read-only; if not set, graceful deletion of the object has not been requested; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

string (date-time)

 

labels

map of string keys and values that can be used to organize and categorize objects; may match selectors of replication controllers and services; see http://releases.k8s.io/HEAD/docs/user-guide/labels.md

false

Section 2.3.161, “any”

 

annotations

map of string keys and values that can be used by external tooling to store and retrieve arbitrary metadata about objects; see http://releases.k8s.io/HEAD/docs/user-guide/annotations.md

false

Section 2.3.161, “any”

 

3.3.85. v1.LocalObjectReference

NameDescriptionRequiredSchemaDefault

name

name of the referent; see http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names

false

string

 

3.3.86. v1.ContainerPort

NameDescriptionRequiredSchemaDefault

name

name for the port that can be referred to by services; must be an IANA_SVC_NAME and unique within the pod

false

string

 

hostPort

number of port to expose on the host; most containers do not need this

false

integer (int32)

 

containerPort

number of port to expose on the pod’s IP address

true

integer (int32)

 

protocol

protocol for port; must be UDP or TCP; TCP if unspecified

false

string

 

hostIP

host IP to bind the port to

false

string

 

3.3.87. v1.Secret

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.106, “v1.ObjectMeta”

 

data

data contains the secret data. Each key must be a valid DNS_SUBDOMAIN or leading dot followed by valid DNS_SUBDOMAIN. Each value must be a base64 encoded string as described in https://tools.ietf.org/html/rfc4648#section-4

false

Section 2.3.161, “any”

 

type

type facilitates programmatic handling of secret data

false

string

 

3.3.88. v1.ContainerState

NameDescriptionRequiredSchemaDefault

waiting

details about a waiting container

false

Section 3.3.109, “v1.ContainerStateWaiting”

 

running

details about a running container

false

Section 3.3.12, “v1.ContainerStateRunning”

 

terminated

details about a terminated container

false

Section 3.3.5, “v1.ContainerStateTerminated”

 

3.3.89. v1.Endpoints

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.106, “v1.ObjectMeta”

 

subsets

sets of addresses and ports that comprise a service

true

Section 3.3.40, “v1.EndpointSubset” array

 

3.3.90. v1.SELinuxContextStrategyOptions

NameDescriptionRequiredSchemaDefault

type

strategy used to generate the SELinux context

false

string

 

seLinuxOptions

seLinuxOptions required to run as; required for MustRunAs

false

Section 2.3.121, “v1.SELinuxOptions”

 

3.3.91. v1.PodStatus

NameDescriptionRequiredSchemaDefault

phase

current condition of the pod; see http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#pod-phase

false

string

 

conditions

current service state of pod; see http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#pod-conditions

false

Section 3.3.65, “v1.PodCondition” array

 

message

human readable message indicating details about why the pod is in this condition

false

string

 

reason

(brief-CamelCase) reason indicating details about why the pod is in this condition

false

string

 

hostIP

IP address of the host to which the pod is assigned; empty if not yet scheduled

false

string

 

podIP

IP address allocated to the pod; routable at least within the cluster; empty if not yet allocated

false

string

 

startTime

RFC 3339 date and time at which the object was acknowledged by the Kubelet. This is before the Kubelet pulled the container image(s) for the pod.

false

string (date-time)

 

containerStatuses

list of container statuses; see http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-statuses

false

Section 3.3.36, “v1.ContainerStatus” array

 

3.3.92. v1.SELinuxOptions

NameDescriptionRequiredSchemaDefault

user

the user label to apply to the container; see http://releases.k8s.io/HEAD/docs/user-guide/labels.md

false

string

 

role

the role label to apply to the container; see http://releases.k8s.io/HEAD/docs/user-guide/labels.md

false

string

 

type

the type label to apply to the container; see http://releases.k8s.io/HEAD/docs/user-guide/labels.md

false

string

 

level

the level label to apply to the container; see http://releases.k8s.io/HEAD/docs/user-guide/labels.md

false

string

 

3.3.93. v1.Service

A Service is an abstraction which defines a logical set of Pods and a policy by which to access them - sometimes called a micro-service. The set of Pods targeted by a Service is (usually) determined by a Label selector. Services broadly fall into two types - those that load balance a set of Pods and hide which Pod a client talks to (clusterIP set to an IP address), and those where clients want to talk to the individual member pods directly (clusterIP set to 'None', also known as 'headless' services). The cluster IP of a service is exposed as an environment variable in each pod in the same namespace.

Services may be exposed only inside the cluster (type ClusterIP), inside the cluster and on a high port on each node (type NodePort), or exposed to a load balancer via the hosting cloud infrastructure (type LoadBalancer). Services with a ClusterIP may choose to map the ports available on the ClusterIP to different ports on the pods. Each service has a DNS entry of the form <name>.<namespace>.svc.cluster.local that will be valid from other pods in the cluster.

If the selector for pods is not specified, the service endpoints may be managed by the client directly. Update the endpoint resource to program the service - this can be used to inject external network services into a namsepace.

See the Kubernetes service documentation for more information.

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.106, “v1.ObjectMeta”

 

spec

specification of the desired behavior of the service; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

Section 3.3.33, “v1.ServiceSpec”

 

status

most recently observed status of the service; populated by the system, read-only; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

Section 3.3.21, “v1.ServiceStatus”

 

3.3.94. v1.ObjectReference

NameDescriptionRequiredSchemaDefault

kind

kind of the referent; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

namespace

namespace of the referent; see http://releases.k8s.io/HEAD/docs/user-guide/namespaces.md

false

string

 

name

name of the referent; see http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names

false

string

 

uid

uid of the referent; see http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#uids

false

string

 

apiVersion

API version of the referent

false

string

 

resourceVersion

specific resourceVersion to which this reference is made, if any: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

 

fieldPath

if referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]

false

string

 

3.3.95. v1.ObjectFieldSelector

NameDescriptionRequiredSchemaDefault

apiVersion

version of the schema that fieldPath is written in terms of; defaults to v1

false

string

 

fieldPath

path of the field to select in the specified API version

true

string

 

3.3.96. v1.ComponentStatusList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.24, “v1.ListMeta”

 

items

list of component status objects

true

Section 3.3.82, “v1.ComponentStatus” array

 

3.3.97. v1.Lifecycle

NameDescriptionRequiredSchemaDefault

postStart

called immediately after a container is started; if the handler fails, the container is terminated and restarted according to its restart policy; other management of the container blocks until the hook completes; see http://releases.k8s.io/HEAD/docs/user-guide/container-environment.md#hook-details

false

Section 2.3.57, “v1.Handler”

 

preStop

called before a container is terminated; the container is terminated after the handler completes; other management of the container blocks until the hook completes; see http://releases.k8s.io/HEAD/docs/user-guide/container-environment.md#hook-details

false

Section 2.3.57, “v1.Handler”

 

3.3.98. v1.Status

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.24, “v1.ListMeta”

 

status

status of the operation; either Success, or Failure; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

string

 

message

human-readable description of the status of this operation

false

string

 

reason

machine-readable description of why this operation is in the 'Failure' status; if this value is empty there is no information available; a reason clarifies an HTTP status code but does not override it

false

string

 

details

extended data associated with the reason; each reason may define its own extended details; this field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type

false

Section 2.3.143, “v1.StatusDetails”

 

code

suggested HTTP return code for this status; 0 if not set

false

integer (int32)

 

3.3.99. v1.NodeSystemInfo

NameDescriptionRequiredSchemaDefault

machineID

machine-id reported by the node

true

string

 

systemUUID

system-uuid reported by the node

true

string

 

bootID

boot id is the boot-id reported by the node

true

string

 

kernelVersion

Kernel version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64)

true

string

 

osImage

OS image used reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy))

true

string

 

containerRuntimeVersion

Container runtime version reported by the node through runtime remote API (e.g. docker://1.5.0)

true

string

 

kubeletVersion

Kubelet version reported by the node

true

string

 

kubeProxyVersion

Kube-proxy version reported by the node

true

string

 

3.3.100. json.WatchEvent

NameDescriptionRequiredSchemaDefault

type

the type of watch event; may be ADDED, MODIFIED, DELETED, or ERROR

false

string

 

object

the object being watched; will match the type of the resource endpoint or be a Status object if the type is ERROR

false

string

 

3.3.101. v1.EndpointAddress

NameDescriptionRequiredSchemaDefault

ip

IP address of the endpoint

true

string

 

targetRef

reference to object providing the endpoint

false

Section 2.3.122, “v1.ObjectReference”

 

3.3.102. v1.AWSElasticBlockStoreVolumeSource

NameDescriptionRequiredSchemaDefault

volumeID

unique id of the PD resource in AWS; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore

true

string

 

fsType

file system type to mount, such as ext4, xfs, ntfs; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore

true

string

 

partition

partition on the disk to mount (e.g., '1' for /dev/sda1); if omitted the plain device name (e.g., /dev/sda) will be mounted; see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore

false

integer (int32)

 

readOnly

read-only if true, read-write otherwise (false or unspecified); see http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore

false

boolean

false

3.3.103. v1.Binding

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.106, “v1.ObjectMeta”

 

target

an object to bind to

true

Section 2.3.122, “v1.ObjectReference”

 

3.3.104. v1.Node

Nodes represent the machines that run the pods and containers in the cluster. A node resource is typically created and modified by the software running on the node - reporting information about capacity and the current health of the node. The labels of the node can be used by pods to specify a subset of the cluster to be scheduled on. The scheduler will only assign pods to nodes that have the schedulable condition set and also ready.

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.106, “v1.ObjectMeta”

 

spec

specification of a node; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

Section 3.3.71, “v1.NodeSpec”

 

status

most recently observed status of the node; populated by the system, read-only; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

Section 3.3.63, “v1.NodeStatus”

 

3.3.105. v1.StatusDetails

NameDescriptionRequiredSchemaDefault

name

the name attribute of the resource associated with the status StatusReason (when there is a single name which can be described)

false

string

 

kind

the kind attribute of the resource associated with the status StatusReason; on some operations may differ from the requested resource Kind; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

causes

the Causes array includes more details associated with the StatusReason failure; not all StatusReasons may provide detailed causes

false

Section 2.3.70, “v1.StatusCause” array

 

retryAfterSeconds

the number of seconds before the client should attempt to retry this operation

false

integer (int32)

 

3.3.106. v1.ResourceQuota

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.106, “v1.ObjectMeta”

 

spec

spec defines the desired quota; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

Section 3.3.28, “v1.ResourceQuotaSpec”

 

status

status defines the actual enforced quota and current usage; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

Section 3.3.4, “v1.ResourceQuotaStatus”

 

3.3.107. v1.EnvVar

NameDescriptionRequiredSchemaDefault

name

name of the environment variable; must be a C_IDENTIFIER

true

string

 

value

value of the environment variable; defaults to empty string; variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables; if a variable cannot be resolved, the reference in the input string will be unchanged; the $(VAR_NAME) syntax can be escaped with a double , ie: (VAR_NAME) ; escaped references will never be expanded, regardless of whether the variable exists or not

false

string

 

valueFrom

source for the environment variable’s value; cannot be used if value is not empty

false

Section 2.3.77, “v1.EnvVarSource”

 

3.3.108. v1.ReplicationControllerSpec

NameDescriptionRequiredSchemaDefault

replicas

number of replicas desired; defaults to 1; see http://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md#what-is-a-replication-controller

false

integer (int32)

 

selector

label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template; see http://releases.k8s.io/HEAD/docs/user-guide/labels.md#label-selectors

false

Section 2.3.161, “any”

 

template

object that describes the pod that will be created if insufficient replicas are detected; takes precedence over templateRef; see http://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md#pod-template

false

Section 2.3.25, “v1.PodTemplateSpec”

 

3.3.109. v1.ContainerStateWaiting

NameDescriptionRequiredSchemaDefault

reason

(brief) reason the container is not yet running, such as pulling its image

false

string

 

3.3.110. v1.PodTemplateList

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard list metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.24, “v1.ListMeta”

 

items

list of pod templates

true

Section 3.3.68, “v1.PodTemplate” array

 

3.3.111. v1.LimitRangeItem

NameDescriptionRequiredSchemaDefault

type

type of resource that this limit applies to

false

string

 

max

max usage constraints on this kind by resource name

false

Section 2.3.161, “any”

 

min

min usage constraints on this kind by resource name

false

Section 2.3.161, “any”

 

default

default values on this kind by resource name if omitted

false

Section 2.3.161, “any”

 

3.3.112. v1.FinalizerName

3.3.113. v1.LimitRange

NameDescriptionRequiredSchemaDefault

kind

kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

 

metadata

standard object metadata; see http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

Section 2.3.106, “v1.ObjectMeta”

 

spec

spec defines the limits enforced; http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

Section 3.3.57, “v1.LimitRangeSpec”

 

3.3.114. v1.GlusterfsVolumeSource

NameDescriptionRequiredSchemaDefault

endpoints

gluster hosts endpoints name; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod

true

string

 

path

path to gluster volume; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod

true

string

 

readOnly

glusterfs volume to be mounted with read-only permissions; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod

false

boolean

false

3.3.115. v1.PersistentVolumeClaimStatus

NameDescriptionRequiredSchemaDefault

phase

the current phase of the claim

false

string

 

accessModes

the actual access modes the volume has; see http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#access-modes-1

false

Section 3.3.27, “v1.PersistentVolumeAccessMode” array

 

capacity

the actual resources the volume has

false

Section 2.3.161, “any”

 

3.3.116. any

Represents an untyped JSON map - see the description of the field for more info about the structure of this object.

Chapter 4. Revision History: REST API Reference

4.1. Tue Jun 23 2015

OpenShift Enterprise 3.0 release.

Legal Notice

Copyright © 2017 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.