Chapter 2. OpenShift Enterprise v1 REST API


2.1. Overview

The OpenShift Enterprise 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. get available resources

GET /oapi/v1

2.2.1.1. Consumes

  • application/json
  • application/yaml

2.2.1.2. Produces

  • application/json
  • application/yaml

2.2.1.3. 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.14, “v1.BuildConfig”

 

2.2.2.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.14, “v1.BuildConfig”

2.2.2.3. Consumes

  • /

2.2.2.4. Produces

  • application/json
  • application/yaml

2.2.2.5. Tags

  • oapiv1

2.2.3. list or watch objects of kind BuildConfig

GET /oapi/v1/buildconfigs

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.3.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.15, “v1.BuildConfigList”

2.2.3.3. Consumes

  • /

2.2.3.4. Produces

  • application/json
  • application/yaml

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.13, “v1.Build”

 

2.2.4.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.13, “v1.Build”

2.2.4.3. Consumes

  • /

2.2.4.4. Produces

  • application/json
  • application/yaml

2.2.4.5. Tags

  • oapiv1

2.2.5. list or watch objects of kind Build

GET /oapi/v1/builds

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.5.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.18, “v1.BuildList”

2.2.5.3. Consumes

  • /

2.2.5.4. Produces

  • application/json
  • application/yaml

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.32, “v1.ClusterNetwork”

 

2.2.6.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.32, “v1.ClusterNetwork”

2.2.6.3. Consumes

  • /

2.2.6.4. Produces

  • application/json
  • application/yaml

2.2.6.5. Tags

  • oapiv1

2.2.7. delete collection of ClusterNetwork

DELETE /oapi/v1/clusternetworks

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.7.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.7.3. Consumes

  • /

2.2.7.4. Produces

  • application/json
  • application/yaml

2.2.7.5. Tags

  • oapiv1

2.2.8. list or watch objects of kind ClusterNetwork

GET /oapi/v1/clusternetworks

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.8.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.33, “v1.ClusterNetworkList”

2.2.8.3. Consumes

  • /

2.2.8.4. Produces

  • application/json
  • application/yaml

2.2.8.5. Tags

  • oapiv1

2.2.9. replace the specified ClusterNetwork

PUT /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.32, “v1.ClusterNetwork”

 

PathParameter

name

name of the ClusterNetwork

true

string

 

2.2.9.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.32, “v1.ClusterNetwork”

2.2.9.3. Consumes

  • /

2.2.9.4. Produces

  • application/json
  • application/yaml

2.2.9.5. Tags

  • oapiv1

2.2.10. delete a ClusterNetwork

DELETE /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.48, “v1.DeleteOptions”

 

PathParameter

name

name of the ClusterNetwork

true

string

 

2.2.10.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.10.3. Consumes

  • /

2.2.10.4. Produces

  • application/json
  • application/yaml

2.2.10.5. Tags

  • oapiv1

2.2.11. partially update the specified ClusterNetwork

PATCH /oapi/v1/clusternetworks/{name}

2.2.11.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.6, “unversioned.Patch”

 

PathParameter

name

name of the ClusterNetwork

true

string

 

2.2.11.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.32, “v1.ClusterNetwork”

2.2.11.3. Consumes

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

2.2.11.4. Produces

  • application/json
  • application/yaml

2.2.11.5. Tags

  • oapiv1

2.2.12. read the specified ClusterNetwork

GET /oapi/v1/clusternetworks/{name}

2.2.12.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

export

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

false

boolean

 

QueryParameter

exact

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

false

boolean

 

PathParameter

name

name of the ClusterNetwork

true

string

 

2.2.12.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.32, “v1.ClusterNetwork”

2.2.12.3. Consumes

  • /

2.2.12.4. Produces

  • application/json
  • application/yaml

2.2.12.5. Tags

  • oapiv1

2.2.13. create a ClusterPolicy

POST /oapi/v1/clusterpolicies

2.2.13.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.34, “v1.ClusterPolicy”

 

2.2.13.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.34, “v1.ClusterPolicy”

2.2.13.3. Consumes

  • /

2.2.13.4. Produces

  • application/json
  • application/yaml

2.2.13.5. Tags

  • oapiv1

2.2.14. delete collection of ClusterPolicy

DELETE /oapi/v1/clusterpolicies

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.14.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.14.3. Consumes

  • /

2.2.14.4. Produces

  • application/json
  • application/yaml

2.2.14.5. Tags

  • oapiv1

2.2.15. list or watch objects of kind ClusterPolicy

GET /oapi/v1/clusterpolicies

2.2.15.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

labelSelector

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

false

string

 

QueryParameter

fieldSelector

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

false

string

 

QueryParameter

watch

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

false

boolean

 

QueryParameter

resourceVersion

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

false

string

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.15.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.37, “v1.ClusterPolicyList”

2.2.15.3. Consumes

  • /

2.2.15.4. Produces

  • application/json
  • application/yaml

2.2.15.5. Tags

  • oapiv1

2.2.16. replace the specified ClusterPolicy

PUT /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.34, “v1.ClusterPolicy”

 

PathParameter

name

name of the ClusterPolicy

true

string

 

2.2.16.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.34, “v1.ClusterPolicy”

2.2.16.3. Consumes

  • /

2.2.16.4. Produces

  • application/json
  • application/yaml

2.2.16.5. Tags

  • oapiv1

2.2.17. delete a ClusterPolicy

DELETE /oapi/v1/clusterpolicies/{name}

2.2.17.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.48, “v1.DeleteOptions”

 

PathParameter

name

name of the ClusterPolicy

true

string

 

2.2.17.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.17.3. Consumes

  • /

2.2.17.4. Produces

  • application/json
  • application/yaml

2.2.17.5. Tags

  • oapiv1

2.2.18. partially update the specified ClusterPolicy

PATCH /oapi/v1/clusterpolicies/{name}

2.2.18.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.6, “unversioned.Patch”

 

PathParameter

name

name of the ClusterPolicy

true

string

 

2.2.18.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.34, “v1.ClusterPolicy”

2.2.18.3. Consumes

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

2.2.18.4. Produces

  • application/json
  • application/yaml

2.2.18.5. Tags

  • oapiv1

2.2.19. read the specified ClusterPolicy

GET /oapi/v1/clusterpolicies/{name}

2.2.19.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

export

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

false

boolean

 

QueryParameter

exact

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

false

boolean

 

PathParameter

name

name of the ClusterPolicy

true

string

 

2.2.19.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.34, “v1.ClusterPolicy”

2.2.19.3. Consumes

  • /

2.2.19.4. Produces

  • application/json
  • application/yaml

2.2.19.5. Tags

  • oapiv1

2.2.20. create a ClusterPolicyBinding

POST /oapi/v1/clusterpolicybindings

2.2.20.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.35, “v1.ClusterPolicyBinding”

 

2.2.20.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.35, “v1.ClusterPolicyBinding”

2.2.20.3. Consumes

  • /

2.2.20.4. Produces

  • application/json
  • application/yaml

2.2.20.5. Tags

  • oapiv1

2.2.21. delete collection of ClusterPolicyBinding

DELETE /oapi/v1/clusterpolicybindings

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.21.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.21.3. Consumes

  • /

2.2.21.4. Produces

  • application/json
  • application/yaml

2.2.21.5. Tags

  • oapiv1

2.2.22. list or watch objects of kind ClusterPolicyBinding

GET /oapi/v1/clusterpolicybindings

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.22.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.36, “v1.ClusterPolicyBindingList”

2.2.22.3. Consumes

  • /

2.2.22.4. Produces

  • application/json
  • application/yaml

2.2.22.5. Tags

  • oapiv1

2.2.23. replace the specified ClusterPolicyBinding

PUT /oapi/v1/clusterpolicybindings/{name}

2.2.23.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.35, “v1.ClusterPolicyBinding”

 

PathParameter

name

name of the ClusterPolicyBinding

true

string

 

2.2.23.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.35, “v1.ClusterPolicyBinding”

2.2.23.3. Consumes

  • /

2.2.23.4. Produces

  • application/json
  • application/yaml

2.2.23.5. Tags

  • oapiv1

2.2.24. delete a ClusterPolicyBinding

DELETE /oapi/v1/clusterpolicybindings/{name}

2.2.24.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.48, “v1.DeleteOptions”

 

PathParameter

name

name of the ClusterPolicyBinding

true

string

 

2.2.24.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.24.3. Consumes

  • /

2.2.24.4. Produces

  • application/json
  • application/yaml

2.2.24.5. Tags

  • oapiv1

2.2.25. partially update the specified ClusterPolicyBinding

PATCH /oapi/v1/clusterpolicybindings/{name}

2.2.25.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.6, “unversioned.Patch”

 

PathParameter

name

name of the ClusterPolicyBinding

true

string

 

2.2.25.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.35, “v1.ClusterPolicyBinding”

2.2.25.3. Consumes

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

2.2.25.4. Produces

  • application/json
  • application/yaml

2.2.25.5. Tags

  • oapiv1

2.2.26. read the specified ClusterPolicyBinding

GET /oapi/v1/clusterpolicybindings/{name}

2.2.26.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

export

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

false

boolean

 

QueryParameter

exact

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

false

boolean

 

PathParameter

name

name of the ClusterPolicyBinding

true

string

 

2.2.26.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.35, “v1.ClusterPolicyBinding”

2.2.26.3. Consumes

  • /

2.2.26.4. Produces

  • application/json
  • application/yaml

2.2.26.5. Tags

  • oapiv1

2.2.27. create a ClusterRoleBinding

POST /oapi/v1/clusterrolebindings

2.2.27.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.39, “v1.ClusterRoleBinding”

 

2.2.27.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.39, “v1.ClusterRoleBinding”

2.2.27.3. Consumes

  • /

2.2.27.4. Produces

  • application/json
  • application/yaml

2.2.27.5. Tags

  • oapiv1

2.2.28. list objects of kind ClusterRoleBinding

GET /oapi/v1/clusterrolebindings

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.28.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.40, “v1.ClusterRoleBindingList”

2.2.28.3. Consumes

  • /

2.2.28.4. Produces

  • application/json
  • application/yaml

2.2.28.5. Tags

  • oapiv1

2.2.29. replace the specified ClusterRoleBinding

PUT /oapi/v1/clusterrolebindings/{name}

2.2.29.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.39, “v1.ClusterRoleBinding”

 

PathParameter

name

name of the ClusterRoleBinding

true

string

 

2.2.29.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.39, “v1.ClusterRoleBinding”

2.2.29.3. Consumes

  • /

2.2.29.4. Produces

  • application/json
  • application/yaml

2.2.29.5. Tags

  • oapiv1

2.2.30. delete a ClusterRoleBinding

DELETE /oapi/v1/clusterrolebindings/{name}

2.2.30.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.48, “v1.DeleteOptions”

 

PathParameter

name

name of the ClusterRoleBinding

true

string

 

2.2.30.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.30.3. Consumes

  • /

2.2.30.4. Produces

  • application/json
  • application/yaml

2.2.30.5. Tags

  • oapiv1

2.2.31. partially update the specified ClusterRoleBinding

PATCH /oapi/v1/clusterrolebindings/{name}

2.2.31.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.6, “unversioned.Patch”

 

PathParameter

name

name of the ClusterRoleBinding

true

string

 

2.2.31.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.39, “v1.ClusterRoleBinding”

2.2.31.3. Consumes

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

2.2.31.4. Produces

  • application/json
  • application/yaml

2.2.31.5. Tags

  • oapiv1

2.2.32. read the specified ClusterRoleBinding

GET /oapi/v1/clusterrolebindings/{name}

2.2.32.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.32.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.39, “v1.ClusterRoleBinding”

2.2.32.3. Consumes

  • /

2.2.32.4. Produces

  • application/json
  • application/yaml

2.2.32.5. Tags

  • oapiv1

2.2.33. create a ClusterRole

POST /oapi/v1/clusterroles

2.2.33.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.38, “v1.ClusterRole”

 

2.2.33.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.38, “v1.ClusterRole”

2.2.33.3. Consumes

  • /

2.2.33.4. Produces

  • application/json
  • application/yaml

2.2.33.5. Tags

  • oapiv1

2.2.34. list objects of kind ClusterRole

GET /oapi/v1/clusterroles

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.34.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.41, “v1.ClusterRoleList”

2.2.34.3. Consumes

  • /

2.2.34.4. Produces

  • application/json
  • application/yaml

2.2.34.5. Tags

  • oapiv1

2.2.35. replace the specified ClusterRole

PUT /oapi/v1/clusterroles/{name}

2.2.35.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.38, “v1.ClusterRole”

 

PathParameter

name

name of the ClusterRole

true

string

 

2.2.35.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.38, “v1.ClusterRole”

2.2.35.3. Consumes

  • /

2.2.35.4. Produces

  • application/json
  • application/yaml

2.2.35.5. Tags

  • oapiv1

2.2.36. delete a ClusterRole

DELETE /oapi/v1/clusterroles/{name}

2.2.36.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.48, “v1.DeleteOptions”

 

PathParameter

name

name of the ClusterRole

true

string

 

2.2.36.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.36.3. Consumes

  • /

2.2.36.4. Produces

  • application/json
  • application/yaml

2.2.36.5. Tags

  • oapiv1

2.2.37. partially update the specified ClusterRole

PATCH /oapi/v1/clusterroles/{name}

2.2.37.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.6, “unversioned.Patch”

 

PathParameter

name

name of the ClusterRole

true

string

 

2.2.37.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.38, “v1.ClusterRole”

2.2.37.3. Consumes

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

2.2.37.4. Produces

  • application/json
  • application/yaml

2.2.37.5. Tags

  • oapiv1

2.2.38. read the specified ClusterRole

GET /oapi/v1/clusterroles/{name}

2.2.38.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.38.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.38, “v1.ClusterRole”

2.2.38.3. Consumes

  • /

2.2.38.4. Produces

  • application/json
  • application/yaml

2.2.38.5. Tags

  • oapiv1

2.2.39. create a DeploymentConfigRollback

POST /oapi/v1/deploymentconfigrollbacks

2.2.39.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.53, “v1.DeploymentConfigRollback”

 

2.2.39.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.53, “v1.DeploymentConfigRollback”

2.2.39.3. Consumes

  • /

2.2.39.4. Produces

  • application/json
  • application/yaml

2.2.39.5. Tags

  • oapiv1

2.2.40. create a DeploymentConfig

POST /oapi/v1/deploymentconfigs

2.2.40.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.51, “v1.DeploymentConfig”

 

2.2.40.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.51, “v1.DeploymentConfig”

2.2.40.3. Consumes

  • /

2.2.40.4. Produces

  • application/json
  • application/yaml

2.2.40.5. Tags

  • oapiv1

2.2.41. list or watch objects of kind DeploymentConfig

GET /oapi/v1/deploymentconfigs

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.41.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.52, “v1.DeploymentConfigList”

2.2.41.3. Consumes

  • /

2.2.41.4. Produces

  • application/json
  • application/yaml

2.2.41.5. Tags

  • oapiv1

2.2.42. create a Group

POST /oapi/v1/groups

2.2.42.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.79, “v1.Group”

 

2.2.42.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.79, “v1.Group”

2.2.42.3. Consumes

  • /

2.2.42.4. Produces

  • application/json
  • application/yaml

2.2.42.5. Tags

  • oapiv1

2.2.43. delete collection of Group

DELETE /oapi/v1/groups

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.43.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.43.3. Consumes

  • /

2.2.43.4. Produces

  • application/json
  • application/yaml

2.2.43.5. Tags

  • oapiv1

2.2.44. list or watch objects of kind Group

GET /oapi/v1/groups

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.44.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.80, “v1.GroupList”

2.2.44.3. Consumes

  • /

2.2.44.4. Produces

  • application/json
  • application/yaml

2.2.44.5. Tags

  • oapiv1

2.2.45. replace the specified Group

PUT /oapi/v1/groups/{name}

2.2.45.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.79, “v1.Group”

 

PathParameter

name

name of the Group

true

string

 

2.2.45.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.79, “v1.Group”

2.2.45.3. Consumes

  • /

2.2.45.4. Produces

  • application/json
  • application/yaml

2.2.45.5. Tags

  • oapiv1

2.2.46. delete a Group

DELETE /oapi/v1/groups/{name}

2.2.46.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.48, “v1.DeleteOptions”

 

PathParameter

name

name of the Group

true

string

 

2.2.46.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.46.3. Consumes

  • /

2.2.46.4. Produces

  • application/json
  • application/yaml

2.2.46.5. Tags

  • oapiv1

2.2.47. partially update the specified Group

PATCH /oapi/v1/groups/{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.6, “unversioned.Patch”

 

PathParameter

name

name of the Group

true

string

 

2.2.47.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.79, “v1.Group”

2.2.47.3. Consumes

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

2.2.47.4. Produces

  • application/json
  • application/yaml

2.2.47.5. Tags

  • oapiv1

2.2.48. read the specified Group

GET /oapi/v1/groups/{name}

2.2.48.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

export

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

false

boolean

 

QueryParameter

exact

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

false

boolean

 

PathParameter

name

name of the Group

true

string

 

2.2.48.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.79, “v1.Group”

2.2.48.3. Consumes

  • /

2.2.48.4. Produces

  • application/json
  • application/yaml

2.2.48.5. Tags

  • oapiv1

2.2.49. create a HostSubnet

POST /oapi/v1/hostsubnets

2.2.49.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.85, “v1.HostSubnet”

 

2.2.49.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.85, “v1.HostSubnet”

2.2.49.3. Consumes

  • /

2.2.49.4. Produces

  • application/json
  • application/yaml

2.2.49.5. Tags

  • oapiv1

2.2.50. delete collection of HostSubnet

DELETE /oapi/v1/hostsubnets

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.50.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.50.3. Consumes

  • /

2.2.50.4. Produces

  • application/json
  • application/yaml

2.2.50.5. Tags

  • oapiv1

2.2.51. list or watch objects of kind HostSubnet

GET /oapi/v1/hostsubnets

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.51.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.86, “v1.HostSubnetList”

2.2.51.3. Consumes

  • /

2.2.51.4. Produces

  • application/json
  • application/yaml

2.2.51.5. Tags

  • oapiv1

2.2.52. replace the specified HostSubnet

PUT /oapi/v1/hostsubnets/{name}

2.2.52.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.85, “v1.HostSubnet”

 

PathParameter

name

name of the HostSubnet

true

string

 

2.2.52.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.85, “v1.HostSubnet”

2.2.52.3. Consumes

  • /

2.2.52.4. Produces

  • application/json
  • application/yaml

2.2.52.5. Tags

  • oapiv1

2.2.53. delete a HostSubnet

DELETE /oapi/v1/hostsubnets/{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.48, “v1.DeleteOptions”

 

PathParameter

name

name of the HostSubnet

true

string

 

2.2.53.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.53.3. Consumes

  • /

2.2.53.4. Produces

  • application/json
  • application/yaml

2.2.53.5. Tags

  • oapiv1

2.2.54. partially update the specified HostSubnet

PATCH /oapi/v1/hostsubnets/{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.6, “unversioned.Patch”

 

PathParameter

name

name of the HostSubnet

true

string

 

2.2.54.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.85, “v1.HostSubnet”

2.2.54.3. Consumes

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

2.2.54.4. Produces

  • application/json
  • application/yaml

2.2.54.5. Tags

  • oapiv1

2.2.55. read the specified HostSubnet

GET /oapi/v1/hostsubnets/{name}

2.2.55.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

export

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

false

boolean

 

QueryParameter

exact

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

false

boolean

 

PathParameter

name

name of the HostSubnet

true

string

 

2.2.55.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.85, “v1.HostSubnet”

2.2.55.3. Consumes

  • /

2.2.55.4. Produces

  • application/json
  • application/yaml

2.2.55.5. Tags

  • oapiv1

2.2.56. create a Identity

POST /oapi/v1/identities

2.2.56.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.88, “v1.Identity”

 

2.2.56.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.88, “v1.Identity”

2.2.56.3. Consumes

  • /

2.2.56.4. Produces

  • application/json
  • application/yaml

2.2.56.5. Tags

  • oapiv1

2.2.57. delete collection of Identity

DELETE /oapi/v1/identities

2.2.57.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

labelSelector

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

false

string

 

QueryParameter

fieldSelector

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

false

string

 

QueryParameter

watch

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

false

boolean

 

QueryParameter

resourceVersion

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

false

string

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.57.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.57.3. Consumes

  • /

2.2.57.4. Produces

  • application/json
  • application/yaml

2.2.57.5. Tags

  • oapiv1

2.2.58. list or watch objects of kind Identity

GET /oapi/v1/identities

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.58.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.89, “v1.IdentityList”

2.2.58.3. Consumes

  • /

2.2.58.4. Produces

  • application/json
  • application/yaml

2.2.58.5. Tags

  • oapiv1

2.2.59. replace the specified Identity

PUT /oapi/v1/identities/{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.88, “v1.Identity”

 

PathParameter

name

name of the Identity

true

string

 

2.2.59.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.88, “v1.Identity”

2.2.59.3. Consumes

  • /

2.2.59.4. Produces

  • application/json
  • application/yaml

2.2.59.5. Tags

  • oapiv1

2.2.60. delete a Identity

DELETE /oapi/v1/identities/{name}

2.2.60.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.48, “v1.DeleteOptions”

 

PathParameter

name

name of the Identity

true

string

 

2.2.60.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.60.3. Consumes

  • /

2.2.60.4. Produces

  • application/json
  • application/yaml

2.2.60.5. Tags

  • oapiv1

2.2.61. partially update the specified Identity

PATCH /oapi/v1/identities/{name}

2.2.61.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.6, “unversioned.Patch”

 

PathParameter

name

name of the Identity

true

string

 

2.2.61.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.88, “v1.Identity”

2.2.61.3. Consumes

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

2.2.61.4. Produces

  • application/json
  • application/yaml

2.2.61.5. Tags

  • oapiv1

2.2.62. read the specified Identity

GET /oapi/v1/identities/{name}

2.2.62.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

export

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

false

boolean

 

QueryParameter

exact

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

false

boolean

 

PathParameter

name

name of the Identity

true

string

 

2.2.62.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.88, “v1.Identity”

2.2.62.3. Consumes

  • /

2.2.62.4. Produces

  • application/json
  • application/yaml

2.2.62.5. Tags

  • oapiv1

2.2.63. create a Image

POST /oapi/v1/images

2.2.63.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.90, “v1.Image”

 

2.2.63.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.90, “v1.Image”

2.2.63.3. Consumes

  • /

2.2.63.4. Produces

  • application/json
  • application/yaml

2.2.63.5. Tags

  • oapiv1

2.2.64. delete collection of Image

DELETE /oapi/v1/images

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.64.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.64.3. Consumes

  • /

2.2.64.4. Produces

  • application/json
  • application/yaml

2.2.64.5. Tags

  • oapiv1

2.2.65. list or watch objects of kind Image

GET /oapi/v1/images

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.65.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.95, “v1.ImageList”

2.2.65.3. Consumes

  • /

2.2.65.4. Produces

  • application/json
  • application/yaml

2.2.65.5. Tags

  • oapiv1

2.2.66. replace the specified Image

PUT /oapi/v1/images/{name}

2.2.66.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.90, “v1.Image”

 

PathParameter

name

name of the Image

true

string

 

2.2.66.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.90, “v1.Image”

2.2.66.3. Consumes

  • /

2.2.66.4. Produces

  • application/json
  • application/yaml

2.2.66.5. Tags

  • oapiv1

2.2.67. delete a Image

DELETE /oapi/v1/images/{name}

2.2.67.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.48, “v1.DeleteOptions”

 

PathParameter

name

name of the Image

true

string

 

2.2.67.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.67.3. Consumes

  • /

2.2.67.4. Produces

  • application/json
  • application/yaml

2.2.67.5. Tags

  • oapiv1

2.2.68. partially update the specified Image

PATCH /oapi/v1/images/{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.6, “unversioned.Patch”

 

PathParameter

name

name of the Image

true

string

 

2.2.68.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.90, “v1.Image”

2.2.68.3. Consumes

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

2.2.68.4. Produces

  • application/json
  • application/yaml

2.2.68.5. Tags

  • oapiv1

2.2.69. read the specified Image

GET /oapi/v1/images/{name}

2.2.69.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

export

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

false

boolean

 

QueryParameter

exact

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

false

boolean

 

PathParameter

name

name of the Image

true

string

 

2.2.69.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.90, “v1.Image”

2.2.69.3. Consumes

  • /

2.2.69.4. Produces

  • application/json
  • application/yaml

2.2.69.5. Tags

  • oapiv1

2.2.70. create a ImageStreamImport

POST /oapi/v1/imagestreamimports

2.2.70.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.100, “v1.ImageStreamImport”

 

2.2.70.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.100, “v1.ImageStreamImport”

2.2.70.3. Consumes

  • /

2.2.70.4. Produces

  • application/json
  • application/yaml

2.2.70.5. Tags

  • oapiv1

2.2.71. create a ImageStreamMapping

POST /oapi/v1/imagestreammappings

2.2.71.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.104, “v1.ImageStreamMapping”

 

2.2.71.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.104, “v1.ImageStreamMapping”

2.2.71.3. Consumes

  • /

2.2.71.4. Produces

  • application/json
  • application/yaml

2.2.71.5. Tags

  • oapiv1

2.2.72. create a ImageStream

POST /oapi/v1/imagestreams

2.2.72.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “v1.ImageStream”

 

2.2.72.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.98, “v1.ImageStream”

2.2.72.3. Consumes

  • /

2.2.72.4. Produces

  • application/json
  • application/yaml

2.2.72.5. Tags

  • oapiv1

2.2.73. list or watch objects of kind ImageStream

GET /oapi/v1/imagestreams

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.73.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.103, “v1.ImageStreamList”

2.2.73.3. Consumes

  • /

2.2.73.4. Produces

  • application/json
  • application/yaml

2.2.73.5. Tags

  • oapiv1

2.2.74. list objects of kind ImageStreamTag

GET /oapi/v1/imagestreamtags

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.74.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.108, “v1.ImageStreamTagList”

2.2.74.3. Consumes

  • /

2.2.74.4. Produces

  • application/json
  • application/yaml

2.2.74.5. Tags

  • oapiv1

2.2.75. create a LocalResourceAccessReview

POST /oapi/v1/localresourceaccessreviews

2.2.75.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.113, “v1.LocalResourceAccessReview”

 

2.2.75.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.113, “v1.LocalResourceAccessReview”

2.2.75.3. Consumes

  • /

2.2.75.4. Produces

  • application/json
  • application/yaml

2.2.75.5. Tags

  • oapiv1

2.2.76. create a LocalSubjectAccessReview

POST /oapi/v1/localsubjectaccessreviews

2.2.76.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.114, “v1.LocalSubjectAccessReview”

 

2.2.76.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.114, “v1.LocalSubjectAccessReview”

2.2.76.3. Consumes

  • /

2.2.76.4. Produces

  • application/json
  • application/yaml

2.2.76.5. Tags

  • oapiv1

2.2.77. create a BuildConfig

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

2.2.77.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.14, “v1.BuildConfig”

 

PathParameter

namespace

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

true

string

 

2.2.77.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.14, “v1.BuildConfig”

2.2.77.3. Consumes

  • /

2.2.77.4. Produces

  • application/json
  • application/yaml

2.2.77.5. Tags

  • oapiv1

2.2.78. delete collection of BuildConfig

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

2.2.78.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.78.3. Consumes

  • /

2.2.78.4. Produces

  • application/json
  • application/yaml

2.2.78.5. Tags

  • oapiv1

2.2.79. list or watch objects of kind BuildConfig

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

2.2.79.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.15, “v1.BuildConfigList”

2.2.79.3. Consumes

  • /

2.2.79.4. Produces

  • application/json
  • application/yaml

2.2.79.5. Tags

  • oapiv1

2.2.80. replace the specified BuildConfig

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

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.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.80.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.14, “v1.BuildConfig”

2.2.80.3. Consumes

  • /

2.2.80.4. Produces

  • application/json
  • application/yaml

2.2.80.5. Tags

  • oapiv1

2.2.81. delete a BuildConfig

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

2.2.81.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.48, “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.81.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.81.3. Consumes

  • /

2.2.81.4. Produces

  • application/json
  • application/yaml

2.2.81.5. Tags

  • oapiv1

2.2.82. partially update the specified BuildConfig

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

2.2.82.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.6, “unversioned.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.82.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.14, “v1.BuildConfig”

2.2.82.3. Consumes

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

2.2.82.4. Produces

  • application/json
  • application/yaml

2.2.82.5. Tags

  • oapiv1

2.2.83. read the specified BuildConfig

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

2.2.83.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

export

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

false

boolean

 

QueryParameter

exact

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

false

boolean

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the BuildConfig

true

string

 

2.2.83.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.14, “v1.BuildConfig”

2.2.83.3. Consumes

  • /

2.2.83.4. Produces

  • application/json
  • application/yaml

2.2.83.5. Tags

  • oapiv1

2.2.84. create instantiate of a BuildRequest

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

2.2.84.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.22, “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.84.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.22, “v1.BuildRequest”

2.2.84.3. Consumes

  • /

2.2.84.4. Produces

  • application/json
  • application/yaml

2.2.84.5. Tags

  • oapiv1

2.2.85. connect POST requests to instantiatebinary of BinaryBuildRequestOptions

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

2.2.85.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

asFile

AsFile determines if the binary should be created as a file within the source rather than extracted as an archive

false

string

 

QueryParameter

revision.commit

Commit is the value identifying a specific commit

false

string

 

QueryParameter

revision.message

Message is the description of a specific commit

false

string

 

QueryParameter

revision.authorName

AuthorName of the source control user

false

string

 

QueryParameter

revision.authorEmail

AuthorEmail of the source control user

false

string

 

QueryParameter

revision.committerName

CommitterName of the source control user

false

string

 

QueryParameter

revision.committerEmail

CommitterEmail of the source control user

false

string

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the BinaryBuildRequestOptions

true

string

 

2.2.85.2. Responses

HTTP CodeDescriptionSchema

default

success

string

2.2.85.3. Consumes

  • /

2.2.85.4. Produces

  • /

2.2.85.5. Tags

  • oapiv1

2.2.86. connect POST requests to webhooks of Status

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

2.2.86.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

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

false

string

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Status

true

string

 

2.2.86.2. Responses

HTTP CodeDescriptionSchema

default

success

string

2.2.86.3. Consumes

  • /

2.2.86.4. Produces

  • /

2.2.86.5. Tags

  • oapiv1

2.2.87. connect POST requests to webhooks of Status

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

2.2.87.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

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

false

string

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Status

true

string

 

PathParameter

path

path to the resource

true

string

 

2.2.87.2. Responses

HTTP CodeDescriptionSchema

default

success

string

2.2.87.3. Consumes

  • /

2.2.87.4. Produces

  • /

2.2.87.5. Tags

  • oapiv1

2.2.88. create a Build

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

2.2.88.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.13, “v1.Build”

 

PathParameter

namespace

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

true

string

 

2.2.88.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.13, “v1.Build”

2.2.88.3. Consumes

  • /

2.2.88.4. Produces

  • application/json
  • application/yaml

2.2.88.5. Tags

  • oapiv1

2.2.89. delete collection of Build

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

2.2.89.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.89.3. Consumes

  • /

2.2.89.4. Produces

  • application/json
  • application/yaml

2.2.89.5. Tags

  • oapiv1

2.2.90. list or watch objects of kind Build

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

2.2.90.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.18, “v1.BuildList”

2.2.90.3. Consumes

  • /

2.2.90.4. Produces

  • application/json
  • application/yaml

2.2.90.5. Tags

  • oapiv1

2.2.91. replace the specified Build

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

2.2.91.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.13, “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.91.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.13, “v1.Build”

2.2.91.3. Consumes

  • /

2.2.91.4. Produces

  • application/json
  • application/yaml

2.2.91.5. Tags

  • oapiv1

2.2.92. delete a Build

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

2.2.92.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.48, “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.92.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.92.3. Consumes

  • /

2.2.92.4. Produces

  • application/json
  • application/yaml

2.2.92.5. Tags

  • oapiv1

2.2.93. partially update the specified Build

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

2.2.93.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.6, “unversioned.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.93.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.13, “v1.Build”

2.2.93.3. Consumes

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

2.2.93.4. Produces

  • application/json
  • application/yaml

2.2.93.5. Tags

  • oapiv1

2.2.94. read the specified Build

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

2.2.94.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

export

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

false

boolean

 

QueryParameter

exact

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

false

boolean

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Build

true

string

 

2.2.94.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.13, “v1.Build”

2.2.94.3. Consumes

  • /

2.2.94.4. Produces

  • application/json
  • application/yaml

2.2.94.5. Tags

  • oapiv1

2.2.95. create clone of a BuildRequest

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

2.2.95.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.22, “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.95.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.22, “v1.BuildRequest”

2.2.95.3. Consumes

  • /

2.2.95.4. Produces

  • application/json
  • application/yaml

2.2.95.5. Tags

  • oapiv1

2.2.96. replace details of the specified Build

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

2.2.96.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.13, “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.96.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.13, “v1.Build”

2.2.96.3. Consumes

  • /

2.2.96.4. Produces

  • application/json
  • application/yaml

2.2.96.5. Tags

  • oapiv1

2.2.97. read log of the specified BuildLog

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

2.2.97.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 if true indicates that the build log should be streamed until the build terminates.

false

boolean

 

QueryParameter

previous

Return previous build logs. Defaults to false.

false

boolean

 

QueryParameter

sinceSeconds

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

false

integer

 

QueryParameter

sinceTime

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

false

string

 

QueryParameter

timestamps

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

false

boolean

 

QueryParameter

tailLines

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

false

integer

 

QueryParameter

limitBytes

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

false

integer

 

QueryParameter

nowait

NoWait if true causes the call to return immediately even if the build is not available yet. Otherwise the server will wait until the build has started.

false

boolean

 

QueryParameter

version

Version of the build for which to view logs.

false

integer

 

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.97.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.19, “v1.BuildLog”

2.2.97.3. Consumes

  • /

2.2.97.4. Produces

  • application/json
  • application/yaml

2.2.97.5. Tags

  • oapiv1

2.2.98. create a DeploymentConfigRollback

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

2.2.98.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.53, “v1.DeploymentConfigRollback”

 

PathParameter

namespace

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

true

string

 

2.2.98.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.53, “v1.DeploymentConfigRollback”

2.2.98.3. Consumes

  • /

2.2.98.4. Produces

  • application/json
  • application/yaml

2.2.98.5. Tags

  • oapiv1

2.2.99. create a DeploymentConfig

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

2.2.99.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.51, “v1.DeploymentConfig”

 

PathParameter

namespace

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

true

string

 

2.2.99.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.51, “v1.DeploymentConfig”

2.2.99.3. Consumes

  • /

2.2.99.4. Produces

  • application/json
  • application/yaml

2.2.99.5. Tags

  • oapiv1

2.2.100. delete collection of DeploymentConfig

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

2.2.100.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.100.3. Consumes

  • /

2.2.100.4. Produces

  • application/json
  • application/yaml

2.2.100.5. Tags

  • oapiv1

2.2.101. list or watch objects of kind DeploymentConfig

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

2.2.101.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.52, “v1.DeploymentConfigList”

2.2.101.3. Consumes

  • /

2.2.101.4. Produces

  • application/json
  • application/yaml

2.2.101.5. Tags

  • oapiv1

2.2.102. replace the specified DeploymentConfig

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

2.2.102.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.51, “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.102.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.51, “v1.DeploymentConfig”

2.2.102.3. Consumes

  • /

2.2.102.4. Produces

  • application/json
  • application/yaml

2.2.102.5. Tags

  • oapiv1

2.2.103. delete a DeploymentConfig

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

2.2.103.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.48, “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.103.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.103.3. Consumes

  • /

2.2.103.4. Produces

  • application/json
  • application/yaml

2.2.103.5. Tags

  • oapiv1

2.2.104. partially update the specified DeploymentConfig

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

2.2.104.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.6, “unversioned.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.104.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.51, “v1.DeploymentConfig”

2.2.104.3. Consumes

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

2.2.104.4. Produces

  • application/json
  • application/yaml

2.2.104.5. Tags

  • oapiv1

2.2.105. read the specified DeploymentConfig

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

2.2.105.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

export

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

false

boolean

 

QueryParameter

exact

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

false

boolean

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the DeploymentConfig

true

string

 

2.2.105.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.51, “v1.DeploymentConfig”

2.2.105.3. Consumes

  • /

2.2.105.4. Produces

  • application/json
  • application/yaml

2.2.105.5. Tags

  • oapiv1

2.2.106. read log of the specified DeploymentLog

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

2.2.106.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 if true indicates that the build log should be streamed until the build terminates.

false

boolean

 

QueryParameter

previous

Return previous deployment logs. Defaults to false.

false

boolean

 

QueryParameter

sinceSeconds

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

false

integer

 

QueryParameter

sinceTime

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

false

string

 

QueryParameter

timestamps

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

false

boolean

 

QueryParameter

tailLines

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

false

integer

 

QueryParameter

limitBytes

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

false

integer

 

QueryParameter

nowait

NoWait if true causes the call to return immediately even if the deployment is not available yet. Otherwise the server will wait until the deployment has started.

false

boolean

 

QueryParameter

version

Version of the deployment for which to view logs.

false

integer

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the DeploymentLog

true

string

 

2.2.106.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.58, “v1.DeploymentLog”

2.2.106.3. Consumes

  • /

2.2.106.4. Produces

  • application/json
  • application/yaml

2.2.106.5. Tags

  • oapiv1

2.2.107. replace scale of the specified Scale

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

2.2.107.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.197, “v1beta1.Scale”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Scale

true

string

 

2.2.107.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.197, “v1beta1.Scale”

2.2.107.3. Consumes

  • /

2.2.107.4. Produces

  • application/json
  • application/yaml

2.2.107.5. Tags

  • oapiv1

2.2.108. partially update scale of the specified Scale

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

2.2.108.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.6, “unversioned.Patch”

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Scale

true

string

 

2.2.108.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.197, “v1beta1.Scale”

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
  • application/yaml

2.2.108.5. Tags

  • oapiv1

2.2.109. read scale of the specified Scale

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

2.2.109.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Scale

true

string

 

2.2.109.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.197, “v1beta1.Scale”

2.2.109.3. Consumes

  • /

2.2.109.4. Produces

  • application/json
  • application/yaml

2.2.109.5. Tags

  • oapiv1

2.2.110. read the specified DeploymentConfig

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

2.2.110.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.110.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.51, “v1.DeploymentConfig”

2.2.110.3. Consumes

  • /

2.2.110.4. Produces

  • application/json
  • application/yaml

2.2.110.5. Tags

  • oapiv1

2.2.111. read the specified ImageStreamImage

GET /oapi/v1/namespaces/{namespace}/imagestreamimages/{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 ImageStreamImage

true

string

 

2.2.111.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.99, “v1.ImageStreamImage”

2.2.111.3. Consumes

  • /

2.2.111.4. Produces

  • application/json
  • application/yaml

2.2.111.5. Tags

  • oapiv1

2.2.112. create a ImageStreamImport

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

2.2.112.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.100, “v1.ImageStreamImport”

 

PathParameter

namespace

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

true

string

 

2.2.112.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.100, “v1.ImageStreamImport”

2.2.112.3. Consumes

  • /

2.2.112.4. Produces

  • application/json
  • application/yaml

2.2.112.5. Tags

  • oapiv1

2.2.113. create a ImageStreamMapping

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

2.2.113.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.104, “v1.ImageStreamMapping”

 

PathParameter

namespace

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

true

string

 

2.2.113.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.104, “v1.ImageStreamMapping”

2.2.113.3. Consumes

  • /

2.2.113.4. Produces

  • application/json
  • application/yaml

2.2.113.5. Tags

  • oapiv1

2.2.114. create a ImageStream

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

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, “v1.ImageStream”

 

PathParameter

namespace

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

true

string

 

2.2.114.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.98, “v1.ImageStream”

2.2.114.3. Consumes

  • /

2.2.114.4. Produces

  • application/json
  • application/yaml

2.2.114.5. Tags

  • oapiv1

2.2.115. delete collection of ImageStream

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

2.2.115.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.115.3. Consumes

  • /

2.2.115.4. Produces

  • application/json
  • application/yaml

2.2.115.5. Tags

  • oapiv1

2.2.116. list or watch objects of kind ImageStream

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

2.2.116.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.103, “v1.ImageStreamList”

2.2.116.3. Consumes

  • /

2.2.116.4. Produces

  • application/json
  • application/yaml

2.2.116.5. Tags

  • oapiv1

2.2.117. replace the specified ImageStream

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

2.2.117.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.98, “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.117.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.98, “v1.ImageStream”

2.2.117.3. Consumes

  • /

2.2.117.4. Produces

  • application/json
  • application/yaml

2.2.117.5. Tags

  • oapiv1

2.2.118. delete a ImageStream

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

2.2.118.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.48, “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.118.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.118.3. Consumes

  • /

2.2.118.4. Produces

  • application/json
  • application/yaml

2.2.118.5. Tags

  • oapiv1

2.2.119. partially update the specified ImageStream

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

2.2.119.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.6, “unversioned.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.119.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.98, “v1.ImageStream”

2.2.119.3. Consumes

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

2.2.119.4. Produces

  • application/json
  • application/yaml

2.2.119.5. Tags

  • oapiv1

2.2.120. read the specified ImageStream

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

2.2.120.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

export

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

false

boolean

 

QueryParameter

exact

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

false

boolean

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the ImageStream

true

string

 

2.2.120.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.98, “v1.ImageStream”

2.2.120.3. Consumes

  • /

2.2.120.4. Produces

  • application/json
  • application/yaml

2.2.120.5. Tags

  • oapiv1

2.2.121. read secrets of the specified SecretList

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the SecretList

true

string

 

2.2.121.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.174, “v1.SecretList”

2.2.121.3. Consumes

  • /

2.2.121.4. Produces

  • application/json
  • application/yaml

2.2.121.5. Tags

  • oapiv1

2.2.122. replace status of the specified ImageStream

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

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, “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.122.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.98, “v1.ImageStream”

2.2.122.3. Consumes

  • /

2.2.122.4. Produces

  • application/json
  • application/yaml

2.2.122.5. Tags

  • oapiv1

2.2.123. list objects of kind ImageStreamTag

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

2.2.123.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.108, “v1.ImageStreamTagList”

2.2.123.3. Consumes

  • /

2.2.123.4. Produces

  • application/json
  • application/yaml

2.2.123.5. Tags

  • oapiv1

2.2.124. replace the specified ImageStreamTag

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

2.2.124.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.107, “v1.ImageStreamTag”

 

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.124.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.107, “v1.ImageStreamTag”

2.2.124.3. Consumes

  • /

2.2.124.4. Produces

  • application/json
  • application/yaml

2.2.124.5. Tags

  • oapiv1

2.2.125. delete a ImageStreamTag

DELETE /oapi/v1/namespaces/{namespace}/imagestreamtags/{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 ImageStreamTag

true

string

 

2.2.125.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.125.3. Consumes

  • /

2.2.125.4. Produces

  • application/json
  • application/yaml

2.2.125.5. Tags

  • oapiv1

2.2.126. partially update the specified ImageStreamTag

PATCH /oapi/v1/namespaces/{namespace}/imagestreamtags/{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.6, “unversioned.Patch”

 

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.126.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.107, “v1.ImageStreamTag”

2.2.126.3. Consumes

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

2.2.126.4. Produces

  • application/json
  • application/yaml

2.2.126.5. Tags

  • oapiv1

2.2.127. read the specified ImageStreamTag

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

2.2.127.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.127.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.107, “v1.ImageStreamTag”

2.2.127.3. Consumes

  • /

2.2.127.4. Produces

  • application/json
  • application/yaml

2.2.127.5. Tags

  • oapiv1

2.2.128. create a LocalResourceAccessReview

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

2.2.128.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.113, “v1.LocalResourceAccessReview”

 

PathParameter

namespace

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

true

string

 

2.2.128.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.113, “v1.LocalResourceAccessReview”

2.2.128.3. Consumes

  • /

2.2.128.4. Produces

  • application/json
  • application/yaml

2.2.128.5. Tags

  • oapiv1

2.2.129. create a LocalSubjectAccessReview

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

2.2.129.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.114, “v1.LocalSubjectAccessReview”

 

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.114, “v1.LocalSubjectAccessReview”

2.2.129.3. Consumes

  • /

2.2.129.4. Produces

  • application/json
  • application/yaml

2.2.129.5. Tags

  • oapiv1

2.2.130. create a Policy

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

2.2.130.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.141, “v1.Policy”

 

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.141, “v1.Policy”

2.2.130.3. Consumes

  • /

2.2.130.4. Produces

  • application/json
  • application/yaml

2.2.130.5. Tags

  • oapiv1

2.2.131. delete collection of Policy

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

2.2.131.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.131.3. Consumes

  • /

2.2.131.4. Produces

  • application/json
  • application/yaml

2.2.131.5. Tags

  • oapiv1

2.2.132. list or watch objects of kind Policy

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

2.2.132.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.144, “v1.PolicyList”

2.2.132.3. Consumes

  • /

2.2.132.4. Produces

  • application/json
  • application/yaml

2.2.132.5. Tags

  • oapiv1

2.2.133. replace the specified Policy

PUT /oapi/v1/namespaces/{namespace}/policies/{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.141, “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.133.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.141, “v1.Policy”

2.2.133.3. Consumes

  • /

2.2.133.4. Produces

  • application/json
  • application/yaml

2.2.133.5. Tags

  • oapiv1

2.2.134. delete a Policy

DELETE /oapi/v1/namespaces/{namespace}/policies/{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.48, “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.134.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.134.3. Consumes

  • /

2.2.134.4. Produces

  • application/json
  • application/yaml

2.2.134.5. Tags

  • oapiv1

2.2.135. partially update the specified Policy

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

2.2.135.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.6, “unversioned.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.135.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.141, “v1.Policy”

2.2.135.3. Consumes

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

2.2.135.4. Produces

  • application/json
  • application/yaml

2.2.135.5. Tags

  • oapiv1

2.2.136. read the specified Policy

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

2.2.136.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

export

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

false

boolean

 

QueryParameter

exact

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

false

boolean

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Policy

true

string

 

2.2.136.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.141, “v1.Policy”

2.2.136.3. Consumes

  • /

2.2.136.4. Produces

  • application/json
  • application/yaml

2.2.136.5. Tags

  • oapiv1

2.2.137. create a PolicyBinding

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

2.2.137.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.142, “v1.PolicyBinding”

 

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.142, “v1.PolicyBinding”

2.2.137.3. Consumes

  • /

2.2.137.4. Produces

  • application/json
  • application/yaml

2.2.137.5. Tags

  • oapiv1

2.2.138. delete collection of PolicyBinding

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

2.2.138.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.138.3. Consumes

  • /

2.2.138.4. Produces

  • application/json
  • application/yaml

2.2.138.5. Tags

  • oapiv1

2.2.139. list or watch objects of kind PolicyBinding

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

2.2.139.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.143, “v1.PolicyBindingList”

2.2.139.3. Consumes

  • /

2.2.139.4. Produces

  • application/json
  • application/yaml

2.2.139.5. Tags

  • oapiv1

2.2.140. replace the specified PolicyBinding

PUT /oapi/v1/namespaces/{namespace}/policybindings/{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.142, “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.140.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.142, “v1.PolicyBinding”

2.2.140.3. Consumes

  • /

2.2.140.4. Produces

  • application/json
  • application/yaml

2.2.140.5. Tags

  • oapiv1

2.2.141. delete a PolicyBinding

DELETE /oapi/v1/namespaces/{namespace}/policybindings/{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.48, “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.141.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.141.3. Consumes

  • /

2.2.141.4. Produces

  • application/json
  • application/yaml

2.2.141.5. Tags

  • oapiv1

2.2.142. partially update the specified PolicyBinding

PATCH /oapi/v1/namespaces/{namespace}/policybindings/{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.6, “unversioned.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.142.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.142, “v1.PolicyBinding”

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
  • application/yaml

2.2.142.5. Tags

  • oapiv1

2.2.143. read the specified PolicyBinding

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

2.2.143.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

export

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

false

boolean

 

QueryParameter

exact

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

false

boolean

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the PolicyBinding

true

string

 

2.2.143.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.142, “v1.PolicyBinding”

2.2.143.3. Consumes

  • /

2.2.143.4. Produces

  • application/json
  • application/yaml

2.2.143.5. Tags

  • oapiv1

2.2.144. create a Template

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

2.2.144.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.189, “v1.Template”

 

PathParameter

namespace

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

true

string

 

2.2.144.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.189, “v1.Template”

2.2.144.3. Consumes

  • /

2.2.144.4. Produces

  • application/json
  • application/yaml

2.2.144.5. Tags

  • oapiv1

2.2.145. create a ResourceAccessReview

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

2.2.145.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.156, “v1.ResourceAccessReview”

 

PathParameter

namespace

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

true

string

 

2.2.145.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.156, “v1.ResourceAccessReview”

2.2.145.3. Consumes

  • /

2.2.145.4. Produces

  • application/json
  • application/yaml

2.2.145.5. Tags

  • oapiv1

2.2.146. create a RoleBinding

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

2.2.146.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.159, “v1.RoleBinding”

 

PathParameter

namespace

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

true

string

 

2.2.146.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.159, “v1.RoleBinding”

2.2.146.3. Consumes

  • /

2.2.146.4. Produces

  • application/json
  • application/yaml

2.2.146.5. Tags

  • oapiv1

2.2.147. list objects of kind RoleBinding

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

2.2.147.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.160, “v1.RoleBindingList”

2.2.147.3. Consumes

  • /

2.2.147.4. Produces

  • application/json
  • application/yaml

2.2.147.5. Tags

  • oapiv1

2.2.148. replace the specified RoleBinding

PUT /oapi/v1/namespaces/{namespace}/rolebindings/{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.159, “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.148.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.159, “v1.RoleBinding”

2.2.148.3. Consumes

  • /

2.2.148.4. Produces

  • application/json
  • application/yaml

2.2.148.5. Tags

  • oapiv1

2.2.149. delete a RoleBinding

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

2.2.149.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.48, “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.149.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.149.3. Consumes

  • /

2.2.149.4. Produces

  • application/json
  • application/yaml

2.2.149.5. Tags

  • oapiv1

2.2.150. partially update the specified RoleBinding

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

2.2.150.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.6, “unversioned.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.150.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.159, “v1.RoleBinding”

2.2.150.3. Consumes

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

2.2.150.4. Produces

  • application/json
  • application/yaml

2.2.150.5. Tags

  • oapiv1

2.2.151. read the specified RoleBinding

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

2.2.151.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.151.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.159, “v1.RoleBinding”

2.2.151.3. Consumes

  • /

2.2.151.4. Produces

  • application/json
  • application/yaml

2.2.151.5. Tags

  • oapiv1

2.2.152. create a Role

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

2.2.152.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.158, “v1.Role”

 

PathParameter

namespace

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

true

string

 

2.2.152.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.158, “v1.Role”

2.2.152.3. Consumes

  • /

2.2.152.4. Produces

  • application/json
  • application/yaml

2.2.152.5. Tags

  • oapiv1

2.2.153. list objects of kind Role

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

2.2.153.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.161, “v1.RoleList”

2.2.153.3. Consumes

  • /

2.2.153.4. Produces

  • application/json
  • application/yaml

2.2.153.5. Tags

  • oapiv1

2.2.154. replace the specified Role

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

2.2.154.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.158, “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.154.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.158, “v1.Role”

2.2.154.3. Consumes

  • /

2.2.154.4. Produces

  • application/json
  • application/yaml

2.2.154.5. Tags

  • oapiv1

2.2.155. delete a Role

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

2.2.155.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.48, “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.155.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.155.3. Consumes

  • /

2.2.155.4. Produces

  • application/json
  • application/yaml

2.2.155.5. Tags

  • oapiv1

2.2.156. partially update the specified Role

PATCH /oapi/v1/namespaces/{namespace}/roles/{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.6, “unversioned.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.156.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.158, “v1.Role”

2.2.156.3. Consumes

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

2.2.156.4. Produces

  • application/json
  • application/yaml

2.2.156.5. Tags

  • oapiv1

2.2.157. read the specified Role

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

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

HTTP CodeDescriptionSchema

200

success

Section 2.3.158, “v1.Role”

2.2.157.3. Consumes

  • /

2.2.157.4. Produces

  • application/json
  • application/yaml

2.2.157.5. Tags

  • oapiv1

2.2.158. create a Route

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

2.2.158.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.163, “v1.Route”

 

PathParameter

namespace

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

true

string

 

2.2.158.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.163, “v1.Route”

2.2.158.3. Consumes

  • /

2.2.158.4. Produces

  • application/json
  • application/yaml

2.2.158.5. Tags

  • oapiv1

2.2.159. delete collection of Route

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

2.2.159.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.159.3. Consumes

  • /

2.2.159.4. Produces

  • application/json
  • application/yaml

2.2.159.5. Tags

  • oapiv1

2.2.160. list or watch objects of kind Route

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

2.2.160.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.166, “v1.RouteList”

2.2.160.3. Consumes

  • /

2.2.160.4. Produces

  • application/json
  • application/yaml

2.2.160.5. Tags

  • oapiv1

2.2.161. replace the specified Route

PUT /oapi/v1/namespaces/{namespace}/routes/{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.163, “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.161.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.163, “v1.Route”

2.2.161.3. Consumes

  • /

2.2.161.4. Produces

  • application/json
  • application/yaml

2.2.161.5. Tags

  • oapiv1

2.2.162. delete a Route

DELETE /oapi/v1/namespaces/{namespace}/routes/{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.48, “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.162.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.162.3. Consumes

  • /

2.2.162.4. Produces

  • application/json
  • application/yaml

2.2.162.5. Tags

  • oapiv1

2.2.163. partially update the specified Route

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

2.2.163.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.6, “unversioned.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.163.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.163, “v1.Route”

2.2.163.3. Consumes

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

2.2.163.4. Produces

  • application/json
  • application/yaml

2.2.163.5. Tags

  • oapiv1

2.2.164. read the specified Route

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

2.2.164.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

export

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

false

boolean

 

QueryParameter

exact

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

false

boolean

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Route

true

string

 

2.2.164.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.163, “v1.Route”

2.2.164.3. Consumes

  • /

2.2.164.4. Produces

  • application/json
  • application/yaml

2.2.164.5. Tags

  • oapiv1

2.2.165. replace status of the specified Route

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

2.2.165.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.163, “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.165.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.163, “v1.Route”

2.2.165.3. Consumes

  • /

2.2.165.4. Produces

  • application/json
  • application/yaml

2.2.165.5. Tags

  • oapiv1

2.2.166. create a SubjectAccessReview

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

2.2.166.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.181, “v1.SubjectAccessReview”

 

PathParameter

namespace

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

true

string

 

2.2.166.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.181, “v1.SubjectAccessReview”

2.2.166.3. Consumes

  • /

2.2.166.4. Produces

  • application/json
  • application/yaml

2.2.166.5. Tags

  • oapiv1

2.2.167. create a Template

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

2.2.167.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.189, “v1.Template”

 

PathParameter

namespace

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

true

string

 

2.2.167.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.189, “v1.Template”

2.2.167.3. Consumes

  • /

2.2.167.4. Produces

  • application/json
  • application/yaml

2.2.167.5. Tags

  • oapiv1

2.2.168. delete collection of Template

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

2.2.168.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.168.3. Consumes

  • /

2.2.168.4. Produces

  • application/json
  • application/yaml

2.2.168.5. Tags

  • oapiv1

2.2.169. list or watch objects of kind Template

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

2.2.169.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.190, “v1.TemplateList”

2.2.169.3. Consumes

  • /

2.2.169.4. Produces

  • application/json
  • application/yaml

2.2.169.5. Tags

  • oapiv1

2.2.170. replace the specified Template

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

2.2.170.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.189, “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.170.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.189, “v1.Template”

2.2.170.3. Consumes

  • /

2.2.170.4. Produces

  • application/json
  • application/yaml

2.2.170.5. Tags

  • oapiv1

2.2.171. delete a Template

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

2.2.171.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.48, “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.171.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.171.3. Consumes

  • /

2.2.171.4. Produces

  • application/json
  • application/yaml

2.2.171.5. Tags

  • oapiv1

2.2.172. partially update the specified Template

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

2.2.172.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.6, “unversioned.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.172.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.189, “v1.Template”

2.2.172.3. Consumes

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

2.2.172.4. Produces

  • application/json
  • application/yaml

2.2.172.5. Tags

  • oapiv1

2.2.173. read the specified Template

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

2.2.173.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

export

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

false

boolean

 

QueryParameter

exact

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

false

boolean

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Template

true

string

 

2.2.173.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.189, “v1.Template”

2.2.173.3. Consumes

  • /

2.2.173.4. Produces

  • application/json
  • application/yaml

2.2.173.5. Tags

  • oapiv1

2.2.174. create a NetNamespace

POST /oapi/v1/netnamespaces

2.2.174.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.123, “v1.NetNamespace”

 

2.2.174.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.123, “v1.NetNamespace”

2.2.174.3. Consumes

  • /

2.2.174.4. Produces

  • application/json
  • application/yaml

2.2.174.5. Tags

  • oapiv1

2.2.175. delete collection of NetNamespace

DELETE /oapi/v1/netnamespaces

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.175.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.175.3. Consumes

  • /

2.2.175.4. Produces

  • application/json
  • application/yaml

2.2.175.5. Tags

  • oapiv1

2.2.176. list or watch objects of kind NetNamespace

GET /oapi/v1/netnamespaces

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.176.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.124, “v1.NetNamespaceList”

2.2.176.3. Consumes

  • /

2.2.176.4. Produces

  • application/json
  • application/yaml

2.2.176.5. Tags

  • oapiv1

2.2.177. replace the specified NetNamespace

PUT /oapi/v1/netnamespaces/{name}

2.2.177.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.123, “v1.NetNamespace”

 

PathParameter

name

name of the NetNamespace

true

string

 

2.2.177.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.123, “v1.NetNamespace”

2.2.177.3. Consumes

  • /

2.2.177.4. Produces

  • application/json
  • application/yaml

2.2.177.5. Tags

  • oapiv1

2.2.178. delete a NetNamespace

DELETE /oapi/v1/netnamespaces/{name}

2.2.178.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.48, “v1.DeleteOptions”

 

PathParameter

name

name of the NetNamespace

true

string

 

2.2.178.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.178.3. Consumes

  • /

2.2.178.4. Produces

  • application/json
  • application/yaml

2.2.178.5. Tags

  • oapiv1

2.2.179. partially update the specified NetNamespace

PATCH /oapi/v1/netnamespaces/{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.6, “unversioned.Patch”

 

PathParameter

name

name of the NetNamespace

true

string

 

2.2.179.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.123, “v1.NetNamespace”

2.2.179.3. Consumes

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

2.2.179.4. Produces

  • application/json
  • application/yaml

2.2.179.5. Tags

  • oapiv1

2.2.180. read the specified NetNamespace

GET /oapi/v1/netnamespaces/{name}

2.2.180.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

export

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

false

boolean

 

QueryParameter

exact

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

false

boolean

 

PathParameter

name

name of the NetNamespace

true

string

 

2.2.180.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.123, “v1.NetNamespace”

2.2.180.3. Consumes

  • /

2.2.180.4. Produces

  • application/json
  • application/yaml

2.2.180.5. Tags

  • oapiv1

2.2.181. create a OAuthAccessToken

POST /oapi/v1/oauthaccesstokens

2.2.181.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.125, “v1.OAuthAccessToken”

 

2.2.181.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.125, “v1.OAuthAccessToken”

2.2.181.3. Consumes

  • /

2.2.181.4. Produces

  • application/json
  • application/yaml

2.2.181.5. Tags

  • oapiv1

2.2.182. list objects of kind OAuthAccessToken

GET /oapi/v1/oauthaccesstokens

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.182.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.126, “v1.OAuthAccessTokenList”

2.2.182.3. Consumes

  • /

2.2.182.4. Produces

  • application/json
  • application/yaml

2.2.182.5. Tags

  • oapiv1

2.2.183. delete a OAuthAccessToken

DELETE /oapi/v1/oauthaccesstokens/{name}

2.2.183.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.48, “v1.DeleteOptions”

 

PathParameter

name

name of the OAuthAccessToken

true

string

 

2.2.183.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.183.3. Consumes

  • /

2.2.183.4. Produces

  • application/json
  • application/yaml

2.2.183.5. Tags

  • oapiv1

2.2.184. read the specified OAuthAccessToken

GET /oapi/v1/oauthaccesstokens/{name}

2.2.184.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.184.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.125, “v1.OAuthAccessToken”

2.2.184.3. Consumes

  • /

2.2.184.4. Produces

  • application/json
  • application/yaml

2.2.184.5. Tags

  • oapiv1

2.2.185. create a OAuthAuthorizeToken

POST /oapi/v1/oauthauthorizetokens

2.2.185.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.127, “v1.OAuthAuthorizeToken”

 

2.2.185.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.127, “v1.OAuthAuthorizeToken”

2.2.185.3. Consumes

  • /

2.2.185.4. Produces

  • application/json
  • application/yaml

2.2.185.5. Tags

  • oapiv1

2.2.186. list objects of kind OAuthAuthorizeToken

GET /oapi/v1/oauthauthorizetokens

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.186.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.128, “v1.OAuthAuthorizeTokenList”

2.2.186.3. Consumes

  • /

2.2.186.4. Produces

  • application/json
  • application/yaml

2.2.186.5. Tags

  • oapiv1

2.2.187. delete a OAuthAuthorizeToken

DELETE /oapi/v1/oauthauthorizetokens/{name}

2.2.187.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.48, “v1.DeleteOptions”

 

PathParameter

name

name of the OAuthAuthorizeToken

true

string

 

2.2.187.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.187.3. Consumes

  • /

2.2.187.4. Produces

  • application/json
  • application/yaml

2.2.187.5. Tags

  • oapiv1

2.2.188. read the specified OAuthAuthorizeToken

GET /oapi/v1/oauthauthorizetokens/{name}

2.2.188.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.188.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.127, “v1.OAuthAuthorizeToken”

2.2.188.3. Consumes

  • /

2.2.188.4. Produces

  • application/json
  • application/yaml

2.2.188.5. Tags

  • oapiv1

2.2.189. create a OAuthClientAuthorization

POST /oapi/v1/oauthclientauthorizations

2.2.189.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.130, “v1.OAuthClientAuthorization”

 

2.2.189.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.130, “v1.OAuthClientAuthorization”

2.2.189.3. Consumes

  • /

2.2.189.4. Produces

  • application/json
  • application/yaml

2.2.189.5. Tags

  • oapiv1

2.2.190. delete collection of OAuthClientAuthorization

DELETE /oapi/v1/oauthclientauthorizations

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.190.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.190.3. Consumes

  • /

2.2.190.4. Produces

  • application/json
  • application/yaml

2.2.190.5. Tags

  • oapiv1

2.2.191. list or watch objects of kind OAuthClientAuthorization

GET /oapi/v1/oauthclientauthorizations

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.191.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.131, “v1.OAuthClientAuthorizationList”

2.2.191.3. Consumes

  • /

2.2.191.4. Produces

  • application/json
  • application/yaml

2.2.191.5. Tags

  • oapiv1

2.2.192. replace the specified OAuthClientAuthorization

PUT /oapi/v1/oauthclientauthorizations/{name}

2.2.192.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.130, “v1.OAuthClientAuthorization”

 

PathParameter

name

name of the OAuthClientAuthorization

true

string

 

2.2.192.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.130, “v1.OAuthClientAuthorization”

2.2.192.3. Consumes

  • /

2.2.192.4. Produces

  • application/json
  • application/yaml

2.2.192.5. Tags

  • oapiv1

2.2.193. delete a OAuthClientAuthorization

DELETE /oapi/v1/oauthclientauthorizations/{name}

2.2.193.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.48, “v1.DeleteOptions”

 

PathParameter

name

name of the OAuthClientAuthorization

true

string

 

2.2.193.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.193.3. Consumes

  • /

2.2.193.4. Produces

  • application/json
  • application/yaml

2.2.193.5. Tags

  • oapiv1

2.2.194. partially update the specified OAuthClientAuthorization

PATCH /oapi/v1/oauthclientauthorizations/{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.6, “unversioned.Patch”

 

PathParameter

name

name of the OAuthClientAuthorization

true

string

 

2.2.194.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.130, “v1.OAuthClientAuthorization”

2.2.194.3. Consumes

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

2.2.194.4. Produces

  • application/json
  • application/yaml

2.2.194.5. Tags

  • oapiv1

2.2.195. read the specified OAuthClientAuthorization

GET /oapi/v1/oauthclientauthorizations/{name}

2.2.195.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

export

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

false

boolean

 

QueryParameter

exact

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

false

boolean

 

PathParameter

name

name of the OAuthClientAuthorization

true

string

 

2.2.195.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.130, “v1.OAuthClientAuthorization”

2.2.195.3. Consumes

  • /

2.2.195.4. Produces

  • application/json
  • application/yaml

2.2.195.5. Tags

  • oapiv1

2.2.196. create a OAuthClient

POST /oapi/v1/oauthclients

2.2.196.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.129, “v1.OAuthClient”

 

2.2.196.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.129, “v1.OAuthClient”

2.2.196.3. Consumes

  • /

2.2.196.4. Produces

  • application/json
  • application/yaml

2.2.196.5. Tags

  • oapiv1

2.2.197. delete collection of OAuthClient

DELETE /oapi/v1/oauthclients

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.197.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.197.3. Consumes

  • /

2.2.197.4. Produces

  • application/json
  • application/yaml

2.2.197.5. Tags

  • oapiv1

2.2.198. list or watch objects of kind OAuthClient

GET /oapi/v1/oauthclients

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.198.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.132, “v1.OAuthClientList”

2.2.198.3. Consumes

  • /

2.2.198.4. Produces

  • application/json
  • application/yaml

2.2.198.5. Tags

  • oapiv1

2.2.199. replace the specified OAuthClient

PUT /oapi/v1/oauthclients/{name}

2.2.199.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.129, “v1.OAuthClient”

 

PathParameter

name

name of the OAuthClient

true

string

 

2.2.199.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.129, “v1.OAuthClient”

2.2.199.3. Consumes

  • /

2.2.199.4. Produces

  • application/json
  • application/yaml

2.2.199.5. Tags

  • oapiv1

2.2.200. delete a OAuthClient

DELETE /oapi/v1/oauthclients/{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.48, “v1.DeleteOptions”

 

PathParameter

name

name of the OAuthClient

true

string

 

2.2.200.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.200.3. Consumes

  • /

2.2.200.4. Produces

  • application/json
  • application/yaml

2.2.200.5. Tags

  • oapiv1

2.2.201. partially update the specified OAuthClient

PATCH /oapi/v1/oauthclients/{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.6, “unversioned.Patch”

 

PathParameter

name

name of the OAuthClient

true

string

 

2.2.201.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.129, “v1.OAuthClient”

2.2.201.3. Consumes

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

2.2.201.4. Produces

  • application/json
  • application/yaml

2.2.201.5. Tags

  • oapiv1

2.2.202. read the specified OAuthClient

GET /oapi/v1/oauthclients/{name}

2.2.202.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

export

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

false

boolean

 

QueryParameter

exact

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

false

boolean

 

PathParameter

name

name of the OAuthClient

true

string

 

2.2.202.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.129, “v1.OAuthClient”

2.2.202.3. Consumes

  • /

2.2.202.4. Produces

  • application/json
  • application/yaml

2.2.202.5. Tags

  • oapiv1

2.2.203. create a Policy

POST /oapi/v1/policies

2.2.203.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.141, “v1.Policy”

 

2.2.203.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.141, “v1.Policy”

2.2.203.3. Consumes

  • /

2.2.203.4. Produces

  • application/json
  • application/yaml

2.2.203.5. Tags

  • oapiv1

2.2.204. list or watch objects of kind Policy

GET /oapi/v1/policies

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.204.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.144, “v1.PolicyList”

2.2.204.3. Consumes

  • /

2.2.204.4. Produces

  • application/json
  • application/yaml

2.2.204.5. Tags

  • oapiv1

2.2.205. create a PolicyBinding

POST /oapi/v1/policybindings

2.2.205.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.142, “v1.PolicyBinding”

 

2.2.205.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.142, “v1.PolicyBinding”

2.2.205.3. Consumes

  • /

2.2.205.4. Produces

  • application/json
  • application/yaml

2.2.205.5. Tags

  • oapiv1

2.2.206. list or watch objects of kind PolicyBinding

GET /oapi/v1/policybindings

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.206.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.143, “v1.PolicyBindingList”

2.2.206.3. Consumes

  • /

2.2.206.4. Produces

  • application/json
  • application/yaml

2.2.206.5. Tags

  • oapiv1

2.2.207. create a Template

POST /oapi/v1/processedtemplates

2.2.207.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.189, “v1.Template”

 

2.2.207.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.189, “v1.Template”

2.2.207.3. Consumes

  • /

2.2.207.4. Produces

  • application/json
  • application/yaml

2.2.207.5. Tags

  • oapiv1

2.2.208. create a ProjectRequest

POST /oapi/v1/projectrequests

2.2.208.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.149, “v1.ProjectRequest”

 

2.2.208.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.149, “v1.ProjectRequest”

2.2.208.3. Consumes

  • /

2.2.208.4. Produces

  • application/json
  • application/yaml

2.2.208.5. Tags

  • oapiv1

2.2.209. list objects of kind ProjectRequest

GET /oapi/v1/projectrequests

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.209.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.209.3. Consumes

  • /

2.2.209.4. Produces

  • application/json
  • application/yaml

2.2.209.5. Tags

  • oapiv1

2.2.210. create a Project

POST /oapi/v1/projects

2.2.210.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.147, “v1.Project”

 

2.2.210.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.147, “v1.Project”

2.2.210.3. Consumes

  • /

2.2.210.4. Produces

  • application/json
  • application/yaml

2.2.210.5. Tags

  • oapiv1

2.2.211. list objects of kind Project

GET /oapi/v1/projects

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.211.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.148, “v1.ProjectList”

2.2.211.3. Consumes

  • /

2.2.211.4. Produces

  • application/json
  • application/yaml

2.2.211.5. Tags

  • oapiv1

2.2.212. replace the specified Project

PUT /oapi/v1/projects/{name}

2.2.212.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.147, “v1.Project”

 

PathParameter

name

name of the Project

true

string

 

2.2.212.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.147, “v1.Project”

2.2.212.3. Consumes

  • /

2.2.212.4. Produces

  • application/json
  • application/yaml

2.2.212.5. Tags

  • oapiv1

2.2.213. delete a Project

DELETE /oapi/v1/projects/{name}

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

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.213.3. Consumes

  • /

2.2.213.4. Produces

  • application/json
  • application/yaml

2.2.213.5. Tags

  • oapiv1

2.2.214. partially update the specified Project

PATCH /oapi/v1/projects/{name}

2.2.214.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.6, “unversioned.Patch”

 

PathParameter

name

name of the Project

true

string

 

2.2.214.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.147, “v1.Project”

2.2.214.3. Consumes

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

2.2.214.4. Produces

  • application/json
  • application/yaml

2.2.214.5. Tags

  • oapiv1

2.2.215. read the specified Project

GET /oapi/v1/projects/{name}

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

HTTP CodeDescriptionSchema

200

success

Section 2.3.147, “v1.Project”

2.2.215.3. Consumes

  • /

2.2.215.4. Produces

  • application/json
  • application/yaml

2.2.215.5. Tags

  • oapiv1

2.2.216. create a ResourceAccessReview

POST /oapi/v1/resourceaccessreviews

2.2.216.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.156, “v1.ResourceAccessReview”

 

2.2.216.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.156, “v1.ResourceAccessReview”

2.2.216.3. Consumes

  • /

2.2.216.4. Produces

  • application/json
  • application/yaml

2.2.216.5. Tags

  • oapiv1

2.2.217. create a RoleBinding

POST /oapi/v1/rolebindings

2.2.217.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.159, “v1.RoleBinding”

 

2.2.217.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.159, “v1.RoleBinding”

2.2.217.3. Consumes

  • /

2.2.217.4. Produces

  • application/json
  • application/yaml

2.2.217.5. Tags

  • oapiv1

2.2.218. list objects of kind RoleBinding

GET /oapi/v1/rolebindings

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.218.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.160, “v1.RoleBindingList”

2.2.218.3. Consumes

  • /

2.2.218.4. Produces

  • application/json
  • application/yaml

2.2.218.5. Tags

  • oapiv1

2.2.219. create a Role

POST /oapi/v1/roles

2.2.219.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.158, “v1.Role”

 

2.2.219.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.158, “v1.Role”

2.2.219.3. Consumes

  • /

2.2.219.4. Produces

  • application/json
  • application/yaml

2.2.219.5. Tags

  • oapiv1

2.2.220. list objects of kind Role

GET /oapi/v1/roles

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.220.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.161, “v1.RoleList”

2.2.220.3. Consumes

  • /

2.2.220.4. Produces

  • application/json
  • application/yaml

2.2.220.5. Tags

  • oapiv1

2.2.221. create a Route

POST /oapi/v1/routes

2.2.221.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.163, “v1.Route”

 

2.2.221.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.163, “v1.Route”

2.2.221.3. Consumes

  • /

2.2.221.4. Produces

  • application/json
  • application/yaml

2.2.221.5. Tags

  • oapiv1

2.2.222. list or watch objects of kind Route

GET /oapi/v1/routes

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.222.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.166, “v1.RouteList”

2.2.222.3. Consumes

  • /

2.2.222.4. Produces

  • application/json
  • application/yaml

2.2.222.5. Tags

  • oapiv1

2.2.223. create a SubjectAccessReview

POST /oapi/v1/subjectaccessreviews

2.2.223.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.181, “v1.SubjectAccessReview”

 

2.2.223.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.181, “v1.SubjectAccessReview”

2.2.223.3. Consumes

  • /

2.2.223.4. Produces

  • application/json
  • application/yaml

2.2.223.5. Tags

  • oapiv1

2.2.224. create a Template

POST /oapi/v1/templates

2.2.224.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.189, “v1.Template”

 

2.2.224.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.189, “v1.Template”

2.2.224.3. Consumes

  • /

2.2.224.4. Produces

  • application/json
  • application/yaml

2.2.224.5. Tags

  • oapiv1

2.2.225. list or watch objects of kind Template

GET /oapi/v1/templates

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.225.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.190, “v1.TemplateList”

2.2.225.3. Consumes

  • /

2.2.225.4. Produces

  • application/json
  • application/yaml

2.2.225.5. Tags

  • oapiv1

2.2.226. create a UserIdentityMapping

POST /oapi/v1/useridentitymappings

2.2.226.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.192, “v1.UserIdentityMapping”

 

2.2.226.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.192, “v1.UserIdentityMapping”

2.2.226.3. Consumes

  • /

2.2.226.4. Produces

  • application/json
  • application/yaml

2.2.226.5. Tags

  • oapiv1

2.2.227. replace the specified UserIdentityMapping

PUT /oapi/v1/useridentitymappings/{name}

2.2.227.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.192, “v1.UserIdentityMapping”

 

PathParameter

name

name of the UserIdentityMapping

true

string

 

2.2.227.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.192, “v1.UserIdentityMapping”

2.2.227.3. Consumes

  • /

2.2.227.4. Produces

  • application/json
  • application/yaml

2.2.227.5. Tags

  • oapiv1

2.2.228. delete a UserIdentityMapping

DELETE /oapi/v1/useridentitymappings/{name}

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

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.228.3. Consumes

  • /

2.2.228.4. Produces

  • application/json
  • application/yaml

2.2.228.5. Tags

  • oapiv1

2.2.229. partially update the specified UserIdentityMapping

PATCH /oapi/v1/useridentitymappings/{name}

2.2.229.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.6, “unversioned.Patch”

 

PathParameter

name

name of the UserIdentityMapping

true

string

 

2.2.229.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.192, “v1.UserIdentityMapping”

2.2.229.3. Consumes

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

2.2.229.4. Produces

  • application/json
  • application/yaml

2.2.229.5. Tags

  • oapiv1

2.2.230. read the specified UserIdentityMapping

GET /oapi/v1/useridentitymappings/{name}

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

HTTP CodeDescriptionSchema

200

success

Section 2.3.192, “v1.UserIdentityMapping”

2.2.230.3. Consumes

  • /

2.2.230.4. Produces

  • application/json
  • application/yaml

2.2.230.5. Tags

  • oapiv1

2.2.231. create a User

POST /oapi/v1/users

2.2.231.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.191, “v1.User”

 

2.2.231.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.191, “v1.User”

2.2.231.3. Consumes

  • /

2.2.231.4. Produces

  • application/json
  • application/yaml

2.2.231.5. Tags

  • oapiv1

2.2.232. delete collection of User

DELETE /oapi/v1/users

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.232.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.232.3. Consumes

  • /

2.2.232.4. Produces

  • application/json
  • application/yaml

2.2.232.5. Tags

  • oapiv1

2.2.233. list or watch objects of kind User

GET /oapi/v1/users

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.233.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.193, “v1.UserList”

2.2.233.3. Consumes

  • /

2.2.233.4. Produces

  • application/json
  • application/yaml

2.2.233.5. Tags

  • oapiv1

2.2.234. replace the specified User

PUT /oapi/v1/users/{name}

2.2.234.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.191, “v1.User”

 

PathParameter

name

name of the User

true

string

 

2.2.234.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.191, “v1.User”

2.2.234.3. Consumes

  • /

2.2.234.4. Produces

  • application/json
  • application/yaml

2.2.234.5. Tags

  • oapiv1

2.2.235. delete a User

DELETE /oapi/v1/users/{name}

2.2.235.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.48, “v1.DeleteOptions”

 

PathParameter

name

name of the User

true

string

 

2.2.235.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.7, “unversioned.Status”

2.2.235.3. Consumes

  • /

2.2.235.4. Produces

  • application/json
  • application/yaml

2.2.235.5. Tags

  • oapiv1

2.2.236. partially update the specified User

PATCH /oapi/v1/users/{name}

2.2.236.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

BodyParameter

body

 

true

Section 2.3.6, “unversioned.Patch”

 

PathParameter

name

name of the User

true

string

 

2.2.236.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.191, “v1.User”

2.2.236.3. Consumes

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

2.2.236.4. Produces

  • application/json
  • application/yaml

2.2.236.5. Tags

  • oapiv1

2.2.237. read the specified User

GET /oapi/v1/users/{name}

2.2.237.1. Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

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

false

string

 

QueryParameter

export

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

false

boolean

 

QueryParameter

exact

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

false

boolean

 

PathParameter

name

name of the User

true

string

 

2.2.237.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.191, “v1.User”

2.2.237.3. Consumes

  • /

2.2.237.4. Produces

  • application/json
  • application/yaml

2.2.237.5. Tags

  • oapiv1

2.2.238. watch individual changes to a list of BuildConfig

GET /oapi/v1/watch/buildconfigs

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.238.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “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 Build

GET /oapi/v1/watch/builds

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.239.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.239.3. Consumes

  • /

2.2.239.4. Produces

  • application/json

2.2.239.5. Tags

  • oapiv1

2.2.240. watch individual changes to a list of ClusterNetwork

GET /oapi/v1/watch/clusternetworks

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.240.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.240.3. Consumes

  • /

2.2.240.4. Produces

  • application/json

2.2.240.5. Tags

  • oapiv1

2.2.241. watch changes to an object of kind ClusterNetwork

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

name

name of the ClusterNetwork

true

string

 

2.2.241.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.241.3. Consumes

  • /

2.2.241.4. Produces

  • application/json

2.2.241.5. Tags

  • oapiv1

2.2.242. watch individual changes to a list of ClusterPolicy

GET /oapi/v1/watch/clusterpolicies

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.242.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.242.3. Consumes

  • /

2.2.242.4. Produces

  • application/json

2.2.242.5. Tags

  • oapiv1

2.2.243. watch changes to an object of kind ClusterPolicy

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

name

name of the ClusterPolicy

true

string

 

2.2.243.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “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 ClusterPolicyBinding

GET /oapi/v1/watch/clusterpolicybindings

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.244.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.244.3. Consumes

  • /

2.2.244.4. Produces

  • application/json

2.2.244.5. Tags

  • oapiv1

2.2.245. watch changes to an object of kind ClusterPolicyBinding

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

name

name of the ClusterPolicyBinding

true

string

 

2.2.245.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “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 DeploymentConfig

GET /oapi/v1/watch/deploymentconfigs

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.246.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “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 Group

GET /oapi/v1/watch/groups

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.247.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “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 Group

GET /oapi/v1/watch/groups/{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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

name

name of the Group

true

string

 

2.2.248.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.248.3. Consumes

  • /

2.2.248.4. Produces

  • application/json

2.2.248.5. Tags

  • oapiv1

2.2.249. watch individual changes to a list of HostSubnet

GET /oapi/v1/watch/hostsubnets

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.249.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.249.3. Consumes

  • /

2.2.249.4. Produces

  • application/json

2.2.249.5. Tags

  • oapiv1

2.2.250. watch changes to an object of kind HostSubnet

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

name

name of the HostSubnet

true

string

 

2.2.250.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.250.3. Consumes

  • /

2.2.250.4. Produces

  • application/json

2.2.250.5. Tags

  • oapiv1

2.2.251. watch individual changes to a list of Identity

GET /oapi/v1/watch/identities

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.251.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.251.3. Consumes

  • /

2.2.251.4. Produces

  • application/json

2.2.251.5. Tags

  • oapiv1

2.2.252. watch changes to an object of kind Identity

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

name

name of the Identity

true

string

 

2.2.252.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.252.3. Consumes

  • /

2.2.252.4. Produces

  • application/json

2.2.252.5. Tags

  • oapiv1

2.2.253. watch individual changes to a list of Image

GET /oapi/v1/watch/images

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.253.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.253.3. Consumes

  • /

2.2.253.4. Produces

  • application/json

2.2.253.5. Tags

  • oapiv1

2.2.254. watch changes to an object of kind Image

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

name

name of the Image

true

string

 

2.2.254.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.254.3. Consumes

  • /

2.2.254.4. Produces

  • application/json

2.2.254.5. Tags

  • oapiv1

2.2.255. watch individual changes to a list of ImageStream

GET /oapi/v1/watch/imagestreams

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.255.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.255.3. Consumes

  • /

2.2.255.4. Produces

  • application/json

2.2.255.5. Tags

  • oapiv1

2.2.256. watch individual changes to a list of BuildConfig

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

2.2.256.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.256.3. Consumes

  • /

2.2.256.4. Produces

  • application/json

2.2.256.5. Tags

  • oapiv1

2.2.257. watch changes to an object of kind BuildConfig

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the BuildConfig

true

string

 

2.2.257.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.257.3. Consumes

  • /

2.2.257.4. Produces

  • application/json

2.2.257.5. Tags

  • oapiv1

2.2.258. watch individual changes to a list of Build

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

2.2.258.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.258.3. Consumes

  • /

2.2.258.4. Produces

  • application/json

2.2.258.5. Tags

  • oapiv1

2.2.259. watch changes to an object of kind Build

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Build

true

string

 

2.2.259.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.259.3. Consumes

  • /

2.2.259.4. Produces

  • application/json

2.2.259.5. Tags

  • oapiv1

2.2.260. watch individual changes to a list of DeploymentConfig

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

2.2.260.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.260.3. Consumes

  • /

2.2.260.4. Produces

  • application/json

2.2.260.5. Tags

  • oapiv1

2.2.261. watch changes to an object of kind DeploymentConfig

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the DeploymentConfig

true

string

 

2.2.261.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.261.3. Consumes

  • /

2.2.261.4. Produces

  • application/json

2.2.261.5. Tags

  • oapiv1

2.2.262. watch individual changes to a list of ImageStream

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

2.2.262.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.262.3. Consumes

  • /

2.2.262.4. Produces

  • application/json

2.2.262.5. Tags

  • oapiv1

2.2.263. watch changes to an object of kind ImageStream

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the ImageStream

true

string

 

2.2.263.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.263.3. Consumes

  • /

2.2.263.4. Produces

  • application/json

2.2.263.5. Tags

  • oapiv1

2.2.264. watch individual changes to a list of Policy

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

2.2.264.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.264.3. Consumes

  • /

2.2.264.4. Produces

  • application/json

2.2.264.5. Tags

  • oapiv1

2.2.265. watch changes to an object of kind Policy

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Policy

true

string

 

2.2.265.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.265.3. Consumes

  • /

2.2.265.4. Produces

  • application/json

2.2.265.5. Tags

  • oapiv1

2.2.266. watch individual changes to a list of PolicyBinding

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

2.2.266.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.266.3. Consumes

  • /

2.2.266.4. Produces

  • application/json

2.2.266.5. Tags

  • oapiv1

2.2.267. watch changes to an object of kind PolicyBinding

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the PolicyBinding

true

string

 

2.2.267.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.267.3. Consumes

  • /

2.2.267.4. Produces

  • application/json

2.2.267.5. Tags

  • oapiv1

2.2.268. watch individual changes to a list of Route

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

2.2.268.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.268.3. Consumes

  • /

2.2.268.4. Produces

  • application/json

2.2.268.5. Tags

  • oapiv1

2.2.269. watch changes to an object of kind Route

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Route

true

string

 

2.2.269.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.269.3. Consumes

  • /

2.2.269.4. Produces

  • application/json

2.2.269.5. Tags

  • oapiv1

2.2.270. watch individual changes to a list of Template

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

2.2.270.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.270.3. Consumes

  • /

2.2.270.4. Produces

  • application/json

2.2.270.5. Tags

  • oapiv1

2.2.271. watch changes to an object of kind Template

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

namespace

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

true

string

 

PathParameter

name

name of the Template

true

string

 

2.2.271.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.271.3. Consumes

  • /

2.2.271.4. Produces

  • application/json

2.2.271.5. Tags

  • oapiv1

2.2.272. watch individual changes to a list of NetNamespace

GET /oapi/v1/watch/netnamespaces

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.272.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.272.3. Consumes

  • /

2.2.272.4. Produces

  • application/json

2.2.272.5. Tags

  • oapiv1

2.2.273. watch changes to an object of kind NetNamespace

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

name

name of the NetNamespace

true

string

 

2.2.273.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.273.3. Consumes

  • /

2.2.273.4. Produces

  • application/json

2.2.273.5. Tags

  • oapiv1

2.2.274. watch individual changes to a list of OAuthClientAuthorization

GET /oapi/v1/watch/oauthclientauthorizations

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.274.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.274.3. Consumes

  • /

2.2.274.4. Produces

  • application/json

2.2.274.5. Tags

  • oapiv1

2.2.275. watch changes to an object of kind OAuthClientAuthorization

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

name

name of the OAuthClientAuthorization

true

string

 

2.2.275.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.275.3. Consumes

  • /

2.2.275.4. Produces

  • application/json

2.2.275.5. Tags

  • oapiv1

2.2.276. watch individual changes to a list of OAuthClient

GET /oapi/v1/watch/oauthclients

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.276.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.276.3. Consumes

  • /

2.2.276.4. Produces

  • application/json

2.2.276.5. Tags

  • oapiv1

2.2.277. watch changes to an object of kind OAuthClient

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

name

name of the OAuthClient

true

string

 

2.2.277.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.277.3. Consumes

  • /

2.2.277.4. Produces

  • application/json

2.2.277.5. Tags

  • oapiv1

2.2.278. watch individual changes to a list of Policy

GET /oapi/v1/watch/policies

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.278.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.278.3. Consumes

  • /

2.2.278.4. Produces

  • application/json

2.2.278.5. Tags

  • oapiv1

2.2.279. watch individual changes to a list of PolicyBinding

GET /oapi/v1/watch/policybindings

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.279.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.279.3. Consumes

  • /

2.2.279.4. Produces

  • application/json

2.2.279.5. Tags

  • oapiv1

2.2.280. watch individual changes to a list of Route

GET /oapi/v1/watch/routes

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.280.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.280.3. Consumes

  • /

2.2.280.4. Produces

  • application/json

2.2.280.5. Tags

  • oapiv1

2.2.281. watch individual changes to a list of Template

GET /oapi/v1/watch/templates

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.281.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.281.3. Consumes

  • /

2.2.281.4. Produces

  • application/json

2.2.281.5. Tags

  • oapiv1

2.2.282. watch individual changes to a list of User

GET /oapi/v1/watch/users

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

2.2.282.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.282.3. Consumes

  • /

2.2.282.4. Produces

  • application/json

2.2.282.5. Tags

  • oapiv1

2.2.283. watch changes to an object of kind User

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

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

 

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

 

PathParameter

name

name of the User

true

string

 

2.2.283.2. Responses

HTTP CodeDescriptionSchema

200

success

Section 2.3.2, “json.WatchEvent”

2.2.283.3. Consumes

  • /

2.2.283.4. Produces

  • application/json

2.2.283.5. Tags

  • oapiv1

2.3. Definitions

2.3.1. integer

2.3.2. 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.3. 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.4. runtime.RawExtension

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

2.3.5. unversioned.ListMeta

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

NameDescriptionRequiredSchemaDefault

selfLink

SelfLink is a URL representing this object. Populated by the system. Read-only.

false

string

 

resourceVersion

String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

 

2.3.6. unversioned.Patch

Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.

2.3.7. unversioned.Status

Status is a return value for calls that don’t return other objects.

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

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

false

Section 2.3.5, “unversioned.ListMeta”

 

status

Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#spec-and-status

false

string

 

message

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

false

string

 

reason

A 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.9, “unversioned.StatusDetails”

 

code

Suggested HTTP return code for this status, 0 if not set.

false

integer (int32)

 

2.3.8. unversioned.StatusCause

StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.

NameDescriptionRequiredSchemaDefault

reason

A machine-readable description of the cause of the error. If this value is empty there is no information available.

false

string

 

message

A human-readable description of the cause of the error. This field may be presented as-is to a reader.

false

string

 

field

The 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. Optional.

Examples:
"name" - the field "name" on the current resource
"items[0].name" - the field "name" on the first array entry in "items"

false

string

 

2.3.9. unversioned.StatusDetails

StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

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

 

group

The group attribute of the resource associated with the status StatusReason.

false

string

 

kind

The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: http://releases.k8s.io/release-1.2/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.8, “unversioned.StatusCause” array

 

retryAfterSeconds

If specified, the time in seconds before the operation should be retried.

false

integer (int32)

 

2.3.10. v1.AWSElasticBlockStoreVolumeSource

Represents a Persistent Disk resource in AWS.

An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.

NameDescriptionRequiredSchemaDefault

volumeID

Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#awselasticblockstore

true

string

 

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#awselasticblockstore

false

string

 

partition

The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).

false

integer (int32)

 

readOnly

Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#awselasticblockstore

false

boolean

 

2.3.11. v1.AzureFileVolumeSource

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

NameDescriptionRequiredSchemaDefault

secretName

the name of secret that contains Azure Storage Account Name and Key

true

string

 

shareName

Share Name

true

string

 

readOnly

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

boolean

 

2.3.12. v1.BinaryBuildSource

BinaryBuildSource describes a binary file to be used for the Docker and Source build strategies, where the file will be extracted and used as the build source.

NameDescriptionRequiredSchemaDefault

asFile

AsFile indicates that the provided binary input should be considered a single file within the build input. For example, specifying "webapp.war" would place the provided binary as /webapp.war for the builder. If left empty, the Docker and Source build strategies assume this file is a zip, tar, or tar.gz file and extract it as the source. The custom strategy receives this binary as standard input. This filename may not contain slashes or be '..' or '.'.

false

string

 

2.3.13. v1.Build

Build encapsulates the inputs needed to produce a new deployable image, as well as the status of the execution and a reference to the Pod which executed the build.

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

spec

Spec is all the inputs used to execute the build.

false

Section 2.3.24, “v1.BuildSpec”

 

status

Status is the current status of the build.

false

Section 2.3.25, “v1.BuildStatus”

 

2.3.14. 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 is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

spec

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

true

Section 2.3.16, “v1.BuildConfigSpec”

 

status

Status holds any relevant information about a build config

true

Section 2.3.17, “v1.BuildConfigStatus”

 

2.3.15. v1.BuildConfigList

BuildConfigList is a collection of BuildConfigs.

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.5, “unversioned.ListMeta”

 

items

Items is a list of build configs

true

Section 2.3.14, “v1.BuildConfig” array

 

2.3.16. v1.BuildConfigSpec

BuildConfigSpec describes when and how builds are created

NameDescriptionRequiredSchemaDefault

triggers

Triggers determine how new Builds can be launched from a BuildConfig. If no triggers are defined, a new build can only occur as a result of an explicit client build creation.

true

Section 2.3.27, “v1.BuildTriggerPolicy” array

 

serviceAccount

ServiceAccount is the name of the ServiceAccount to use to run the pod created by this build. The pod will be allowed to use secrets referenced by the ServiceAccount

false

string

 

source

Source describes the SCM in use.

false

Section 2.3.23, “v1.BuildSource”

 

revision

Revision is the information from the source for a specific repo snapshot. This is optional.

false

Section 2.3.180, “v1.SourceRevision”

 

strategy

Strategy defines how to perform a build.

true

Section 2.3.26, “v1.BuildStrategy”

 

output

Output describes the Docker image the Strategy should produce.

false

Section 2.3.20, “v1.BuildOutput”

 

resources

Compute resource requirements to execute the build

false

Section 2.3.157, “v1.ResourceRequirements”

 

postCommit

PostCommit is a build hook executed after the build output image is committed, before it is pushed to a registry.

false

Section 2.3.21, “v1.BuildPostCommitSpec”

 

completionDeadlineSeconds

Optional duration in seconds, counted from the time when a build pod gets scheduled in the system, that the build may be active on a node before the system actively tries to terminate the build; value must be positive integer

false

integer (int64)

 

2.3.17. v1.BuildConfigStatus

BuildConfigStatus contains current state of the build config object.

NameDescriptionRequiredSchemaDefault

lastVersion

LastVersion is used to inform about number of last triggered build.

true

integer (int32)

 

2.3.18. v1.BuildList

BuildList is a collection of Builds.

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.5, “unversioned.ListMeta”

 

items

Items is a list of builds

true

Section 2.3.13, “v1.Build” array

 

2.3.19. v1.BuildLog

BuildLog is the (unused) resource associated with the build log redirector

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

2.3.20. v1.BuildOutput

BuildOutput is input to a build strategy and describes the Docker image that the strategy should produce.

NameDescriptionRequiredSchemaDefault

to

To defines an optional location to push the output of this build to. Kind must be one of 'ImageStreamTag' or 'DockerImage'. This value will be used to look up a Docker image repository to push to. In the case of an ImageStreamTag, the ImageStreamTag will be looked for in the namespace of the build unless Namespace is specified.

false

Section 2.3.135, “v1.ObjectReference”

 

pushSecret

PushSecret is the name of a Secret that would be used for setting up the authentication for executing the Docker push to authentication enabled Docker Registry (or Docker Hub).

false

Section 2.3.112, “v1.LocalObjectReference”

 

2.3.21. v1.BuildPostCommitSpec

A BuildPostCommitSpec holds a build post commit hook specification. The hook executes a command in a temporary container running the build output image, immediately after the last layer of the image is committed and before the image is pushed to a registry. The command is executed with the current working directory ($PWD) set to the image’s WORKDIR.

The build will be marked as failed if the hook execution fails. It will fail if the script or command return a non-zero exit code, or if there is any other error related to starting the temporary container.

There are five different ways to configure the hook. As an example, all forms below are equivalent and will execute rake test --verbose.

  1. Shell script:

    "postCommit": {
      "script": "rake test --verbose",
    }
    The above is a convenient form which is equivalent to:
    "postCommit": {
     "command": ["/bin/sh", "-ic"],
      "args":    ["rake test --verbose"]
    }
  2. Command as the image entrypoint:

    "postCommit": {
      "commit": ["rake", "test", "--verbose"]
    }
    Command overrides the image entrypoint in the exec form, as documented in
    Docker: https://docs.docker.com/engine/reference/builder/#entrypoint.
  3. Pass arguments to the default entrypoint:

    "postCommit": {
     "args": ["rake", "test", "--verbose"]
    }
    This form is only useful if the image entrypoint can handle arguments.
  4. Shell script with arguments:

    "postCommit": {
      "script": "rake test $1",
      "args":   ["--verbose"]
    }
    This form is useful if you need to pass arguments that would otherwise be
    hard to quote properly in the shell script. In the script, $0 will be
    "/bin/sh" and $1, $2, etc, are the positional arguments from Args.
  5. Command with arguments:

    "postCommit": {
      "command": ["rake", "test"],
      "args":    ["--verbose"]
    }
    This form is equivalent to appending the arguments to the Command slice.

It is invalid to provide both Script and Command simultaneously. If none of the fields are specified, the hook is not executed.

NameDescriptionRequiredSchemaDefault

command

Command is the command to run. It may not be specified with Script. This might be needed if the image doesn’t have /bin/sh, or if you do not want to use a shell. In all other cases, using Script might be more convenient.

false

string array

 

args

Args is a list of arguments that are provided to either Command, Script or the Docker image’s default entrypoint. The arguments are placed immediately after the command to be run.

false

string array

 

script

Script is a shell script to be run with /bin/sh -ic. It may not be specified with Command. Use Script when a shell script is appropriate to execute the post build hook, for example for running unit tests with rake test. If you need control over the image entrypoint, or if the image does not have /bin/sh, use Command and/or Args. The -i flag is needed to support CentOS and RHEL images that use Software Collections (SCL), in order to have the appropriate collections enabled in the shell. E.g., in the Ruby image, this is necessary to make ruby, bundle and other binaries available in the PATH.

false

string

 

2.3.22. v1.BuildRequest

BuildRequest is the resource used to pass parameters to build generator

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

revision

Revision is the information from the source for a specific repo snapshot.

false

Section 2.3.180, “v1.SourceRevision”

 

triggeredByImage

TriggeredByImage is the Image that triggered this build.

false

Section 2.3.135, “v1.ObjectReference”

 

from

From is the reference to the ImageStreamTag that triggered the build.

false

Section 2.3.135, “v1.ObjectReference”

 

binary

Binary indicates a request to build from a binary provided to the builder

false

Section 2.3.12, “v1.BinaryBuildSource”

 

lastVersion

LastVersion (optional) is the LastVersion of the BuildConfig that was used to generate the build. If the BuildConfig in the generator doesn’t match, a build will not be generated.

false

integer (int32)

 

env

Env contains additional environment variables you want to pass into a builder container

false

Section 2.3.66, “v1.EnvVar” array

 

2.3.23. v1.BuildSource

BuildSource is the SCM used for the build.

NameDescriptionRequiredSchemaDefault

type

Type of build input to accept

true

string

 

binary

Binary builds accept a binary as their input. The binary is generally assumed to be a tar, gzipped tar, or zip file depending on the strategy. For Docker builds, this is the build context and an optional Dockerfile may be specified to override any Dockerfile in the build context. For Source builds, this is assumed to be an archive as described above. For Source and Docker builds, if binary.asFile is set the build will receive a directory with a single file. contextDir may be used when an archive is provided. Custom builds will receive this binary as input on STDIN.

false

Section 2.3.12, “v1.BinaryBuildSource”

 

dockerfile

Dockerfile is the raw contents of a Dockerfile which should be built. When this option is specified, the FROM may be modified based on your strategy base image and additional ENV stanzas from your strategy environment will be added after the FROM, but before the rest of your Dockerfile stanzas. The Dockerfile source type may be used with other options like git - in those cases the Git repo will have any innate Dockerfile replaced in the context dir.

false

string

 

git

Git contains optional information about git build source

false

Section 2.3.75, “v1.GitBuildSource”

 

images

Images describes a set of images to be used to provide source for the build

false

Section 2.3.96, “v1.ImageSource” array

 

contextDir

ContextDir specifies the sub-directory where the source code for the application exists. This allows to have buildable sources in directory other than root of repository.

false

string

 

sourceSecret

SourceSecret is the name of a Secret that would be used for setting up the authentication for cloning private repository. The secret contains valid credentials for remote repository, where the data’s key represent the authentication method to be used and value is the base64 encoded credentials. Supported auth methods are: ssh-privatekey.

false

Section 2.3.112, “v1.LocalObjectReference”

 

secrets

Secrets represents a list of secrets and their destinations that will be used only for the build.

true

Section 2.3.172, “v1.SecretBuildSource” array

 

2.3.24. v1.BuildSpec

BuildSpec encapsulates all the inputs necessary to represent a build.

NameDescriptionRequiredSchemaDefault

serviceAccount

ServiceAccount is the name of the ServiceAccount to use to run the pod created by this build. The pod will be allowed to use secrets referenced by the ServiceAccount

false

string

 

source

Source describes the SCM in use.

false

Section 2.3.23, “v1.BuildSource”

 

revision

Revision is the information from the source for a specific repo snapshot. This is optional.

false

Section 2.3.180, “v1.SourceRevision”

 

strategy

Strategy defines how to perform a build.

true

Section 2.3.26, “v1.BuildStrategy”

 

output

Output describes the Docker image the Strategy should produce.

false

Section 2.3.20, “v1.BuildOutput”

 

resources

Compute resource requirements to execute the build

false

Section 2.3.157, “v1.ResourceRequirements”

 

postCommit

PostCommit is a build hook executed after the build output image is committed, before it is pushed to a registry.

false

Section 2.3.21, “v1.BuildPostCommitSpec”

 

completionDeadlineSeconds

Optional duration in seconds, counted from the time when a build pod gets scheduled in the system, that the build may be active on a node before the system actively tries to terminate the build; value must be positive integer

false

integer (int64)

 

2.3.25. v1.BuildStatus

BuildStatus contains the status of a build

NameDescriptionRequiredSchemaDefault

phase

Phase is the point in the build lifecycle.

true

string

 

cancelled

Cancelled describes if a cancel event was triggered for the build.

false

boolean

 

reason

Reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.

false

string

 

message

Message is a human-readable message indicating details about why the build has this status.

false

string

 

startTimestamp

StartTimestamp is a timestamp representing the server time when this Build started running in a Pod. It is represented in RFC3339 form and is in UTC.

false

string

 

completionTimestamp

CompletionTimestamp is a timestamp representing the server time when this Build was finished, whether that build failed or succeeded. It reflects the time at which the Pod running the Build terminated. It is represented in RFC3339 form and is in UTC.

false

string

 

duration

Duration contains time.Duration object describing build time.

false

time.Duration

 

outputDockerImageReference

OutputDockerImageReference contains a reference to the Docker image that will be built by this build. It’s value is computed from Build.Spec.Output.To, and should include the registry address, so that it can be used to push and pull the image.

false

string

 

config

Config is an ObjectReference to the BuildConfig this Build is based on.

false

Section 2.3.135, “v1.ObjectReference”

 

2.3.26. v1.BuildStrategy

BuildStrategy contains the details of how to perform a build.

NameDescriptionRequiredSchemaDefault

type

Type is the kind of build strategy.

true

string

 

dockerStrategy

DockerStrategy holds the parameters to the Docker build strategy.

false

Section 2.3.62, “v1.DockerBuildStrategy”

 

sourceStrategy

SourceStrategy holds the parameters to the Source build strategy.

false

Section 2.3.178, “v1.SourceBuildStrategy”

 

customStrategy

CustomStrategy holds the parameters to the Custom build strategy

false

Section 2.3.46, “v1.CustomBuildStrategy”

 

2.3.27. v1.BuildTriggerPolicy

BuildTriggerPolicy describes a policy for a single trigger that results in a new Build.

NameDescriptionRequiredSchemaDefault

type

Type is the type of build trigger

true

string

 

github

GitHubWebHook contains the parameters for a GitHub webhook type of trigger

false

Section 2.3.196, “v1.WebHookTrigger”

 

generic

GenericWebHook contains the parameters for a Generic webhook type of trigger

false

Section 2.3.196, “v1.WebHookTrigger”

 

imageChange

ImageChange contains parameters for an ImageChange type of trigger

false

Section 2.3.91, “v1.ImageChangeTrigger”

 

2.3.28. v1.Capabilities

Adds and removes POSIX capabilities from running containers.

NameDescriptionRequiredSchemaDefault

add

Added capabilities

false

Section 2.3.29, “v1.Capability” array

 

drop

Removed capabilities

false

Section 2.3.29, “v1.Capability” array

 

2.3.29. v1.Capability

2.3.30. v1.CephFSVolumeSource

Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.

NameDescriptionRequiredSchemaDefault

monitors

Required: Monitors is a collection of Ceph monitors More info: http://releases.k8s.io/release-1.2/examples/cephfs/README.md#how-to-use-it

true

string array

 

path

Optional: Used as the mounted root, rather than the full Ceph tree, default is /

false

string

 

user

Optional: User is the rados user name, default is admin More info: http://releases.k8s.io/release-1.2/examples/cephfs/README.md#how-to-use-it

false

string

 

secretFile

Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: http://releases.k8s.io/release-1.2/examples/cephfs/README.md#how-to-use-it

false

string

 

secretRef

Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: http://releases.k8s.io/release-1.2/examples/cephfs/README.md#how-to-use-it

false

Section 2.3.112, “v1.LocalObjectReference”

 

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/release-1.2/examples/cephfs/README.md#how-to-use-it

false

boolean

 

2.3.31. v1.CinderVolumeSource

CinderVolumeSource represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet.

NameDescriptionRequiredSchemaDefault

volumeID

volume id used to identify the volume in cinder More info: http://releases.k8s.io/release-1.2/examples/mysql-cinder-pd/README.md

true

string

 

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.2/examples/mysql-cinder-pd/README.md

false

string

 

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/release-1.2/examples/mysql-cinder-pd/README.md

false

boolean

 

2.3.32. v1.ClusterNetwork

ClusterNetwork describes a cluster network

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

network

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

true

string

 

hostsubnetlength

HostSubnetLength is the 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

ServiceNetwork is the CIDR string to specify the service network

true

string

 

2.3.33. v1.ClusterNetworkList

ClusterNetworkList is a collection of ClusterNetworks

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.5, “unversioned.ListMeta”

 

items

Items is the list of cluster networks

true

Section 2.3.32, “v1.ClusterNetwork” array

 

2.3.34. v1.ClusterPolicy

ClusterPolicy is a object that holds all the ClusterRoles for a particular namespace. There is at most one ClusterPolicy document per namespace.

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

lastModified

LastModified is the last time that any part of the ClusterPolicy was created, updated, or deleted

true

string

 

roles

Roles holds all the ClusterRoles held by this ClusterPolicy, mapped by ClusterRole.Name

true

Section 2.3.118, “v1.NamedClusterRole” array

 

2.3.35. v1.ClusterPolicyBinding

ClusterPolicyBinding is a object that holds all the ClusterRoleBindings for a particular namespace. There is one ClusterPolicyBinding document per referenced ClusterPolicy namespace

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

lastModified

LastModified is the last time that any part of the ClusterPolicyBinding was created, updated, or deleted

true

string

 

policyRef

PolicyRef is a reference to the ClusterPolicy that contains all the ClusterRoles that this ClusterPolicyBinding’s RoleBindings may reference

true

Section 2.3.135, “v1.ObjectReference”

 

roleBindings

RoleBindings holds all the ClusterRoleBindings held by this ClusterPolicyBinding, mapped by ClusterRoleBinding.Name

true

Section 2.3.119, “v1.NamedClusterRoleBinding” array

 

2.3.36. v1.ClusterPolicyBindingList

ClusterPolicyBindingList is a collection of ClusterPolicyBindings

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.5, “unversioned.ListMeta”

 

items

Items is a list of ClusterPolicyBindings

true

Section 2.3.35, “v1.ClusterPolicyBinding” array

 

2.3.37. v1.ClusterPolicyList

ClusterPolicyList is a collection of ClusterPolicies

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.5, “unversioned.ListMeta”

 

items

Items is a list of ClusterPolicies

true

Section 2.3.34, “v1.ClusterPolicy” array

 

2.3.38. v1.ClusterRole

ClusterRole is a logical grouping of PolicyRules that can be referenced as a unit by ClusterRoleBindings.

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

rules

Rules holds all the PolicyRules for this ClusterRole

true

Section 2.3.145, “v1.PolicyRule” array

 

2.3.39. v1.ClusterRoleBinding

ClusterRoleBinding references a ClusterRole, but not contain it. It can reference any ClusterRole in the same namespace or in the global namespace. It adds who information via Users and Groups and namespace information by which namespace it exists in. ClusterRoleBindings in a given namespace only have effect in that namespace (excepting the master namespace which has power in all namespaces).

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

userNames

UserNames holds all the usernames directly bound to the role

true

string array

 

groupNames

GroupNames holds all the groups directly bound to the role

true

string array

 

subjects

Subjects hold object references to authorize with this rule

true

Section 2.3.135, “v1.ObjectReference” array

 

roleRef

RoleRef can only reference the current namespace and the global namespace If the ClusterRoleRef cannot be resolved, the Authorizer must return an error. Since Policy is a singleton, this is sufficient knowledge to locate a role

true

Section 2.3.135, “v1.ObjectReference”

 

2.3.40. v1.ClusterRoleBindingList

ClusterRoleBindingList is a collection of ClusterRoleBindings

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.5, “unversioned.ListMeta”

 

items

Items is a list of ClusterRoleBindings

true

Section 2.3.39, “v1.ClusterRoleBinding” array

 

2.3.41. v1.ClusterRoleList

ClusterRoleList is a collection of ClusterRoles

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.5, “unversioned.ListMeta”

 

items

Items is a list of ClusterRoles

true

Section 2.3.38, “v1.ClusterRole” array

 

2.3.42. v1.ConfigMapKeySelector

Selects a key from a ConfigMap.

NameDescriptionRequiredSchemaDefault

name

Name of the referent. More info: http://releases.k8s.io/release-1.2/docs/user-guide/identifiers.md#names

false

string

 

key

The key to select.

true

string

 

2.3.43. v1.ConfigMapVolumeSource

Adapts a ConfigMap into a volume.

The contents of the target ConfigMap’s Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.

NameDescriptionRequiredSchemaDefault

name

Name of the referent. More info: http://releases.k8s.io/release-1.2/docs/user-guide/identifiers.md#names

false

string

 

items

If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error. Paths must be relative and may not contain the '..' path or start with '..'.

false

Section 2.3.109, “v1.KeyToPath” array

 

2.3.44. v1.Container

A single application container that you want to run within a pod.

NameDescriptionRequiredSchemaDefault

name

Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

true

string

 

image

Docker image name. More info: http://releases.k8s.io/release-1.2/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. Variable references $(VAR_NAME) are expanded using the container’s environment. 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. Cannot be updated. More info: http://releases.k8s.io/release-1.2/docs/user-guide/containers.md#containers-and-commands

false

string array

 

args

Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. 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. Cannot be updated. More info: http://releases.k8s.io/release-1.2/docs/user-guide/containers.md#containers-and-commands

false

string array

 

workingDir

Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated.

false

string

 

ports

List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.

false

Section 2.3.45, “v1.ContainerPort” array

 

env

List of environment variables to set in the container. Cannot be updated.

false

Section 2.3.66, “v1.EnvVar” array

 

resources

Compute Resources required by this container. Cannot be updated. More info: http://releases.k8s.io/release-1.2/docs/user-guide/persistent-volumes.md#resources

false

Section 2.3.157, “v1.ResourceRequirements”

 

volumeMounts

Pod volumes to mount into the container’s filesyste. Cannot be updated.

false

Section 2.3.195, “v1.VolumeMount” array

 

livenessProbe

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://releases.k8s.io/release-1.2/docs/user-guide/pod-states.md#container-probes

false

Section 2.3.146, “v1.Probe”

 

readinessProbe

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: http://releases.k8s.io/release-1.2/docs/user-guide/pod-states.md#container-probes

false

Section 2.3.146, “v1.Probe”

 

lifecycle

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

false

Section 2.3.110, “v1.Lifecycle”

 

terminationMessagePath

Optional: 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. More info: http://releases.k8s.io/release-1.2/docs/user-guide/images.md#updating-images

false

string

 

securityContext

Security options the pod should run with. More info: http://releases.k8s.io/release-1.2/docs/design/security_context.md

false

Section 2.3.177, “v1.SecurityContext”

 

stdin

Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.

false

boolean

 

stdinOnce

Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false

false

boolean

 

tty

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

false

boolean

 

2.3.45. v1.ContainerPort

ContainerPort represents a network port in a single container.

NameDescriptionRequiredSchemaDefault

name

If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.

false

string

 

hostPort

Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.

false

integer (int32)

 

containerPort

Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.

true

integer (int32)

 

protocol

Protocol for port. Must be UDP or TCP. Defaults to "TCP".

false

string

 

hostIP

What host IP to bind the external port to.

false

string

 

2.3.46. v1.CustomBuildStrategy

CustomBuildStrategy defines input parameters specific to Custom build.

NameDescriptionRequiredSchemaDefault

from

From is reference to an DockerImage, ImageStreamTag, or ImageStreamImage from which the docker image should be pulled

true

Section 2.3.135, “v1.ObjectReference”

 

pullSecret

PullSecret is the name of a Secret that would be used for setting up the authentication for pulling the Docker images from the private Docker registries

false

Section 2.3.112, “v1.LocalObjectReference”

 

env

Env contains additional environment variables you want to pass into a builder container

false

Section 2.3.66, “v1.EnvVar” array

 

exposeDockerSocket

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

false

boolean

 

forcePull

ForcePull describes if the controller should configure the build pod to always pull the images for the builder or only pull if it is not present locally

false

boolean

 

secrets

Secrets is a list of additional secrets that will be included in the build pod

false

Section 2.3.175, “v1.SecretSpec” array

 

buildAPIVersion

BuildAPIVersion is the requested API version for the Build object serialized and passed to the custom builder

false

string

 

2.3.47. v1.CustomDeploymentStrategyParams

CustomDeploymentStrategyParams are the input to the Custom deployment strategy.

NameDescriptionRequiredSchemaDefault

image

Image specifies a Docker image which can carry out a deployment.

false

string

 

environment

Environment holds the environment which will be given to the container for Image.

false

Section 2.3.66, “v1.EnvVar” array

 

command

Command is optional and overrides CMD in the container Image.

false

string array

 

2.3.48. v1.DeleteOptions

DeleteOptions may be provided when deleting an API object

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

true

integer (int64)

 

2.3.49. v1.DeploymentCause

DeploymentCause captures information about a particular cause of a deployment.

NameDescriptionRequiredSchemaDefault

type

Type of the trigger that resulted in the creation of a new deployment

true

string

 

imageTrigger

ImageTrigger contains the image trigger details, if this trigger was fired based on an image change

false

Section 2.3.50, “v1.DeploymentCauseImageTrigger”

 

2.3.50. v1.DeploymentCauseImageTrigger

DeploymentCauseImageTrigger represents details about the cause of a deployment originating from an image change trigger

NameDescriptionRequiredSchemaDefault

from

From is a reference to the changed object which triggered a deployment. The field may have the kinds DockerImage, ImageStreamTag, or ImageStreamImage.

true

Section 2.3.135, “v1.ObjectReference”

 

2.3.51. 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 is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

spec

Spec represents a desired deployment state and how to deploy to it.

true

Section 2.3.55, “v1.DeploymentConfigSpec”

 

status

Status represents the current deployment state.

true

Section 2.3.56, “v1.DeploymentConfigStatus”

 

2.3.52. v1.DeploymentConfigList

DeploymentConfigList is a collection of deployment configs.

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.5, “unversioned.ListMeta”

 

items

Items is a list of deployment configs

true

Section 2.3.51, “v1.DeploymentConfig” array

 

2.3.53. v1.DeploymentConfigRollback

DeploymentConfigRollback provides the input to rollback generation.

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

spec

Spec defines the options to rollback generation.

true

Section 2.3.54, “v1.DeploymentConfigRollbackSpec”

 

2.3.54. v1.DeploymentConfigRollbackSpec

DeploymentConfigRollbackSpec represents the options for rollback generation.

NameDescriptionRequiredSchemaDefault

from

From points to a ReplicationController which is a deployment.

true

Section 2.3.135, “v1.ObjectReference”

 

includeTriggers

IncludeTriggers specifies whether to include config Triggers.

true

boolean

 

includeTemplate

IncludeTemplate specifies whether to include the PodTemplateSpec.

true

boolean

 

includeReplicationMeta

IncludeReplicationMeta specifies whether to include the replica count and selector.

true

boolean

 

includeStrategy

IncludeStrategy specifies whether to include the deployment Strategy.

true

boolean

 

2.3.55. v1.DeploymentConfigSpec

DeploymentConfigSpec represents the desired state of the deployment.

NameDescriptionRequiredSchemaDefault

strategy

Strategy describes how a deployment is executed.

true

Section 2.3.59, “v1.DeploymentStrategy”

 

triggers

Triggers determine how updates to a DeploymentConfig result in new deployments. If no triggers are defined, a new deployment can only occur as a result of an explicit client update to the DeploymentConfig with a new LatestVersion.

true

Section 2.3.61, “v1.DeploymentTriggerPolicy” array

 

replicas

Replicas is the number of desired replicas.

true

integer (int32)

 

test

Test ensures that this deployment config will have zero replicas except while a deployment is running. This allows the deployment config to be used as a continuous deployment test - triggering on images, running the deployment, and then succeeding or failing. Post strategy hooks and After actions can be used to integrate successful deployment with an action.

true

boolean

 

selector

Selector is a label query over pods that should match the Replicas count.

false

Section 2.3.200, “any”

 

template

Template is the object that describes the pod that will be created if insufficient replicas are detected.

false

Section 2.3.140, “v1.PodTemplateSpec”

 

2.3.56. v1.DeploymentConfigStatus

DeploymentConfigStatus represents the current deployment state.

NameDescriptionRequiredSchemaDefault

latestVersion

LatestVersion is used to determine whether the current deployment associated with a DeploymentConfig is out of sync.

false

integer (int32)

 

details

Details are the reasons for the update to this deployment config. This could be based on a change made by the user or caused by an automatic trigger

false

Section 2.3.57, “v1.DeploymentDetails”

 

2.3.57. v1.DeploymentDetails

DeploymentDetails captures information about the causes of a deployment.

NameDescriptionRequiredSchemaDefault

message

Message is the user specified change message, if this deployment was triggered manually by the user

false

string

 

causes

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

false

Section 2.3.49, “v1.DeploymentCause” array

 

2.3.58. v1.DeploymentLog

A deployment log is a virtual resource used by the OpenShift Enterprise client tool for retrieving the logs for a deployment.

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

2.3.59. v1.DeploymentStrategy

DeploymentStrategy describes how to perform a deployment.

NameDescriptionRequiredSchemaDefault

type

Type is the name of a deployment strategy.

false

string

 

customParams

CustomParams are the input to the Custom deployment strategy.

false

Section 2.3.47, “v1.CustomDeploymentStrategyParams”

 

recreateParams

RecreateParams are the input to the Recreate deployment strategy.

false

Section 2.3.153, “v1.RecreateDeploymentStrategyParams”

 

rollingParams

RollingParams are the input to the Rolling deployment strategy.

false

Section 2.3.162, “v1.RollingDeploymentStrategyParams”

 

resources

Resources contains resource requirements to execute the deployment and any hooks

false

Section 2.3.157, “v1.ResourceRequirements”

 

labels

Labels is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods.

false

Section 2.3.200, “any”

 

annotations

Annotations is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods.

false

Section 2.3.200, “any”

 

2.3.60. v1.DeploymentTriggerImageChangeParams

DeploymentTriggerImageChangeParams represents the parameters to the ImageChange trigger.

NameDescriptionRequiredSchemaDefault

automatic

Automatic means that the detection of a new tag value should result in a new deployment.

false

boolean

 

containerNames

ContainerNames is used to restrict tag updates to the specified set of container names in a pod.

false

string array

 

from

From is a reference to an image stream tag to watch for changes. From.Name is the only required subfield - if From.Namespace is blank, the namespace of the current deployment trigger will be used.

true

Section 2.3.135, “v1.ObjectReference”

 

lastTriggeredImage

LastTriggeredImage is the last image to be triggered.

false

string

 

2.3.61. v1.DeploymentTriggerPolicy

DeploymentTriggerPolicy describes a policy for a single trigger that results in a new deployment.

NameDescriptionRequiredSchemaDefault

type

Type of the trigger

false

string

 

imageChangeParams

ImageChangeParams represents the parameters for the ImageChange trigger.

false

Section 2.3.60, “v1.DeploymentTriggerImageChangeParams”

 

2.3.62. v1.DockerBuildStrategy

DockerBuildStrategy defines input parameters specific to Docker build.

NameDescriptionRequiredSchemaDefault

from

From is reference to an DockerImage, ImageStreamTag, or ImageStreamImage from which the docker image should be pulled the resulting image will be used in the FROM line of the Dockerfile for this build.

false

Section 2.3.135, “v1.ObjectReference”

 

pullSecret

PullSecret is the name of a Secret that would be used for setting up the authentication for pulling the Docker images from the private Docker registries

false

Section 2.3.112, “v1.LocalObjectReference”

 

noCache

NoCache if set to true indicates that the docker build must be executed with the --no-cache=true flag

false

boolean

 

env

Env contains additional environment variables you want to pass into a builder container

false

Section 2.3.66, “v1.EnvVar” array

 

forcePull

ForcePull describes if the builder should pull the images from registry prior to building.

false

boolean

 

dockerfilePath

DockerfilePath is the path of the Dockerfile that will be used to build the Docker image, relative to the root of the context (contextDir).

false

string

 

2.3.63. v1.DownwardAPIVolumeFile

DownwardAPIVolumeFile represents a single file containing information from the downward API

NameDescriptionRequiredSchemaDefault

path

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'

true

string

 

fieldRef

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

true

Section 2.3.133, “v1.ObjectFieldSelector”

 

2.3.64. v1.DownwardAPIVolumeSource

DownwardAPIVolumeSource represents a volume containing downward API info

NameDescriptionRequiredSchemaDefault

items

Items is a list of downward API volume file

false

Section 2.3.63, “v1.DownwardAPIVolumeFile” array

 

2.3.65. v1.EmptyDirVolumeSource

Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.

NameDescriptionRequiredSchemaDefault

medium

What type of storage medium should back this directory. The default is "" which means to use the node’s default medium. Must be an empty string (default) or Memory. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#emptydir

false

string

 

2.3.66. v1.EnvVar

EnvVar represents an environment variable present in a Container.

NameDescriptionRequiredSchemaDefault

name

Name of the environment variable. Must be a C_IDENTIFIER.

true

string

 

value

Variable references $(VAR_NAME) are expanded using the previous 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. Defaults to "".

false

string

 

valueFrom

Source for the environment variable’s value. Cannot be used if value is not empty.

false

Section 2.3.67, “v1.EnvVarSource”

 

2.3.67. v1.EnvVarSource

EnvVarSource represents a source for the value of an EnvVar.

NameDescriptionRequiredSchemaDefault

fieldRef

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

false

Section 2.3.133, “v1.ObjectFieldSelector”

 

configMapKeyRef

Selects a key of a ConfigMap.

false

Section 2.3.42, “v1.ConfigMapKeySelector”

 

secretKeyRef

Selects a key of a secret in the pod’s namespace

false

Section 2.3.173, “v1.SecretKeySelector”

 

2.3.68. v1.ExecAction

ExecAction describes a "run in container" action.

NameDescriptionRequiredSchemaDefault

command

Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

false

string array

 

2.3.69. v1.ExecNewPodHook

ExecNewPodHook is a hook implementation which runs a command in a new pod based on the specified container which is assumed to be part of the deployment template.

NameDescriptionRequiredSchemaDefault

command

Command is the action command and its arguments.

true

string array

 

env

Env is a set of environment variables to supply to the hook pod’s container.

false

Section 2.3.66, “v1.EnvVar” array

 

containerName

ContainerName is the name of a container in the deployment pod template whose Docker image will be used for the hook pod’s container.

true

string

 

volumes

Volumes is a list of named volumes from the pod template which should be copied to the hook pod. Volumes names not found in pod spec are ignored. An empty list means no volumes will be copied.

false

string array

 

2.3.70. v1.FCVolumeSource

Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.

NameDescriptionRequiredSchemaDefault

targetWWNs

Required: FC target world wide names (WWNs)

true

string array

 

lun

Required: FC target lun number

true

integer (int32)

 

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

 

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

boolean

 

2.3.71. v1.FinalizerName

2.3.72. v1.FlexVolumeSource

FlexVolume represents a generic volume resource that is provisioned/attached using a exec based plug-in. This is an alpha feature and may change in future.

NameDescriptionRequiredSchemaDefault

driver

Driver is the name of the driver to use for this volume.

true

string

 

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.

false

string

 

secretRef

Optional: SecretRef is reference to the authentication secret for User, default is empty.

false

Section 2.3.112, “v1.LocalObjectReference”

 

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

boolean

 

options

Optional: Extra command options if any.

false

Section 2.3.200, “any”

 

2.3.73. v1.FlockerVolumeSource

Represents a Flocker volume mounted by the Flocker agent. Flocker volumes do not support ownership management or SELinux relabeling.

NameDescriptionRequiredSchemaDefault

datasetName

Required: the volume name. This is going to be store on metadata name on the payload for Flocker

true

string

 

2.3.74. v1.GCEPersistentDiskVolumeSource

Represents a Persistent Disk resource in Google Compute Engine.

A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.

NameDescriptionRequiredSchemaDefault

pdName

Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#gcepersistentdisk

true

string

 

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#gcepersistentdisk

false

string

 

partition

The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#gcepersistentdisk

false

integer (int32)

 

readOnly

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#gcepersistentdisk

false

boolean

 

2.3.75. v1.GitBuildSource

GitBuildSource defines the parameters of a Git SCM

NameDescriptionRequiredSchemaDefault

uri

URI points to the source that will be built. The structure of the source will depend on the type of build to run

true

string

 

ref

Ref is the branch/tag/ref to build.

false

string

 

httpProxy

HTTPProxy is a proxy used to reach the git repository over http

false

string

 

httpsProxy

HTTPSProxy is a proxy used to reach the git repository over https

false

string

 

2.3.76. v1.GitRepoVolumeSource

Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.

NameDescriptionRequiredSchemaDefault

repository

Repository URL

true

string

 

revision

Commit hash for the specified revision.

false

string

 

directory

Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.

false

string

 

2.3.77. v1.GitSourceRevision

GitSourceRevision is the commit information from a git source for a build

NameDescriptionRequiredSchemaDefault

commit

Commit is the commit hash identifying a specific commit

false

string

 

author

Author is the author of a specific commit

false

Section 2.3.179, “v1.SourceControlUser”

 

committer

Committer is the committer of a specific commit

false

Section 2.3.179, “v1.SourceControlUser”

 

message

Message is the description of a specific commit

false

string

 

2.3.78. v1.GlusterfsVolumeSource

Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.

NameDescriptionRequiredSchemaDefault

endpoints

EndpointsName is the endpoint name that details Glusterfs topology. More info: http://releases.k8s.io/release-1.2/examples/glusterfs/README.md#create-a-pod

true

string

 

path

Path is the Glusterfs volume path. More info: http://releases.k8s.io/release-1.2/examples/glusterfs/README.md#create-a-pod

true

string

 

readOnly

ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/release-1.2/examples/glusterfs/README.md#create-a-pod

false

boolean

 

2.3.79. v1.Group

Group represents a referenceable set of Users

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

users

Users is the list of users in this group.

true

string array

 

2.3.80. v1.GroupList

GroupList is a collection of Groups

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.5, “unversioned.ListMeta”

 

items

Items is the list of groups

true

Section 2.3.79, “v1.Group” array

 

2.3.81. v1.HTTPGetAction

HTTPGetAction describes an action based on HTTP Get requests.

NameDescriptionRequiredSchemaDefault

path

Path to access on the HTTP server.

false

string

 

port

Name or number 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

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

false

string

 

scheme

Scheme to use for connecting to the host. Defaults to HTTP.

false

string

 

httpHeaders

Custom headers to set in the request. HTTP allows repeated headers.

false

Section 2.3.82, “v1.HTTPHeader” array

 

2.3.82. v1.HTTPHeader

HTTPHeader describes a custom header to be used in HTTP probes

NameDescriptionRequiredSchemaDefault

name

The header field name

true

string

 

value

The header field value

true

string

 

2.3.83. v1.Handler

Handler defines a specific action that should be taken

NameDescriptionRequiredSchemaDefault

exec

One and only one of the following should be specified. Exec specifies the action to take.

false

Section 2.3.68, “v1.ExecAction”

 

httpGet

HTTPGet specifies the http request to perform.

false

Section 2.3.81, “v1.HTTPGetAction”

 

tcpSocket

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

false

Section 2.3.182, “v1.TCPSocketAction”

 

2.3.84. v1.HostPathVolumeSource

Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.

NameDescriptionRequiredSchemaDefault

path

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

true

string

 

2.3.85. v1.HostSubnet

HostSubnet encapsulates the inputs needed to define the container subnet network on a node

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

host

Host is the name of the host that is registered at the master. May just be an IP address, resolvable hostname or a complete DNS. A lease will be sought after this name.

true

string

 

hostIP

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

true

string

 

subnet

Subnet is the actual subnet CIDR lease assigned to the host

true

string

 

2.3.86. v1.HostSubnetList

HostSubnetList is a collection of HostSubnets

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.5, “unversioned.ListMeta”

 

items

Items is the list of host subnets

true

Section 2.3.85, “v1.HostSubnet” array

 

2.3.87. v1.ISCSIVolumeSource

Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.

NameDescriptionRequiredSchemaDefault

targetPortal

iSCSI target portal. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).

true

string

 

iqn

Target iSCSI Qualified Name.

true

string

 

lun

iSCSI target lun number.

true

integer (int32)

 

iscsiInterface

Optional: Defaults to 'default' (tcp). iSCSI interface name that uses an iSCSI transport.

false

string

 

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#iscsi

false

string

 

readOnly

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.

false

boolean

 

2.3.88. v1.Identity

Identity records a successful authentication of a user with an identity provider

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

providerName

ProviderName is the source of identity information

true

string

 

providerUserName

ProviderUserName uniquely represents this identity in the scope of the provider

true

string

 

user

User is a reference to the user this identity is associated with Both Name and UID must be set

true

Section 2.3.135, “v1.ObjectReference”

 

extra

Extra holds extra information about this identity

false

Section 2.3.200, “any”

 

2.3.89. v1.IdentityList

IdentityList is a collection of Identities

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.5, “unversioned.ListMeta”

 

items

Items is the list of identities

true

Section 2.3.88, “v1.Identity” array

 

2.3.90. v1.Image

Image is an immutable representation of a Docker image and metadata at a point in time.

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

dockerImageReference

DockerImageReference is the string that can be used to pull this image.

false

string

 

dockerImageMetadata

DockerImageMetadata contains metadata about this image

false

string

 

dockerImageMetadataVersion

DockerImageMetadataVersion conveys the version of the object, which if empty defaults to "1.0"

false

string

 

dockerImageManifest

DockerImageManifest is the raw JSON of the manifest

false

string

 

dockerImageLayers

DockerImageLayers represents the layers in the image. May not be set if the image does not define that data.

true

Section 2.3.94, “v1.ImageLayer” array

 

2.3.91. v1.ImageChangeTrigger

ImageChangeTrigger allows builds to be triggered when an ImageStream changes

NameDescriptionRequiredSchemaDefault

lastTriggeredImageID

LastTriggeredImageID is used internally by the ImageChangeController to save last used image ID for build

false

string

 

from

From is a reference to an ImageStreamTag that will trigger a build when updated It is optional. If no From is specified, the From image from the build strategy will be used. Only one ImageChangeTrigger with an empty From reference is allowed in a build configuration.

false

Section 2.3.135, “v1.ObjectReference”

 

2.3.92. v1.ImageImportSpec

ImageImportSpec describes a request to import a specific image.

NameDescriptionRequiredSchemaDefault

from

From is the source of an image to import; only kind DockerImage is allowed

true

Section 2.3.135, “v1.ObjectReference”

 

to

To is a tag in the current image stream to assign the imported image to, if name is not specified the default tag from from.name will be used

false

Section 2.3.112, “v1.LocalObjectReference”

 

importPolicy

ImportPolicy is the policy controlling how the image is imported

false

Section 2.3.187, “v1.TagImportPolicy”

 

includeManifest

IncludeManifest determines if the manifest for each image is returned in the response

false

boolean

 

2.3.93. v1.ImageImportStatus

ImageImportStatus describes the result of an image import.

NameDescriptionRequiredSchemaDefault

status

Status is the status of the image import, including errors encountered while retrieving the image

true

Section 2.3.7, “unversioned.Status”

 

image

Image is the metadata of that image, if the image was located

false

Section 2.3.90, “v1.Image”

 

tag

Tag is the tag this image was located under, if any

false

string

 

2.3.94. v1.ImageLayer

ImageLayer represents a single layer of the image. Some images may have multiple layers. Some may have none.

NameDescriptionRequiredSchemaDefault

name

Name of the layer as defined by the underlying store.

true

string

 

size

Size of the layer as defined by the underlying store.

true

integer (int64)

 

2.3.95. v1.ImageList

ImageList is a list of Image objects.

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.5, “unversioned.ListMeta”

 

items

Items is a list of images

true

Section 2.3.90, “v1.Image” array

 

2.3.96. v1.ImageSource

ImageSource is used to describe build source that will be extracted from an image. A reference of
type ImageStreamTag, ImageStreamImage or DockerImage may be used. A pull secret can be specified
to pull the image from an external registry or override the default service account secret if pulling
from the internal registry. A list of paths to copy from the image and their respective destination
within the build directory must be specified in the paths array.

EXPERIMENTAL. This will be changing to an array of images in the near future and no migration/compatibility
will be provided. Use at your own risk.

NameDescriptionRequiredSchemaDefault

from

From is a reference to an ImageStreamTag, ImageStreamImage, or DockerImage to copy source from.

true

Section 2.3.135, “v1.ObjectReference”

 

paths

Paths is a list of source and destination paths to copy from the image.

true

Section 2.3.97, “v1.ImageSourcePath” array

 

pullSecret

PullSecret is a reference to a secret to be used to pull the image from a registry If the image is pulled from the OpenShift Enterprise registry, this field does not need to be set.

false

Section 2.3.112, “v1.LocalObjectReference”

 

2.3.97. v1.ImageSourcePath

ImageSourcePath specifies the absolute path of a file or directory within a source image
to be copied to a relative directory of the build home. If a source directory is specified, all
files and directories under that directory are copied from the image.

NameDescriptionRequiredSchemaDefault

sourcePath

SourcePath is the absolute path of the file or directory inside the image to copy to the build directory.

true

string

 

destinationDir

DestinationDir is the relative directory within the build directory where files copied from the image are placed.

true

string

 

2.3.98. v1.ImageStream

ImageStream stores a mapping of tags to images, metadata overrides that are applied when images are tagged in a stream, and an optional reference to a Docker image repository on a registry.

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

spec

Spec describes the desired state of this stream

true

Section 2.3.105, “v1.ImageStreamSpec”

 

status

Status describes the current state of this stream

false

Section 2.3.106, “v1.ImageStreamStatus”

 

2.3.99. v1.ImageStreamImage

ImageStreamImage represents an Image that is retrieved by image name from an ImageStream.

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

image

Image associated with the ImageStream and image name.

true

Section 2.3.90, “v1.Image”

 

2.3.100. v1.ImageStreamImport

The image stream import resource provides an easy way for a user to find and import Docker images from other Docker registries into the server. Individual images or an entire image repository may be imported, and users may choose to see the results of the import prior to tagging the resulting images into the specified image stream.

This API is intended for end-user tools that need to see the metadata of the image prior to import (for instance, to generate an application from it). Clients that know the desired image can continue to create spec.tags directly into their image streams.

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

spec

Spec is a description of the images that the user wishes to import

true

Section 2.3.101, “v1.ImageStreamImportSpec”

 

status

Status is the the result of importing the image

true

Section 2.3.102, “v1.ImageStreamImportStatus”

 

2.3.101. v1.ImageStreamImportSpec

ImageStreamImportSpec defines what images should be imported.

NameDescriptionRequiredSchemaDefault

import

Import indicates whether to perform an import - if so, the specified tags are set on the spec and status of the image stream defined by the type meta.

true

boolean

 

repository

Repository is an optional import of an entire Docker image repository. A maximum limit on the number of tags imported this way is imposed by the server.

false

Section 2.3.154, “v1.RepositoryImportSpec”

 

images

Images are a list of individual images to import.

false

Section 2.3.92, “v1.ImageImportSpec” array

 

2.3.102. v1.ImageStreamImportStatus

ImageStreamImportStatus contains information about the status of an image stream import.

NameDescriptionRequiredSchemaDefault

import

Import is the image stream that was successfully updated or created when 'to' was set.

false

Section 2.3.98, “v1.ImageStream”

 

repository

Repository is set if spec.repository was set to the outcome of the import

false

Section 2.3.155, “v1.RepositoryImportStatus”

 

images

Images is set with the result of importing spec.images

false

Section 2.3.93, “v1.ImageImportStatus” array

 

2.3.103. v1.ImageStreamList

ImageStreamList is a list of ImageStream objects.

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.5, “unversioned.ListMeta”

 

items

Items is a list of imageStreams

true

Section 2.3.98, “v1.ImageStream” array

 

2.3.104. v1.ImageStreamMapping

ImageStreamMapping represents a mapping from a single tag to a Docker image as well as the reference to the Docker image stream the image came from.

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

image

Image is a Docker image.

true

Section 2.3.90, “v1.Image”

 

tag

Tag is a string value this image can be located with inside the stream.

true

string

 

2.3.105. v1.ImageStreamSpec

ImageStreamSpec represents options for ImageStreams.

NameDescriptionRequiredSchemaDefault

dockerImageRepository

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

false

string

 

tags

Tags map arbitrary string values to specific image locators

false

Section 2.3.188, “v1.TagReference” array

 

2.3.106. v1.ImageStreamStatus

ImageStreamStatus contains information about the state of this image stream.

NameDescriptionRequiredSchemaDefault

dockerImageRepository

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

Tags are a historical record of images associated with each tag. The first entry in the TagEvent array is the currently tagged image.

false

Section 2.3.122, “v1.NamedTagEventList” array

 

2.3.107. v1.ImageStreamTag

ImageStreamTag represents an Image that is retrieved by tag name from an ImageStream.

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

tag

Tag is the spec tag associated with this image stream tag, and it may be null if only pushes have occured to this image stream.

true

Section 2.3.188, “v1.TagReference”

 

generation

Generation is the current generation of the tagged image - if tag is provided and this value is not equal to the tag generation, a user has requested an import that has not completed, or Conditions will be filled out indicating any error.

true

integer (int64)

 

conditions

Conditions is an array of conditions that apply to the image stream tag.

false

Section 2.3.185, “v1.TagEventCondition” array

 

image

Image associated with the ImageStream and tag.

true

Section 2.3.90, “v1.Image”

 

2.3.108. v1.ImageStreamTagList

ImageStreamTagList is a list of ImageStreamTag objects.

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.5, “unversioned.ListMeta”

 

items

Items is the list of image stream tags

true

Section 2.3.107, “v1.ImageStreamTag” array

 

2.3.109. v1.KeyToPath

Maps a string key to a path within a volume.

NameDescriptionRequiredSchemaDefault

key

The key to project.

true

string

 

path

The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

true

string

 

2.3.110. v1.Lifecycle

Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.

NameDescriptionRequiredSchemaDefault

postStart

PostStart is called immediately after a container is created. 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. More info: http://releases.k8s.io/release-1.2/docs/user-guide/container-environment.md#hook-details

false

Section 2.3.83, “v1.Handler”

 

preStop

PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: http://releases.k8s.io/release-1.2/docs/user-guide/container-environment.md#hook-details

false

Section 2.3.83, “v1.Handler”

 

2.3.111. v1.LifecycleHook

LifecycleHook defines a specific deployment lifecycle action. Only one type of action may be specified at any time.

NameDescriptionRequiredSchemaDefault

failurePolicy

FailurePolicy specifies what action to take if the hook fails.

true

string

 

execNewPod

ExecNewPod specifies the options for a lifecycle hook backed by a pod.

false

Section 2.3.69, “v1.ExecNewPodHook”

 

tagImages

TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag.

false

Section 2.3.186, “v1.TagImageHook” array

 

2.3.112. v1.LocalObjectReference

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

NameDescriptionRequiredSchemaDefault

name

Name of the referent. More info: http://releases.k8s.io/release-1.2/docs/user-guide/identifiers.md#names

false

string

 

2.3.113. 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 is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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

false

string

 

namespace

Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces

true

string

 

verb

Verb is one of: get, list, watch, create, update, delete

true

string

 

resourceAPIGroup

Group is the API group of the resource Serialized as resourceAPIGroup to avoid confusion with the 'groups' field when inlined

true

string

 

resourceAPIVersion

Version is the API version of the resource Serialized as resourceAPIVersion to avoid confusion with TypeMeta.apiVersion and ObjectMeta.resourceVersion when inlined

true

string

 

resource

Resource is one of the existing resource types

true

string

 

resourceName

ResourceName is the name of the resource being requested for a "get" or deleted for a "delete"

true

string

 

content

Content is the actual content of the request for create and update

false

string

 

2.3.114. 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 is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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

false

string

 

namespace

Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces

true

string

 

verb

Verb is one of: get, list, watch, create, update, delete

true

string

 

resourceAPIGroup

Group is the API group of the resource Serialized as resourceAPIGroup to avoid confusion with the 'groups' field when inlined

true

string

 

resourceAPIVersion

Version is the API version of the resource Serialized as resourceAPIVersion to avoid confusion with TypeMeta.apiVersion and ObjectMeta.resourceVersion when inlined

true

string

 

resource

Resource is one of the existing resource types

true

string

 

resourceName

ResourceName is the name of the resource being requested for a "get" or deleted for a "delete"

true

string

 

content

Content is the actual content of the request for create and update

false

string

 

user

User is optional. If both User and Groups are empty, the current authenticated user is used.

true

string

 

groups

Groups is optional. Groups is the list of groups to which the User belongs.

true

string array

 

2.3.115. v1.MetadataFile

MetadataFile expresses information about a file holding pod metadata. NOTE: Deprecated in favor of DownwardAPIVolumeFile

NameDescriptionRequiredSchemaDefault

name

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.133, “v1.ObjectFieldSelector”

 

2.3.116. v1.MetadataVolumeSource

MetadataVolumeSource represents a volume containing metadata about a pod. NOTE: Deprecated in favor of DownwardAPIVolumeSource

NameDescriptionRequiredSchemaDefault

items

Items is a list of metadata file name

false

Section 2.3.115, “v1.MetadataFile” array

 

2.3.117. v1.NFSVolumeSource

Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.

NameDescriptionRequiredSchemaDefault

server

Server is the hostname or IP address of the NFS server. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#nfs

true

string

 

path

Path that is exported by the NFS server. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#nfs

true

string

 

readOnly

ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#nfs

false

boolean

 

2.3.118. v1.NamedClusterRole

NamedClusterRole relates a name with a cluster role

NameDescriptionRequiredSchemaDefault

name

Name is the name of the cluster role

true

string

 

role

Role is the cluster role being named

true

Section 2.3.38, “v1.ClusterRole”

 

2.3.119. v1.NamedClusterRoleBinding

NamedClusterRoleBinding relates a name with a cluster role binding

NameDescriptionRequiredSchemaDefault

name

Name is the name of the cluster role binding

true

string

 

roleBinding

RoleBinding is the cluster role binding being named

true

Section 2.3.39, “v1.ClusterRoleBinding”

 

2.3.120. v1.NamedRole

NamedRole relates a Role with a name

NameDescriptionRequiredSchemaDefault

name

Name is the name of the role

true

string

 

role

Role is the role being named

true

Section 2.3.158, “v1.Role”

 

2.3.121. v1.NamedRoleBinding

NamedRoleBinding relates a role binding with a name

NameDescriptionRequiredSchemaDefault

name

Name is the name of the role binding

true

string

 

roleBinding

RoleBinding is the role binding being named

true

Section 2.3.159, “v1.RoleBinding”

 

2.3.122. v1.NamedTagEventList

NamedTagEventList relates a tag to its image history.

NameDescriptionRequiredSchemaDefault

tag

Tag is the tag for which the history is recorded

true

string

 

items

Standard object’s metadata.

true

Section 2.3.184, “v1.TagEvent” array

 

conditions

Conditions is an array of conditions that apply to the tag event list.

false

Section 2.3.185, “v1.TagEventCondition” array

 

2.3.123. 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 plug-in ensures network layer isolation of traffic from other NetNamespaces.

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

netname

NetName is the name of the network namespace

true

string

 

netid

NetID is the network identifier of the network namespace assigned to each overlay network packet

true

integer

 

2.3.124. v1.NetNamespaceList

NetNamespaceList represents a list of NetNamespace objects. NetNamespace catpures 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 plug-in ensures network layer isolation of traffic from other NetNamespaces.

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.5, “unversioned.ListMeta”

 

items

Items is the list of net namespaces

true

Section 2.3.123, “v1.NetNamespace” array

 

2.3.125. v1.OAuthAccessToken

OAuthAccessToken describes an OAuth access token

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

clientName

ClientName references the client that created this token.

false

string

 

expiresIn

ExpiresIn is the seconds from CreationTime before this token expires.

false

integer (int64)

 

scopes

Scopes is an array of the requested scopes.

false

string array

 

redirectURI

RedirectURI is the redirection associated with the token.

false

string

 

userName

UserName is the user name associated with this token

false

string

 

userUID

UserUID is the unique UID associated with this token

false

string

 

authorizeToken

AuthorizeToken contains the token that authorized this token

false

string

 

refreshToken

RefreshToken is the value by which this token can be renewed. Can be blank.

false

string

 

2.3.126. v1.OAuthAccessTokenList

OAuthAccessTokenList is a collection of OAuth access tokens

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.5, “unversioned.ListMeta”

 

items

Items is the list of OAuth access tokens

true

Section 2.3.125, “v1.OAuthAccessToken” array

 

2.3.127. v1.OAuthAuthorizeToken

OAuthAuthorizeToken describes an OAuth authorization token

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

clientName

ClientName references the client that created this token.

false

string

 

expiresIn

ExpiresIn is the seconds from CreationTime before this token expires.

false

integer (int64)

 

scopes

Scopes is an array of the requested scopes.

false

string array

 

redirectURI

RedirectURI is the redirection associated with the token.

false

string

 

state

State data from request

false

string

 

userName

UserName is the user name associated with this token

false

string

 

userUID

UserUID is the unique UID associated with this token. UserUID and UserName must both match for this token to be valid.

false

string

 

2.3.128. v1.OAuthAuthorizeTokenList

OAuthAuthorizeTokenList is a collection of OAuth authorization tokens

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.5, “unversioned.ListMeta”

 

items

Items is the list of OAuth authorization tokens

true

Section 2.3.127, “v1.OAuthAuthorizeToken” array

 

2.3.129. v1.OAuthClient

OAuthClient describes an OAuth client

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

secret

Secret is the unique secret associated with a client

false

string

 

respondWithChallenges

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

false

boolean

 

redirectURIs

RedirectURIs is the valid redirection URIs associated with a client

false

string array

 

2.3.130. v1.OAuthClientAuthorization

OAuthClientAuthorization describes an authorization created by an OAuth client

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

clientName

ClientName references the client that created this authorization

false

string

 

userName

UserName is the user name that authorized this client

false

string

 

userUID

UserUID is the unique UID associated with this authorization. UserUID and UserName must both match for this authorization to be valid.

false

string

 

scopes

Scopes is an array of the granted scopes.

false

string array

 

2.3.131. v1.OAuthClientAuthorizationList

OAuthClientAuthorizationList is a collection of OAuth client authorizations

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.5, “unversioned.ListMeta”

 

items

Items is the list of OAuth client authorizations

true

Section 2.3.130, “v1.OAuthClientAuthorization” array

 

2.3.132. v1.OAuthClientList

OAuthClientList is a collection of OAuth clients

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.5, “unversioned.ListMeta”

 

items

Items is the list of OAuth clients

true

Section 2.3.129, “v1.OAuthClient” array

 

2.3.133. v1.ObjectFieldSelector

ObjectFieldSelector selects an APIVersioned field of an object.

NameDescriptionRequiredSchemaDefault

apiVersion

Version of the schema the 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.134. v1.ObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

NameDescriptionRequiredSchemaDefault

name

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://releases.k8s.io/release-1.2/docs/user-guide/identifiers.md#names

false

string

 

generateName

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

Applied only if Name is not specified. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#idempotency

false

string

 

namespace

Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: http://releases.k8s.io/release-1.2/docs/user-guide/namespaces.md

false

string

 

selfLink

SelfLink is a URL representing this object. Populated by the system. Read-only.

false

string

 

uid

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.2/docs/user-guide/identifiers.md#uids

false

string

 

resourceVersion

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: http://releases.k8s.io/release-1.2/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

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#metadata

false

string

 

deletionTimestamp

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#metadata

false

string

 

deletionGracePeriodSeconds

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

false

integer (int64)

 

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://releases.k8s.io/release-1.2/docs/user-guide/labels.md

false

Section 2.3.200, “any”

 

annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://releases.k8s.io/release-1.2/docs/user-guide/annotations.md

false

Section 2.3.200, “any”

 

2.3.135. v1.ObjectReference

ObjectReference contains enough information to let you inspect or modify the referred object.

NameDescriptionRequiredSchemaDefault

kind

Kind of the referent. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#types-kinds

false

string

 

namespace

Namespace of the referent. More info: http://releases.k8s.io/release-1.2/docs/user-guide/namespaces.md

false

string

 

name

Name of the referent. More info: http://releases.k8s.io/release-1.2/docs/user-guide/identifiers.md#names

false

string

 

uid

UID of the referent. More info: http://releases.k8s.io/release-1.2/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. More info: http://releases.k8s.io/release-1.2/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]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.

false

string

 

2.3.136. v1.Parameter

Parameter defines a name/value variable that is to be processed during the Template to Config transformation.

NameDescriptionRequiredSchemaDefault

name

Name must be set and it can be referenced in Template Items using ${PARAMETER_NAME}. Required.

true

string

 

displayName

Optional: The name that will show in UI instead of parameter 'Name'

false

string

 

description

Description of a parameter. Optional.

false

string

 

value

Value holds the Parameter data. If specified, the generator will be ignored. The value replaces all occurrences of the Parameter ${Name} expression during the Template to Config transformation. Optional.

false

string

 

generate

Generate specifies the generator to be used to generate random string from an input value specified by From field. The result string is stored into Value field. If empty, no generator is being used, leaving the result Value untouched. Optional.

false

string

 

from

From is an input value for the generator. Optional.

false

string

 

required

Optional: Indicates the parameter must have a value. Defaults to false.

false

boolean

 

2.3.137. v1.PersistentVolumeClaimVolumeSource

PersistentVolumeClaimVolumeSource references the user’s PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).

NameDescriptionRequiredSchemaDefault

claimName

ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: http://releases.k8s.io/release-1.2/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

true

string

 

readOnly

Will force the ReadOnly setting in VolumeMounts. Default false.

false

boolean

 

2.3.138. v1.PodSecurityContext

PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.

NameDescriptionRequiredSchemaDefault

seLinuxOptions

The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

false

Section 2.3.170, “v1.SELinuxOptions”

 

runAsUser

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

false

integer (int64)

 

runAsNonRoot

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

boolean

 

supplementalGroups

A list of groups applied to the first process run in each container, in addition to the container’s primary GID. If unspecified, no groups will be added to any container.

false

Section 2.3.1, “integer” array

 

fsGroup

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:

1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR’d with rw-rw

false

integer (int64)

 

2.3.139. v1.PodSpec

PodSpec is a description of a pod.

NameDescriptionRequiredSchemaDefault

volumes

List of volumes that can be mounted by containers belonging to the pod. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md

false

Section 2.3.194, “v1.Volume” array

 

containers

List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. More info: http://releases.k8s.io/release-1.2/docs/user-guide/containers.md

true

Section 2.3.44, “v1.Container” array

 

restartPolicy

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://releases.k8s.io/release-1.2/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 nil, 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. Defaults to 30 seconds.

false

integer (int64)

 

activeDeadlineSeconds

Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.

false

integer (int64)

 

dnsPolicy

Set DNS policy for containers within the pod. One of 'ClusterFirst' or 'Default'. Defaults to "ClusterFirst".

false

string

 

nodeSelector

NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: http://releases.k8s.io/release-1.2/docs/user-guide/node-selection/README.md

false

Section 2.3.200, “any”

 

host

A request to schedule this pod onto a specific node Deprecated: Use nodeName instead.

false

string

 

serviceAccountName

ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: http://releases.k8s.io/release-1.2/docs/design/service_accounts.md

false

string

 

serviceAccount

DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.

false

string

 

nodeName

NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.

false

string

 

hostNetwork

Host networking requested for this pod. Use the host’s network namespace. If this option is set, the ports that will be used must be specified. Default to false.

false

boolean

 

hostPID

Use the host’s pid namespace. Optional: Default to false.

false

boolean

 

hostIPC

Use the host’s ipc namespace. Optional: Default to false.

false

boolean

 

securityContext

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

false

Section 2.3.138, “v1.PodSecurityContext”

 

imagePullSecrets

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: http://releases.k8s.io/release-1.2/docs/user-guide/images.md#specifying-imagepullsecrets-on-a-pod

false

Section 2.3.112, “v1.LocalObjectReference” array

 

2.3.140. v1.PodTemplateSpec

PodTemplateSpec describes the data a pod should have when created from a template

NameDescriptionRequiredSchemaDefault

metadata

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

false

Section 2.3.134, “v1.ObjectMeta”

 

spec

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

false

Section 2.3.139, “v1.PodSpec”

 

2.3.141. v1.Policy

Policy is a object that holds all the Roles for a particular namespace. There is at most one Policy document per namespace.

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

lastModified

LastModified is the last time that any part of the Policy was created, updated, or deleted

true

string

 

roles

Roles holds all the Roles held by this Policy, mapped by Role.Name

true

Section 2.3.120, “v1.NamedRole” array

 

2.3.142. v1.PolicyBinding

PolicyBinding is a object that holds all the RoleBindings for a particular namespace. There is one PolicyBinding document per referenced Policy namespace

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

lastModified

LastModified is the last time that any part of the PolicyBinding was created, updated, or deleted

true

string

 

policyRef

PolicyRef is a reference to the Policy that contains all the Roles that this PolicyBinding’s RoleBindings may reference

true

Section 2.3.135, “v1.ObjectReference”

 

roleBindings

RoleBindings holds all the RoleBindings held by this PolicyBinding, mapped by RoleBinding.Name

true

Section 2.3.121, “v1.NamedRoleBinding” array

 

2.3.143. v1.PolicyBindingList

PolicyBindingList is a collection of PolicyBindings

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.5, “unversioned.ListMeta”

 

items

Items is a list of PolicyBindings

true

Section 2.3.142, “v1.PolicyBinding” array

 

2.3.144. v1.PolicyList

PolicyList is a collection of Policies

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.5, “unversioned.ListMeta”

 

items

Items is a list of Policies

true

Section 2.3.141, “v1.Policy” array

 

2.3.145. v1.PolicyRule

PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.

NameDescriptionRequiredSchemaDefault

verbs

Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.

true

string array

 

attributeRestrictions

AttributeRestrictions will vary depending on what the Authorizer/AuthorizationAttributeBuilder pair supports. If the Authorizer does not recognize how to handle the AttributeRestrictions, the Authorizer should report an error.

false

string

 

apiGroups

APIGroups is the name of the APIGroup that contains the resources. If this field is empty, then both kubernetes and origin API groups are assumed. That means that if an action is requested against one of the enumerated resources in either the kubernetes or the origin API group, the request will be allowed

true

string array

 

resources

Resources is a list of resources this rule applies to. ResourceAll represents all resources.

true

string array

 

resourceNames

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

false

string array

 

nonResourceURLs

NonResourceURLsSlice is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path This name is intentionally different than the internal type so that the DefaultConvert works nicely and because the ordering may be different.

false

string array

 

2.3.146. v1.Probe

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

NameDescriptionRequiredSchemaDefault

exec

One and only one of the following should be specified. Exec specifies the action to take.

false

Section 2.3.68, “v1.ExecAction”

 

httpGet

HTTPGet specifies the http request to perform.

false

Section 2.3.81, “v1.HTTPGetAction”

 

tcpSocket

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

false

Section 2.3.182, “v1.TCPSocketAction”

 

initialDelaySeconds

Number of seconds after the container has started before liveness probes are initiated. More info: http://releases.k8s.io/release-1.2/docs/user-guide/pod-states.md#container-probes

false

integer (int32)

 

timeoutSeconds

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: http://releases.k8s.io/release-1.2/docs/user-guide/pod-states.md#container-probes

false

integer (int32)

 

periodSeconds

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

false

integer (int32)

 

successThreshold

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

false

integer (int32)

 

failureThreshold

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

false

integer (int32)

 

2.3.147. v1.Project

Projects are the unit of isolation and collaboration in OpenShift Enterprise. 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 is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

spec

Spec defines the behavior of the Namespace.

false

Section 2.3.150, “v1.ProjectSpec”

 

status

Status describes the current status of a Namespace

false

Section 2.3.151, “v1.ProjectStatus”

 

2.3.148. v1.ProjectList

ProjectList is a list of Project objects.

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.5, “unversioned.ListMeta”

 

items

Items is the list of projects

true

Section 2.3.147, “v1.Project” array

 

2.3.149. v1.ProjectRequest

ProjecRequest is the set of options necessary to fully qualify a project request

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

true

string

 

metadata

Standard object’s metadata.

subfield name

Section 2.3.134, “v1.ObjectMeta”

 

displayName

DisplayName is the display name to apply to a project

false

string

 

description

Description is the description to apply to a project

false

string

 

2.3.150. v1.ProjectSpec

ProjectSpec describes the attributes on a Project

NameDescriptionRequiredSchemaDefault

finalizers

Finalizers is an opaque list of values that must be empty to permanently remove object from storage

false

Section 2.3.71, “v1.FinalizerName” array

 

2.3.151. v1.ProjectStatus

ProjectStatus is information about the current status of a Project

NameDescriptionRequiredSchemaDefault

phase

Phase is the current lifecycle phase of the project

false

string

 

2.3.152. v1.RBDVolumeSource

Represents a Ceph Rados Block Device mount that lasts the lifetime of a pod. Ceph RBD volumes support ownership management and SELinux relabeling.

NameDescriptionRequiredSchemaDefault

monitors

A collection of Ceph monitors. More info: http://releases.k8s.io/release-1.2/examples/rbd/README.md#how-to-use-it

true

string array

 

image

The rados image name. More info: http://releases.k8s.io/release-1.2/examples/rbd/README.md#how-to-use-it

true

string

 

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#rbd

false

string

 

pool

The rados pool name. Default is rbd. More info: http://releases.k8s.io/release-1.2/examples/rbd/README.md#how-to-use-it.

true

string

 

user

The rados user name. Default is admin. More info: http://releases.k8s.io/release-1.2/examples/rbd/README.md#how-to-use-it

true

string

 

keyring

Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: http://releases.k8s.io/release-1.2/examples/rbd/README.md#how-to-use-it

true

string

 

secretRef

SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is empty. More info: http://releases.k8s.io/release-1.2/examples/rbd/README.md#how-to-use-it

true

Section 2.3.112, “v1.LocalObjectReference”

 

readOnly

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/release-1.2/examples/rbd/README.md#how-to-use-it

false

boolean

 

2.3.153. v1.RecreateDeploymentStrategyParams

RecreateDeploymentStrategyParams are the input to the Recreate deployment strategy.

NameDescriptionRequiredSchemaDefault

timeoutSeconds

TimeoutSeconds is the time to wait for updates before giving up. If the value is nil, a default will be used.

false

integer (int64)

 

pre

Pre is a lifecycle hook which is executed before the strategy manipulates the deployment. All LifecycleHookFailurePolicy values are supported.

false

Section 2.3.111, “v1.LifecycleHook”

 

mid

Mid is a lifecycle hook which is executed while the deployment is scaled down to zero before the first new pod is created. All LifecycleHookFailurePolicy values are supported.

false

Section 2.3.111, “v1.LifecycleHook”

 

post

Post is a lifecycle hook which is executed after the strategy has finished all deployment logic. All LifecycleHookFailurePolicy values are supported.

false

Section 2.3.111, “v1.LifecycleHook”

 

2.3.154. v1.RepositoryImportSpec

RepositoryImportSpec describes a request to import images from a Docker image repository.

NameDescriptionRequiredSchemaDefault

from

From is the source for the image repository to import; only kind DockerImage and a name of a Docker image repository is allowed

true

Section 2.3.135, “v1.ObjectReference”

 

importPolicy

ImportPolicy is the policy controlling how the image is imported

false

Section 2.3.187, “v1.TagImportPolicy”

 

includeManifest

IncludeManifest determines if the manifest for each image is returned in the response

false

boolean

 

2.3.155. v1.RepositoryImportStatus

RepositoryImportStatus describes the result of an image repository import

NameDescriptionRequiredSchemaDefault

status

Status reflects whether any failure occurred during import

false

Section 2.3.7, “unversioned.Status”

 

images

Images is a list of images successfully retrieved by the import of the repository.

false

Section 2.3.93, “v1.ImageImportStatus” array

 

additionalTags

AdditionalTags are tags that exist in the repository but were not imported because a maximum limit of automatic imports was applied.

false

string array

 

2.3.156. v1.ResourceAccessReview

ResourceAccessReview is a means to request a list of which users and groups are authorized to perform the action specified by spec

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

namespace

Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces

true

string

 

verb

Verb is one of: get, list, watch, create, update, delete

true

string

 

resourceAPIGroup

Group is the API group of the resource Serialized as resourceAPIGroup to avoid confusion with the 'groups' field when inlined

true

string

 

resourceAPIVersion

Version is the API version of the resource Serialized as resourceAPIVersion to avoid confusion with TypeMeta.apiVersion and ObjectMeta.resourceVersion when inlined

true

string

 

resource

Resource is one of the existing resource types

true

string

 

resourceName

ResourceName is the name of the resource being requested for a "get" or deleted for a "delete"

true

string

 

content

Content is the actual content of the request for create and update

false

string

 

2.3.157. v1.ResourceRequirements

ResourceRequirements describes the compute resource requirements.

NameDescriptionRequiredSchemaDefault

limits

Limits describes the maximum amount of compute resources allowed. More info: http://releases.k8s.io/release-1.2/docs/design/resources.md#resource-specifications

false

Section 2.3.200, “any”

 

requests

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: http://releases.k8s.io/release-1.2/docs/design/resources.md#resource-specifications

false

Section 2.3.200, “any”

 

2.3.158. v1.Role

Role is a logical grouping of PolicyRules that can be referenced as a unit by RoleBindings.

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

rules

Rules holds all the PolicyRules for this Role

true

Section 2.3.145, “v1.PolicyRule” array

 

2.3.159. v1.RoleBinding

RoleBinding references a Role, but not contain it. It can reference any Role in the same namespace or in the global namespace. It adds who information via Users and Groups and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace (excepting the master namespace which has power in all namespaces).

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

userNames

UserNames holds all the usernames directly bound to the role

true

string array

 

groupNames

GroupNames holds all the groups directly bound to the role

true

string array

 

subjects

Subjects hold object references to authorize with this rule

true

Section 2.3.135, “v1.ObjectReference” array

 

roleRef

RoleRef can only reference the current namespace and the global namespace If the RoleRef cannot be resolved, the Authorizer must return an error. Since Policy is a singleton, this is sufficient knowledge to locate a role

true

Section 2.3.135, “v1.ObjectReference”

 

2.3.160. v1.RoleBindingList

RoleBindingList is a collection of RoleBindings

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.5, “unversioned.ListMeta”

 

items

Items is a list of RoleBindings

true

Section 2.3.159, “v1.RoleBinding” array

 

2.3.161. v1.RoleList

RoleList is a collection of Roles

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.5, “unversioned.ListMeta”

 

items

Items is a list of Roles

true

Section 2.3.158, “v1.Role” array

 

2.3.162. v1.RollingDeploymentStrategyParams

RollingDeploymentStrategyParams are the input to the Rolling deployment strategy.

NameDescriptionRequiredSchemaDefault

updatePeriodSeconds

UpdatePeriodSeconds is the time to wait between individual pod updates. If the value is nil, a default will be used.

false

integer (int64)

 

intervalSeconds

IntervalSeconds is the time to wait between polling deployment status after update. If the value is nil, a default will be used.

false

integer (int64)

 

timeoutSeconds

TimeoutSeconds is the time to wait for updates before giving up. If the value is nil, a default will be used.

false

integer (int64)

 

maxUnavailable

MaxUnavailable is the maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total pods at the start of update (ex: 10%). Absolute number is calculated from percentage by rounding up.

This cannot be 0 if MaxSurge is 0. By default, 25% is used.

Example: when this is set to 30%, the old RC can be scaled down by 30% immediately when the rolling update starts. Once new pods are ready, old RC can be scaled down further, followed by scaling up the new RC, ensuring that at least 70% of original number of pods are available at all times during the update.

false

string

 

maxSurge

MaxSurge is the maximum number of pods that can be scheduled above the original number of pods. Value can be an absolute number (ex: 5) or a percentage of total pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up.

This cannot be 0 if MaxUnavailable is 0. By default, 25% is used.

Example: when this is set to 30%, the new RC can be scaled up by 30% immediately when the rolling update starts. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of original pods.

false

string

 

updatePercent

UpdatePercent is the percentage of replicas to scale up or down each interval. If nil, one replica will be scaled up and down each interval. If negative, the scale order will be down/up instead of up/down. DEPRECATED: Use MaxUnavailable/MaxSurge instead.

false

integer (int32)

 

pre

Pre is a lifecycle hook which is executed before the deployment process begins. All LifecycleHookFailurePolicy values are supported.

false

Section 2.3.111, “v1.LifecycleHook”

 

post

Post is a lifecycle hook which is executed after the strategy has finished all deployment logic. The LifecycleHookFailurePolicyAbort policy is NOT supported.

false

Section 2.3.111, “v1.LifecycleHook”

 

2.3.163. 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 is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

spec

Spec is the desired state of the route

true

Section 2.3.168, “v1.RouteSpec”

 

status

Status is the current state of the route

true

Section 2.3.169, “v1.RouteStatus”

 

2.3.164. v1.RouteIngress

RouteIngress holds information about the places where a route is exposed

NameDescriptionRequiredSchemaDefault

host

Host is the host string under which the route is exposed; this value is required

false

string

 

routerName

Name is a name chosen by the router to identify itself; this value is required

false

string

 

conditions

Conditions is the state of the route, may be empty.

false

Section 2.3.165, “v1.RouteIngressCondition” array

 

2.3.165. v1.RouteIngressCondition

RouteIngressCondition contains details for the current condition of this pod.

NameDescriptionRequiredSchemaDefault

type

Type is the type of the condition. Currently only Ready.

true

string

 

status

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

true

string

 

reason

(brief) reason for the condition’s last transition, and is usually a machine and human readable constant

false

string

 

message

Human readable message indicating details about last transition.

false

string

 

lastTransitionTime

RFC 3339 date and time when this condition last transitioned

false

string

 

2.3.166. v1.RouteList

RouteList is a collection of Routes.

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.5, “unversioned.ListMeta”

 

items

Items is a list of routes

true

Section 2.3.163, “v1.Route” array

 

2.3.167. v1.RoutePort

RoutePort defines a port mapping from a router to an endpoint in the service endpoints.

NameDescriptionRequiredSchemaDefault

targetPort

The target port on pods selected by the service this route points to. If this is a string, it will be looked up as a named port in the target endpoints port list. Required

true

string

 

2.3.168. v1.RouteSpec

RouteSpec describes the route the user wishes to exist.

NameDescriptionRequiredSchemaDefault

host

Host is an alias/DNS that points to the service. Optional Must follow DNS952 subdomain conventions.

true

string

 

path

Path that the router watches for, to route traffic for to the service. Optional

false

string

 

to

To is an object the route points to. Only the Service kind is allowed, and it will be defaulted to Service.

true

Section 2.3.135, “v1.ObjectReference”

 

port

If specified, the port to be used by the router. Most routers will use all endpoints exposed by the service by default - set this value to instruct routers which port to use.

false

Section 2.3.167, “v1.RoutePort”

 

tls

TLS provides the ability to configure certificates and termination for the route

false

Section 2.3.183, “v1.TLSConfig”

 

2.3.169. v1.RouteStatus

RouteStatus provides relevant info about the status of a route, including which routers acknowledge it.

NameDescriptionRequiredSchemaDefault

ingress

Ingress describes the places where the route may be exposed. The list of ingress points may contain duplicate Host or RouterName values. Routes are considered live once they are Ready

true

Section 2.3.164, “v1.RouteIngress” array

 

2.3.170. v1.SELinuxOptions

SELinuxOptions are the labels to be applied to the container

NameDescriptionRequiredSchemaDefault

user

User is a SELinux user label that applies to the container.

false

string

 

role

Role is a SELinux role label that applies to the container.

false

string

 

type

Type is a SELinux type label that applies to the container.

false

string

 

level

Level is SELinux level label that applies to the container.

false

string

 

2.3.171. v1.Secret

Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes.

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

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

false

Section 2.3.134, “v1.ObjectMeta”

 

data

Data contains the secret data. Each key must be a valid DNS_SUBDOMAIN or leading dot followed by valid DNS_SUBDOMAIN. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4

false

Section 2.3.200, “any”

 

type

Used to facilitate programmatic handling of secret data.

false

string

 

2.3.172. v1.SecretBuildSource

SecretBuildSource describes a secret and its destination directory that will be used only at the build time. The content of the secret referenced here will be copied into the destination directory instead of mounting.

NameDescriptionRequiredSchemaDefault

secret

Secret is a reference to an existing secret that you want to use in your build.

true

Section 2.3.112, “v1.LocalObjectReference”

 

destinationDir

DestinationDir is the directory where the files from the secret should be available for the build time. For the Source build strategy, these will be injected into a container where the assemble script runs. Later, when the script finishes, all files injected will be truncated to zero length. For the Docker build strategy, these will be copied into the build directory, where the Dockerfile is located, so users can ADD or COPY them during docker build.

false

string

 

2.3.173. v1.SecretKeySelector

SecretKeySelector selects a key of a Secret.

NameDescriptionRequiredSchemaDefault

name

Name of the referent. More info: http://releases.k8s.io/release-1.2/docs/user-guide/identifiers.md#names

false

string

 

key

The key of the secret to select from. Must be a valid secret key.

true

string

 

2.3.174. v1.SecretList

SecretList is a list of Secret.

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

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

false

Section 2.3.5, “unversioned.ListMeta”

 

items

Items is a list of secret objects. More info: http://releases.k8s.io/release-1.2/docs/user-guide/secrets.md

true

Section 2.3.171, “v1.Secret” array

 

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

SecretSource is a reference to the secret

true

Section 2.3.112, “v1.LocalObjectReference”

 

mountPath

MountPath is the path at which to mount the secret

true

string

 

2.3.176. v1.SecretVolumeSource

Adapts a Secret into a volume.

The contents of the target Secret’s Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.

NameDescriptionRequiredSchemaDefault

secretName

Name of the secret in the pod’s namespace to use. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#secrets

false

string

 

2.3.177. v1.SecurityContext

SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.

NameDescriptionRequiredSchemaDefault

capabilities

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.

false

Section 2.3.28, “v1.Capabilities”

 

privileged

Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.

false

boolean

 

seLinuxOptions

The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

Section 2.3.170, “v1.SELinuxOptions”

 

runAsUser

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

integer (int64)

 

runAsNonRoot

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

boolean

 

readOnlyRootFilesystem

Whether this container has a read-only root filesystem. Default is false.

false

boolean

 

2.3.178. v1.SourceBuildStrategy

SourceBuildStrategy defines input parameters specific to an Source build.

NameDescriptionRequiredSchemaDefault

from

From is reference to an DockerImage, ImageStreamTag, or ImageStreamImage from which the docker image should be pulled

true

Section 2.3.135, “v1.ObjectReference”

 

pullSecret

PullSecret is the name of a Secret that would be used for setting up the authentication for pulling the Docker images from the private Docker registries

false

Section 2.3.112, “v1.LocalObjectReference”

 

env

Env contains additional environment variables you want to pass into a builder container

false

Section 2.3.66, “v1.EnvVar” array

 

scripts

Scripts is the location of Source scripts

false

string

 

incremental

Incremental flag forces the Source build to do incremental builds if true.

false

boolean

 

forcePull

ForcePull describes if the builder should pull the images from registry prior to building.

false

boolean

 

2.3.179. v1.SourceControlUser

SourceControlUser defines the identity of a user of source control

NameDescriptionRequiredSchemaDefault

name

Name of the source control user

false

string

 

email

Email of the source control user

false

string

 

2.3.180. v1.SourceRevision

SourceRevision is the revision or commit information from the source for the build

NameDescriptionRequiredSchemaDefault

type

Type of the build source

true

string

 

git

Git contains information about git-based build source

false

Section 2.3.77, “v1.GitSourceRevision”

 

2.3.181. v1.SubjectAccessReview

SubjectAccessReview is an object for requesting information about whether a user or group can perform an action

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

namespace

Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces

true

string

 

verb

Verb is one of: get, list, watch, create, update, delete

true

string

 

resourceAPIGroup

Group is the API group of the resource Serialized as resourceAPIGroup to avoid confusion with the 'groups' field when inlined

true

string

 

resourceAPIVersion

Version is the API version of the resource Serialized as resourceAPIVersion to avoid confusion with TypeMeta.apiVersion and ObjectMeta.resourceVersion when inlined

true

string

 

resource

Resource is one of the existing resource types

true

string

 

resourceName

ResourceName is the name of the resource being requested for a "get" or deleted for a "delete"

true

string

 

content

Content is the actual content of the request for create and update

false

string

 

user

User is optional. If both User and Groups are empty, the current authenticated user is used.

true

string

 

groups

GroupsSlice is optional. Groups is the list of groups to which the User belongs.

true

string array

 

2.3.182. v1.TCPSocketAction

TCPSocketAction describes an action based on opening a socket

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.183. v1.TLSConfig

TLSConfig defines config used to secure a route and provide termination

NameDescriptionRequiredSchemaDefault

termination

Termination indicates termination type.

true

string

 

certificate

Certificate provides certificate contents

false

string

 

key

Key provides key file contents

false

string

 

caCertificate

CACertificate provides the cert authority certificate contents

false

string

 

destinationCACertificate

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

false

string

 

insecureEdgeTerminationPolicy

InsecureEdgeTerminationPolicy indicates the desired behavior for insecure connections to an edge-terminated route:
disable, allow or redirect

false

string

 

2.3.184. v1.TagEvent

TagEvent is used by ImageStreamStatus to keep a historical record of images associated with a tag.

NameDescriptionRequiredSchemaDefault

created

Created holds the time the TagEvent was created

true

string

 

dockerImageReference

DockerImageReference is the string that can be used to pull this image

true

string

 

image

Image is the image

true

string

 

generation

Generation is the spec tag generation that resulted in this tag being updated

true

integer (int64)

 

2.3.185. v1.TagEventCondition

TagEventCondition contains condition information for a tag event.

NameDescriptionRequiredSchemaDefault

type

Type of tag event condition, currently only ImportSuccess

true

string

 

status

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

true

string

 

lastTransitionTime

LastTransitionTIme is the time the condition transitioned from one status to another.

false

string

 

reason

Reason is a brief machine readable explanation for the condition’s last transition.

false

string

 

message

Message is a human readable description of the details about last transition, complementing reason.

false

string

 

generation

Generation is the spec tag generation that this status corresponds to

true

integer (int64)

 

2.3.186. v1.TagImageHook

TagImageHook is a request to tag the image in a particular container onto an ImageStreamTag.

NameDescriptionRequiredSchemaDefault

containerName

ContainerName is the name of a container in the deployment config whose image value will be used as the source of the tag. If there is only a single container this value will be defaulted to the name of that container.

true

string

 

to

To is the target ImageStreamTag to set the container’s image onto.

true

Section 2.3.135, “v1.ObjectReference”

 

2.3.187. v1.TagImportPolicy

TagImportPolicy describes the tag import policy

NameDescriptionRequiredSchemaDefault

insecure

Insecure is true if the server may bypass certificate verification or connect directly over HTTP during image import.

false

boolean

 

scheduled

Scheduled indicates to the server that this tag should be periodically checked to ensure it is up to date, and imported

false

boolean

 

2.3.188. v1.TagReference

TagReference specifies optional annotations for images using this tag and an optional reference to an ImageStreamTag, ImageStreamImage, or DockerImage this tag should track.

NameDescriptionRequiredSchemaDefault

name

Name of the tag

true

string

 

annotations

Annotations associated with images using this tag

true

Section 2.3.200, “any”

 

from

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

false

Section 2.3.135, “v1.ObjectReference”

 

reference

Reference states if the tag will be imported. Default value is false, which means the tag will be imported.

false

boolean

 

generation

Generation is the image stream generation that updated this tag - setting it to 0 is an indication that the generation must be updated. Legacy clients will send this as nil, which means the client doesn’t know or care.

true

integer (int64)

 

importPolicy

Import is information that controls how images may be imported by the server.

false

Section 2.3.187, “v1.TagImportPolicy”

 

2.3.189. v1.Template

Template contains the inputs needed to produce a Config.

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

objects

Objects is an array of objects to include in this template. Required.

true

Section 2.3.4, “runtime.RawExtension” array

 

parameters

Optional: Parameters is an array of Parameters used during the Template to Config transformation.

false

Section 2.3.136, “v1.Parameter” array

 

labels

Labels is a set of labels that are applied to every object during the Template to Config transformation. Optional

false

Section 2.3.200, “any”

 

2.3.190. v1.TemplateList

TemplateList is a list of Template objects.

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.5, “unversioned.ListMeta”

 

items

Items is a list of templates

true

Section 2.3.189, “v1.Template” array

 

2.3.191. 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 is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

fullName

FullName is the full name of user

false

string

 

identities

Identities are the identities associated with this user

true

string array

 

groups

Groups are the groups that this user is a member of

true

string array

 

2.3.192. v1.UserIdentityMapping

UserIdentityMapping maps a user to an identity

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

identity

Identity is a reference to an identity

false

Section 2.3.135, “v1.ObjectReference”

 

user

User is a reference to a user

false

Section 2.3.135, “v1.ObjectReference”

 

2.3.193. v1.UserList

UserList is a collection of Users

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object’s metadata.

false

Section 2.3.5, “unversioned.ListMeta”

 

items

Items is the list of users

true

Section 2.3.191, “v1.User” array

 

2.3.194. v1.Volume

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

NameDescriptionRequiredSchemaDefault

name

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

true

string

 

hostPath

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

false

Section 2.3.84, “v1.HostPathVolumeSource”

 

emptyDir

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

false

Section 2.3.65, “v1.EmptyDirVolumeSource”

 

gcePersistentDisk

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

false

Section 2.3.74, “v1.GCEPersistentDiskVolumeSource”

 

awsElasticBlockStore

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

false

Section 2.3.10, “v1.AWSElasticBlockStoreVolumeSource”

 

gitRepo

GitRepo represents a git repository at a particular revision.

false

Section 2.3.76, “v1.GitRepoVolumeSource”

 

secret

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

false

Section 2.3.176, “v1.SecretVolumeSource”

 

nfs

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

false

Section 2.3.117, “v1.NFSVolumeSource”

 

iscsi

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

false

Section 2.3.87, “v1.ISCSIVolumeSource”

 

glusterfs

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

false

Section 2.3.78, “v1.GlusterfsVolumeSource”

 

persistentVolumeClaim

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

false

Section 2.3.137, “v1.PersistentVolumeClaimVolumeSource”

 

rbd

A Ceph Rados Block Device mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md

false

Section 2.3.152, “v1.RBDVolumeSource”

 

flexVolume

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.

false

Section 2.3.72, “v1.FlexVolumeSource”

 

cinder

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

false

Section 2.3.31, “v1.CinderVolumeSource”

 

cephfs

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

false

Section 2.3.30, “v1.CephFSVolumeSource”

 

flocker

Flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running

false

Section 2.3.73, “v1.FlockerVolumeSource”

 

downwardAPI

DownwardAPI represents downward API about the pod that should populate this volume

false

Section 2.3.64, “v1.DownwardAPIVolumeSource”

 

fc

FC represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.

false

Section 2.3.70, “v1.FCVolumeSource”

 

azureFile

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

false

Section 2.3.11, “v1.AzureFileVolumeSource”

 

configMap

ConfigMap represents a configMap that should populate this volume

false

Section 2.3.43, “v1.ConfigMapVolumeSource”

 

metadata

Metadata represents metadata about the pod that should populate this volume Deprecated: Use downwardAPI instead.

false

Section 2.3.116, “v1.MetadataVolumeSource”

 

2.3.195. v1.VolumeMount

VolumeMount describes a mounting of a Volume within a container.

NameDescriptionRequiredSchemaDefault

name

This must match the Name of a Volume.

true

string

 

readOnly

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

false

boolean

 

mountPath

Path within the container at which the volume should be mounted. Must not contain ':'.

true

string

 

2.3.196. v1.WebHookTrigger

WebHookTrigger is a trigger that gets invoked using a webhook type of post

NameDescriptionRequiredSchemaDefault

secret

Secret used to validate requests.

false

string

 

2.3.197. v1beta1.Scale

Scale is a subresource representing the current "scale" of certain objects, such as
ReplicationControllers and DeploymentConfigs. It may be checked to determine the current
replica count of these objects, or updated to set the replica count of these objects.

In the case of ReplicationControllers, this directly reflects the scale the ReplicationController.
For DeploymentConfigs, it reflects the scale of the deployment(s), or, if none are present, the
scale of the DeploymentConfig’s template.

NameDescriptionRequiredSchemaDefault

kind

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

false

string

 

apiVersion

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

false

string

 

metadata

Standard object metadata; More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#metadata.

false

Section 2.3.134, “v1.ObjectMeta”

 

spec

defines the behavior of the scale. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#spec-and-status.

false

Section 2.3.198, “v1beta1.ScaleSpec”

 

status

current status of the scale. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#spec-and-status. Read-only.

false

Section 2.3.199, “v1beta1.ScaleStatus”

 

2.3.198. v1beta1.ScaleSpec

describes the attributes of a scale subresource

NameDescriptionRequiredSchemaDefault

replicas

desired number of instances for the scaled object.

false

integer (int32)

 

2.3.199. v1beta1.ScaleStatus

represents the current status of a scale subresource.

NameDescriptionRequiredSchemaDefault

replicas

actual number of observed instances of the scaled object.

true

integer (int32)

 

selector

label query over pods that should match the replicas count. More info: http://releases.k8s.io/release-1.2/docs/user-guide/labels.md#label-selectors

false

Section 2.3.200, “any”

 

targetSelector

label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: http://releases.k8s.io/release-1.2/docs/user-guide/labels.md#label-selectors

false

string

 

2.3.200. any

Represents an untyped JSON map - see the description of the field for more info about the structure of this object.

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.