REST API Reference

OpenShift Container Platform 3.5

OpenShift Container Platform 3.5 REST API for Developers

Red Hat OpenShift Documentation Team

Abstract

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

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

Chapter 1. Overview

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

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

1.1. Authentication

API calls must be authenticated with an access token or X.509 certificate. See Authentication in the Architecture documentation for an overview.

This section highlights the token authentication method. With token authentication, a bearer token must be passed in as an HTTP Authorization header. There are two types of access tokens: session and service account.

1.1.1. Session Tokens

A session token is short-lived, expiring within 24 hours by default. It represents a user. After logging in, the session token may be obtained with the oc whoami command:

$ oc login -u test_user
Using project "test".
$ oc whoami --token
dIAo76N-W-GXK3S_w_KsC6DmH3MzP79zq7jbMQvCOUo

1.1.2. Service Account Tokens

Service account tokens are long-lived tokens. They are JSON Web Token (JWT) formatted tokens and are much longer strings than session tokens. See Using a Service Account’s Credentials Externally for steps on using these tokens to authenticate using the CLI.

A service account token may be obtained with these commands:

Create a service account in the current project (test) named robot:
```
$ oc create serviceaccount robot
serviceaccount "robot" created
```
Grant a role to the service account. In this example, assign the robot service account in the test project the admin role:
```
$ oc policy add-role-to-user admin system:serviceaccounts:test:robot
```

Get the token value:

$ oc serviceaccounts get-token robot
eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJrdWJlcm5ldGVzL3NlcnZpY2VhY2NvdW50Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9uYW1lc3BhY2UiOiJpc3YtY2VydCIsImt1YmVybmV0ZXMuaW8vc2VydmljZWFjY291bnQvc2VjcmV0Lm5hbWUiOiJpbWctYnVpbGQtdG9rZW4teG1rMHciLCJrdWJlcm5ldGVzLmlvL3NlcnZpY2VhY2NvdW50L3NlcnZpY2UtYWNjb3VudC5uYW1lIjoiaW1nLWJ1aWxkIiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9zZXJ2aWNlLWFjY291bnQudWlkIjoiYTJmNzM0NWMtNDA4Zi0xMWU3LTg1NTktMDAxYTRhZTBkZjQ1Iiwic3ViIjoic3lzdGVtOnNlcnZpY2VhY2NvdW50Omlzdi1jZXJ0OmltZy1idWlsZCJ9.Xt5cc9k7fucc7ZAYqt6cz6WvyDhbCZcfHXH-Ow6vStI4Gy7dS3qxIewcXFw8-h1_wkLRUYvyVVYDCRIIbmWL68ybzY2ND8FyuQwCOWP-2_vFvm8xmpjFURZwuNv-eGULNwzOfrSCIelqM2ImCYcM3tpbnyMPeW_KoSI4LGKxXZZqBIcpa9Xb0Zr225uhpZJ2tb_ItuqdOXPUC0GZdHbpbCI0I-Yu-IudCRBHZZ_2SlAi3vbJcvmjpXHfaz49enR602S8ztXF4gXG4_lXa0fS5QYtB0lnIv9q8HXzxKioG_P3O1yD1HqdLYXhZaMNDyg1Xm-5hAkfQ4A7UMPgK4a2zg

The token value may be used in an authorization header to authenticate API calls, the CLI or in the docker login command. Service accounts may be created and deleted as needed with the appropriate role(s) assigned. See Authorization in the Architecture documentation for a deeper discussion on roles.

1.2. Examples

These examples provide a quick reference for making successful REST API calls. They use insecure methods. In these examples, a simple GET call is made to list available resources.

1.2.1. cURL

Example 1.1. Request (Insecure)

$ curl -X GET -H "Authorization: Bearer <token>" https://openshift.redhat.com:8443/oapi/v1 --insecure

Example 1.2. Result (Truncated)

{
  "kind": "APIResourceList",
  "groupVersion": "v1",
  "resources": [
    {
      "name": "buildconfigs",
      "namespaced": true,
      "kind": "BuildConfig"
    },
    {
      "name": "buildconfigs/instantiate",
      "namespaced": true,
      "kind": "BuildRequest"
    },
    {
      "name": "buildconfigs/instantiatebinary",
      "namespaced": true,
      "kind": "BinaryBuildRequestOptions"
    },
    {
      "name": "buildconfigs/webhooks",
      "namespaced": true,
      "kind": "Status"
    },
    {
      "name": "builds",
      "namespaced": true,
      "kind": "Build"
    },
    ...
    {
      "name": "subjectaccessreviews",
      "namespaced": true,
      "kind": "SubjectAccessReview"
    },
    {
      "name": "templates",
      "namespaced": true,
      "kind": "Template"
    },
    {
      "name": "useridentitymappings",
      "namespaced": false,
      "kind": "UserIdentityMapping"
    },
    {
      "name": "users",
      "namespaced": false,
      "kind": "User"
    }
  ]
}

1.2.2. Python

Example 1.3. Interactive Python API Call Using "requests" Module (Insecure)

>>> import requests
>>> url = 'https://openshift.redhat.com:8443/oapi/v1'
>>> headers = {'Authorization': 'Bearer dIAo76N-W-GXK3S_w_KsC6DmH3MzP79zq7jbMQvCOUo'}
>>> requests.get(url, headers=headers, verify=False)
/usr/lib/python2.7/site-packages/requests/packages/urllib3/connectionpool.py:791: InsecureRequestWarning: Unverified HTTPS request is being made. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.org/en/latest/security.html
  InsecureRequestWarning)
<Response [200]>

1.2.3. Docker Login

The OpenShift Container Platform integrated Docker registry must be authenticated using either a user session or service account token. The value of the token must be used as the value for the --password argument. The user and email argument values are ignored:

$ docker login -p <token_value> -u unused -e unused <registry>[:<port>]

1.3. Image Signatures

The OpenShift Container Registry allows the users to manipulate the image signatures using its own API. See Accessing Image Signatures Using Registry API for more information.

1.4. Websockets and Watching for Changes

The API is designed to work via the websocket protocol. API requests may take the form of "one-shot" calls to list resources or by passing in query parameter watch=true. When watching an endpoint, changes to the system may be observed through an open endpoint. Using callbacks, dynamic systems may be developed that integrate with the API.

For more information and examples, see the Mozilla Developer Network page on Writing WebSocket client applications.

Chapter 2. OpenShift Container Platform v1 REST API

2.1. Overview

The OpenShift Container Platform 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. Responses

HTTP Code	Description	Schema
default	success	Section 2.3.5, “unversioned.APIResourceList”

2.2.1.2. Consumes

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

2.2.1.3. Produces

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

2.2.1.4. Tags

oapiv1

2.2.2. list objects of kind AppliedClusterResourceQuota

GET /oapi/v1/appliedclusterresourcequotas

2.2.2.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.2.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.15, “v1.AppliedClusterResourceQuotaList”

2.2.2.3. Consumes

2.2.2.4. Produces

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

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

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 Code	Description	Schema
200	success	Section 2.3.22, “v1.BuildConfigList”

2.2.3.3. Consumes

2.2.3.4. Produces

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

2.2.3.5. Tags

oapiv1

2.2.4. create a BuildConfig

POST /oapi/v1/buildconfigs

2.2.4.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.21, “v1.BuildConfig”

2.2.4.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.21, “v1.BuildConfig”

2.2.4.3. Consumes

2.2.4.4. Produces

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

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

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 Code	Description	Schema
200	success	Section 2.3.25, “v1.BuildList”

2.2.5.3. Consumes

2.2.5.4. Produces

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

2.2.5.5. Tags

oapiv1

2.2.6. create a Build

POST /oapi/v1/builds

2.2.6.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.20, “v1.Build”

2.2.6.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.20, “v1.Build”

2.2.6.3. Consumes

2.2.6.4. Produces

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

2.2.6.5. Tags

oapiv1

2.2.7. delete collection of ClusterNetwork

DELETE /oapi/v1/clusternetworks

2.2.7.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.7.3. Consumes

2.2.7.4. Produces

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

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

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 Code	Description	Schema
200	success	Section 2.3.43, “v1.ClusterNetworkList”

2.2.8.3. Consumes

2.2.8.4. Produces

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

2.2.8.5. Tags

oapiv1

2.2.9. create a ClusterNetwork

POST /oapi/v1/clusternetworks

2.2.9.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.42, “v1.ClusterNetwork”

2.2.9.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.42, “v1.ClusterNetwork”

2.2.9.3. Consumes

2.2.9.4. Produces

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

2.2.9.5. Tags

oapiv1

2.2.10. delete a ClusterNetwork

DELETE /oapi/v1/clusternetworks/{name}

2.2.10.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	name	name of the ClusterNetwork	true	string

2.2.10.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.10.3. Consumes

2.2.10.4. Produces

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

2.2.10.5. Tags

oapiv1

2.2.11. replace the specified ClusterNetwork

PUT /oapi/v1/clusternetworks/{name}

2.2.11.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.42, “v1.ClusterNetwork”
PathParameter	name	name of the ClusterNetwork	true	string

2.2.11.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.42, “v1.ClusterNetwork”

2.2.11.3. Consumes

2.2.11.4. Produces

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

2.2.11.5. Tags

oapiv1

2.2.12. read the specified ClusterNetwork

GET /oapi/v1/clusternetworks/{name}

2.2.12.1. Parameters

Type	Name	Description	Required	Schema
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 Code	Description	Schema
200	success	Section 2.3.42, “v1.ClusterNetwork”

2.2.12.3. Consumes

2.2.12.4. Produces

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

2.2.12.5. Tags

oapiv1

2.2.13. partially update the specified ClusterNetwork

PATCH /oapi/v1/clusternetworks/{name}

2.2.13.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	name	name of the ClusterNetwork	true	string

2.2.13.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.42, “v1.ClusterNetwork”

2.2.13.3. Consumes

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

2.2.13.4. Produces

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

2.2.13.5. Tags

oapiv1

2.2.14. delete collection of ClusterPolicy

DELETE /oapi/v1/clusterpolicies

2.2.14.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.14.3. Consumes

2.2.14.4. Produces

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

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

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 Code	Description	Schema
200	success	Section 2.3.47, “v1.ClusterPolicyList”

2.2.15.3. Consumes

2.2.15.4. Produces

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

2.2.15.5. Tags

oapiv1

2.2.16. create a ClusterPolicy

POST /oapi/v1/clusterpolicies

2.2.16.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.44, “v1.ClusterPolicy”

2.2.16.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.44, “v1.ClusterPolicy”

2.2.16.3. Consumes

2.2.16.4. Produces

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

2.2.16.5. Tags

oapiv1

2.2.17. delete a ClusterPolicy

DELETE /oapi/v1/clusterpolicies/{name}

2.2.17.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	name	name of the ClusterPolicy	true	string

2.2.17.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.17.3. Consumes

2.2.17.4. Produces

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

2.2.17.5. Tags

oapiv1

2.2.18. replace the specified ClusterPolicy

PUT /oapi/v1/clusterpolicies/{name}

2.2.18.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.44, “v1.ClusterPolicy”
PathParameter	name	name of the ClusterPolicy	true	string

2.2.18.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.44, “v1.ClusterPolicy”

2.2.18.3. Consumes

2.2.18.4. Produces

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

2.2.18.5. Tags

oapiv1

2.2.19. read the specified ClusterPolicy

GET /oapi/v1/clusterpolicies/{name}

2.2.19.1. Parameters

Type	Name	Description	Required	Schema
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 Code	Description	Schema
200	success	Section 2.3.44, “v1.ClusterPolicy”

2.2.19.3. Consumes

2.2.19.4. Produces

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

2.2.19.5. Tags

oapiv1

2.2.20. partially update the specified ClusterPolicy

PATCH /oapi/v1/clusterpolicies/{name}

2.2.20.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	name	name of the ClusterPolicy	true	string

2.2.20.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.44, “v1.ClusterPolicy”

2.2.20.3. Consumes

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

2.2.20.4. Produces

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

2.2.20.5. Tags

oapiv1

2.2.21. delete collection of ClusterPolicyBinding

DELETE /oapi/v1/clusterpolicybindings

2.2.21.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.21.3. Consumes

2.2.21.4. Produces

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

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

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 Code	Description	Schema
200	success	Section 2.3.46, “v1.ClusterPolicyBindingList”

2.2.22.3. Consumes

2.2.22.4. Produces

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

2.2.22.5. Tags

oapiv1

2.2.23. create a ClusterPolicyBinding

POST /oapi/v1/clusterpolicybindings

2.2.23.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.45, “v1.ClusterPolicyBinding”

2.2.23.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.45, “v1.ClusterPolicyBinding”

2.2.23.3. Consumes

2.2.23.4. Produces

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

2.2.23.5. Tags

oapiv1

2.2.24. delete a ClusterPolicyBinding

DELETE /oapi/v1/clusterpolicybindings/{name}

2.2.24.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	name	name of the ClusterPolicyBinding	true	string

2.2.24.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.24.3. Consumes

2.2.24.4. Produces

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

2.2.24.5. Tags

oapiv1

2.2.25. replace the specified ClusterPolicyBinding

PUT /oapi/v1/clusterpolicybindings/{name}

2.2.25.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.45, “v1.ClusterPolicyBinding”
PathParameter	name	name of the ClusterPolicyBinding	true	string

2.2.25.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.45, “v1.ClusterPolicyBinding”

2.2.25.3. Consumes

2.2.25.4. Produces

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

2.2.25.5. Tags

oapiv1

2.2.26. read the specified ClusterPolicyBinding

GET /oapi/v1/clusterpolicybindings/{name}

2.2.26.1. Parameters

Type	Name	Description	Required	Schema
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 Code	Description	Schema
200	success	Section 2.3.45, “v1.ClusterPolicyBinding”

2.2.26.3. Consumes

2.2.26.4. Produces

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

2.2.26.5. Tags

oapiv1

2.2.27. partially update the specified ClusterPolicyBinding

PATCH /oapi/v1/clusterpolicybindings/{name}

2.2.27.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	name	name of the ClusterPolicyBinding	true	string

2.2.27.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.45, “v1.ClusterPolicyBinding”

2.2.27.3. Consumes

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

2.2.27.4. Produces

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

2.2.27.5. Tags

oapiv1

2.2.28. delete collection of ClusterResourceQuota

DELETE /oapi/v1/clusterresourcequotas

2.2.28.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.28.3. Consumes

2.2.28.4. Produces

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

2.2.28.5. Tags

oapiv1

2.2.29. list or watch objects of kind ClusterResourceQuota

GET /oapi/v1/clusterresourcequotas

2.2.29.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.29.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.49, “v1.ClusterResourceQuotaList”

2.2.29.3. Consumes

2.2.29.4. Produces

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

2.2.29.5. Tags

oapiv1

2.2.30. create a ClusterResourceQuota

POST /oapi/v1/clusterresourcequotas

2.2.30.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.48, “v1.ClusterResourceQuota”

2.2.30.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.48, “v1.ClusterResourceQuota”

2.2.30.3. Consumes

2.2.30.4. Produces

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

2.2.30.5. Tags

oapiv1

2.2.31. delete a ClusterResourceQuota

DELETE /oapi/v1/clusterresourcequotas/{name}

2.2.31.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	name	name of the ClusterResourceQuota	true	string

2.2.31.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.31.3. Consumes

2.2.31.4. Produces

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

2.2.31.5. Tags

oapiv1

2.2.32. replace the specified ClusterResourceQuota

PUT /oapi/v1/clusterresourcequotas/{name}

2.2.32.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.48, “v1.ClusterResourceQuota”
PathParameter	name	name of the ClusterResourceQuota	true	string

2.2.32.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.48, “v1.ClusterResourceQuota”

2.2.32.3. Consumes

2.2.32.4. Produces

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

2.2.32.5. Tags

oapiv1

2.2.33. read the specified ClusterResourceQuota

GET /oapi/v1/clusterresourcequotas/{name}

2.2.33.1. Parameters

Type	Name	Description	Required	Schema
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 ClusterResourceQuota	true	string

2.2.33.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.48, “v1.ClusterResourceQuota”

2.2.33.3. Consumes

2.2.33.4. Produces

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

2.2.33.5. Tags

oapiv1

2.2.34. partially update the specified ClusterResourceQuota

PATCH /oapi/v1/clusterresourcequotas/{name}

2.2.34.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	name	name of the ClusterResourceQuota	true	string

2.2.34.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.48, “v1.ClusterResourceQuota”

2.2.34.3. Consumes

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

2.2.34.4. Produces

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

2.2.34.5. Tags

oapiv1

2.2.35. replace status of the specified ClusterResourceQuota

PUT /oapi/v1/clusterresourcequotas/{name}/status

2.2.35.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.48, “v1.ClusterResourceQuota”
PathParameter	name	name of the ClusterResourceQuota	true	string

2.2.35.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.48, “v1.ClusterResourceQuota”

2.2.35.3. Consumes

2.2.35.4. Produces

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

2.2.35.5. Tags

oapiv1

2.2.36. read status of the specified ClusterResourceQuota

GET /oapi/v1/clusterresourcequotas/{name}/status

2.2.36.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	name	name of the ClusterResourceQuota	true	string

2.2.36.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.48, “v1.ClusterResourceQuota”

2.2.36.3. Consumes

2.2.36.4. Produces

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

2.2.36.5. Tags

oapiv1

2.2.37. partially update status of the specified ClusterResourceQuota

PATCH /oapi/v1/clusterresourcequotas/{name}/status

2.2.37.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	name	name of the ClusterResourceQuota	true	string

2.2.37.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.48, “v1.ClusterResourceQuota”

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
application/vnd.kubernetes.protobuf

2.2.37.5. Tags

oapiv1

2.2.38. list objects of kind ClusterRoleBinding

GET /oapi/v1/clusterrolebindings

2.2.38.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.38.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.55, “v1.ClusterRoleBindingList”

2.2.38.3. Consumes

2.2.38.4. Produces

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

2.2.38.5. Tags

oapiv1

2.2.39. create a ClusterRoleBinding

POST /oapi/v1/clusterrolebindings

2.2.39.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.54, “v1.ClusterRoleBinding”

2.2.39.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.54, “v1.ClusterRoleBinding”

2.2.39.3. Consumes

2.2.39.4. Produces

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

2.2.39.5. Tags

oapiv1

2.2.40. delete a ClusterRoleBinding

DELETE /oapi/v1/clusterrolebindings/{name}

2.2.40.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	name	name of the ClusterRoleBinding	true	string

2.2.40.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.40.3. Consumes

2.2.40.4. Produces

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

2.2.40.5. Tags

oapiv1

2.2.41. replace the specified ClusterRoleBinding

PUT /oapi/v1/clusterrolebindings/{name}

2.2.41.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.54, “v1.ClusterRoleBinding”
PathParameter	name	name of the ClusterRoleBinding	true	string

2.2.41.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.54, “v1.ClusterRoleBinding”

2.2.41.3. Consumes

2.2.41.4. Produces

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

2.2.41.5. Tags

oapiv1

2.2.42. read the specified ClusterRoleBinding

GET /oapi/v1/clusterrolebindings/{name}

2.2.42.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	name	name of the ClusterRoleBinding	true	string

2.2.42.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.54, “v1.ClusterRoleBinding”

2.2.42.3. Consumes

2.2.42.4. Produces

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

2.2.42.5. Tags

oapiv1

2.2.43. partially update the specified ClusterRoleBinding

PATCH /oapi/v1/clusterrolebindings/{name}

2.2.43.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	name	name of the ClusterRoleBinding	true	string

2.2.43.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.54, “v1.ClusterRoleBinding”

2.2.43.3. Consumes

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

2.2.43.4. Produces

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

2.2.43.5. Tags

oapiv1

2.2.44. list objects of kind ClusterRole

GET /oapi/v1/clusterroles

2.2.44.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 Code	Description	Schema
200	success	Section 2.3.56, “v1.ClusterRoleList”

2.2.44.3. Consumes

2.2.44.4. Produces

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

2.2.44.5. Tags

oapiv1

2.2.45. create a ClusterRole

POST /oapi/v1/clusterroles

2.2.45.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.53, “v1.ClusterRole”

2.2.45.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.53, “v1.ClusterRole”

2.2.45.3. Consumes

2.2.45.4. Produces

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

2.2.45.5. Tags

oapiv1

2.2.46. delete a ClusterRole

DELETE /oapi/v1/clusterroles/{name}

2.2.46.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	name	name of the ClusterRole	true	string

2.2.46.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.46.3. Consumes

2.2.46.4. Produces

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

2.2.46.5. Tags

oapiv1

2.2.47. replace the specified ClusterRole

PUT /oapi/v1/clusterroles/{name}

2.2.47.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.53, “v1.ClusterRole”
PathParameter	name	name of the ClusterRole	true	string

2.2.47.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.53, “v1.ClusterRole”

2.2.47.3. Consumes

2.2.47.4. Produces

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

2.2.47.5. Tags

oapiv1

2.2.48. read the specified ClusterRole

GET /oapi/v1/clusterroles/{name}

2.2.48.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	name	name of the ClusterRole	true	string

2.2.48.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.53, “v1.ClusterRole”

2.2.48.3. Consumes

2.2.48.4. Produces

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

2.2.48.5. Tags

oapiv1

2.2.49. partially update the specified ClusterRole

PATCH /oapi/v1/clusterroles/{name}

2.2.49.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	name	name of the ClusterRole	true	string

2.2.49.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.53, “v1.ClusterRole”

2.2.49.3. Consumes

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

2.2.49.4. Produces

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

2.2.49.5. Tags

oapiv1

2.2.50. create a DeploymentConfigRollback

POST /oapi/v1/deploymentconfigrollbacks

2.2.50.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.70, “v1.DeploymentConfigRollback”

2.2.50.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.70, “v1.DeploymentConfigRollback”

2.2.50.3. Consumes

2.2.50.4. Produces

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

2.2.50.5. Tags

oapiv1

2.2.51. list or watch objects of kind DeploymentConfig

GET /oapi/v1/deploymentconfigs

2.2.51.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 Code	Description	Schema
200	success	Section 2.3.69, “v1.DeploymentConfigList”

2.2.51.3. Consumes

2.2.51.4. Produces

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

2.2.51.5. Tags

oapiv1

2.2.52. create a DeploymentConfig

POST /oapi/v1/deploymentconfigs

2.2.52.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.68, “v1.DeploymentConfig”

2.2.52.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.68, “v1.DeploymentConfig”

2.2.52.3. Consumes

2.2.52.4. Produces

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

2.2.52.5. Tags

oapiv1

2.2.53. list or watch objects of kind EgressNetworkPolicy

GET /oapi/v1/egressnetworkpolicies

2.2.53.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.53.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.86, “v1.EgressNetworkPolicyList”

2.2.53.3. Consumes

2.2.53.4. Produces

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

2.2.53.5. Tags

oapiv1

2.2.54. create an EgressNetworkPolicy

POST /oapi/v1/egressnetworkpolicies

2.2.54.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.85, “v1.EgressNetworkPolicy”

2.2.54.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.85, “v1.EgressNetworkPolicy”

2.2.54.3. Consumes

2.2.54.4. Produces

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

2.2.54.5. Tags

oapiv1

2.2.55. delete collection of Group

DELETE /oapi/v1/groups

2.2.55.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.55.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.55.3. Consumes

2.2.55.4. Produces

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

2.2.55.5. Tags

oapiv1

2.2.56. list or watch objects of kind Group

GET /oapi/v1/groups

2.2.56.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.56.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.107, “v1.GroupList”

2.2.56.3. Consumes

2.2.56.4. Produces

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

2.2.56.5. Tags

oapiv1

2.2.57. create a Group

POST /oapi/v1/groups

2.2.57.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.106, “v1.Group”

2.2.57.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.106, “v1.Group”

2.2.57.3. Consumes

2.2.57.4. Produces

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

2.2.57.5. Tags

oapiv1

2.2.58. delete a Group

DELETE /oapi/v1/groups/{name}

2.2.58.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	name	name of the Group	true	string

2.2.58.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.58.3. Consumes

2.2.58.4. Produces

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

2.2.58.5. Tags

oapiv1

2.2.59. replace the specified Group

PUT /oapi/v1/groups/{name}

2.2.59.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.106, “v1.Group”
PathParameter	name	name of the Group	true	string

2.2.59.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.106, “v1.Group”

2.2.59.3. Consumes

2.2.59.4. Produces

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

2.2.59.5. Tags

oapiv1

2.2.60. read the specified Group

GET /oapi/v1/groups/{name}

2.2.60.1. Parameters

Type	Name	Description	Required	Schema
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.60.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.106, “v1.Group”

2.2.60.3. Consumes

2.2.60.4. Produces

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

2.2.60.5. Tags

oapiv1

2.2.61. partially update the specified Group

PATCH /oapi/v1/groups/{name}

2.2.61.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	name	name of the Group	true	string

2.2.61.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.106, “v1.Group”

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
application/vnd.kubernetes.protobuf

2.2.61.5. Tags

oapiv1

2.2.62. delete collection of HostSubnet

DELETE /oapi/v1/hostsubnets

2.2.62.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.62.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.62.3. Consumes

2.2.62.4. Produces

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

2.2.62.5. Tags

oapiv1

2.2.63. list or watch objects of kind HostSubnet

GET /oapi/v1/hostsubnets

2.2.63.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.63.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.114, “v1.HostSubnetList”

2.2.63.3. Consumes

2.2.63.4. Produces

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

2.2.63.5. Tags

oapiv1

2.2.64. create a HostSubnet

POST /oapi/v1/hostsubnets

2.2.64.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.113, “v1.HostSubnet”

2.2.64.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.113, “v1.HostSubnet”

2.2.64.3. Consumes

2.2.64.4. Produces

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

2.2.64.5. Tags

oapiv1

2.2.65. delete a HostSubnet

DELETE /oapi/v1/hostsubnets/{name}

2.2.65.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	name	name of the HostSubnet	true	string

2.2.65.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.65.3. Consumes

2.2.65.4. Produces

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

2.2.65.5. Tags

oapiv1

2.2.66. replace the specified HostSubnet

PUT /oapi/v1/hostsubnets/{name}

2.2.66.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.113, “v1.HostSubnet”
PathParameter	name	name of the HostSubnet	true	string

2.2.66.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.113, “v1.HostSubnet”

2.2.66.3. Consumes

2.2.66.4. Produces

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

2.2.66.5. Tags

oapiv1

2.2.67. read the specified HostSubnet

GET /oapi/v1/hostsubnets/{name}

2.2.67.1. Parameters

Type	Name	Description	Required	Schema
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.67.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.113, “v1.HostSubnet”

2.2.67.3. Consumes

2.2.67.4. Produces

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

2.2.67.5. Tags

oapiv1

2.2.68. partially update the specified HostSubnet

PATCH /oapi/v1/hostsubnets/{name}

2.2.68.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	name	name of the HostSubnet	true	string

2.2.68.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.113, “v1.HostSubnet”

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
application/vnd.kubernetes.protobuf

2.2.68.5. Tags

oapiv1

2.2.69. delete collection of Identity

DELETE /oapi/v1/identities

2.2.69.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.69.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.69.3. Consumes

2.2.69.4. Produces

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

2.2.69.5. Tags

oapiv1

2.2.70. list or watch objects of kind Identity

GET /oapi/v1/identities

2.2.70.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.70.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.117, “v1.IdentityList”

2.2.70.3. Consumes

2.2.70.4. Produces

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

2.2.70.5. Tags

oapiv1

2.2.71. create an Identity

POST /oapi/v1/identities

2.2.71.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.116, “v1.Identity”

2.2.71.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.116, “v1.Identity”

2.2.71.3. Consumes

2.2.71.4. Produces

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

2.2.71.5. Tags

oapiv1

2.2.72. delete an Identity

DELETE /oapi/v1/identities/{name}

2.2.72.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	name	name of the Identity	true	string

2.2.72.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.72.3. Consumes

2.2.72.4. Produces

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

2.2.72.5. Tags

oapiv1

2.2.73. replace the specified Identity

PUT /oapi/v1/identities/{name}

2.2.73.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.116, “v1.Identity”
PathParameter	name	name of the Identity	true	string

2.2.73.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.116, “v1.Identity”

2.2.73.3. Consumes

2.2.73.4. Produces

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

2.2.73.5. Tags

oapiv1

2.2.74. read the specified Identity

GET /oapi/v1/identities/{name}

2.2.74.1. Parameters

Type	Name	Description	Required	Schema
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.74.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.116, “v1.Identity”

2.2.74.3. Consumes

2.2.74.4. Produces

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

2.2.74.5. Tags

oapiv1

2.2.75. partially update the specified Identity

PATCH /oapi/v1/identities/{name}

2.2.75.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	name	name of the Identity	true	string

2.2.75.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.116, “v1.Identity”

2.2.75.3. Consumes

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

2.2.75.4. Produces

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

2.2.75.5. Tags

oapiv1

2.2.76. delete collection of Image

DELETE /oapi/v1/images

2.2.76.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.76.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.76.3. Consumes

2.2.76.4. Produces

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

2.2.76.5. Tags

oapiv1

2.2.77. list or watch objects of kind Image

GET /oapi/v1/images

2.2.77.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.77.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.125, “v1.ImageList”

2.2.77.3. Consumes

2.2.77.4. Produces

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

2.2.77.5. Tags

oapiv1

2.2.78. create an Image

POST /oapi/v1/images

2.2.78.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.118, “v1.Image”

2.2.78.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.118, “v1.Image”

2.2.78.3. Consumes

2.2.78.4. Produces

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

2.2.78.5. Tags

oapiv1

2.2.79. delete an Image

DELETE /oapi/v1/images/{name}

2.2.79.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	name	name of the Image	true	string

2.2.79.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.79.3. Consumes

2.2.79.4. Produces

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

2.2.79.5. Tags

oapiv1

2.2.80. replace the specified Image

PUT /oapi/v1/images/{name}

2.2.80.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.118, “v1.Image”
PathParameter	name	name of the Image	true	string

2.2.80.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.118, “v1.Image”

2.2.80.3. Consumes

2.2.80.4. Produces

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

2.2.80.5. Tags

oapiv1

2.2.81. read the specified Image

GET /oapi/v1/images/{name}

2.2.81.1. Parameters

Type	Name	Description	Required	Schema
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.81.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.118, “v1.Image”

2.2.81.3. Consumes

2.2.81.4. Produces

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

2.2.81.5. Tags

oapiv1

2.2.82. partially update the specified Image

PATCH /oapi/v1/images/{name}

2.2.82.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	name	name of the Image	true	string

2.2.82.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.118, “v1.Image”

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
application/vnd.kubernetes.protobuf

2.2.82.5. Tags

oapiv1

2.2.83. create an ImageSignature

POST /oapi/v1/imagesignatures

2.2.83.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.126, “v1.ImageSignature”

2.2.83.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.126, “v1.ImageSignature”

2.2.83.3. Consumes

2.2.83.4. Produces

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

2.2.83.5. Tags

oapiv1

2.2.84. delete an ImageSignature

DELETE /oapi/v1/imagesignatures/{name}

2.2.84.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	name	name of the ImageSignature	true	string

2.2.84.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.84.3. Consumes

2.2.84.4. Produces

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

2.2.84.5. Tags

oapiv1

2.2.85. create an ImageStreamImport

POST /oapi/v1/imagestreamimports

2.2.85.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.131, “v1.ImageStreamImport”

2.2.85.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.131, “v1.ImageStreamImport”

2.2.85.3. Consumes

2.2.85.4. Produces

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

2.2.85.5. Tags

oapiv1

2.2.86. create an ImageStreamMapping

POST /oapi/v1/imagestreammappings

2.2.86.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.135, “v1.ImageStreamMapping”

2.2.86.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.135, “v1.ImageStreamMapping”

2.2.86.3. Consumes

2.2.86.4. Produces

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

2.2.86.5. Tags

oapiv1

2.2.87. list or watch objects of kind ImageStream

GET /oapi/v1/imagestreams

2.2.87.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.87.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.134, “v1.ImageStreamList”

2.2.87.3. Consumes

2.2.87.4. Produces

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

2.2.87.5. Tags

oapiv1

2.2.88. create an ImageStream

POST /oapi/v1/imagestreams

2.2.88.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.129, “v1.ImageStream”

2.2.88.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.129, “v1.ImageStream”

2.2.88.3. Consumes

2.2.88.4. Produces

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

2.2.88.5. Tags

oapiv1

2.2.89. list objects of kind ImageStreamTag

GET /oapi/v1/imagestreamtags

2.2.89.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.89.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.139, “v1.ImageStreamTagList”

2.2.89.3. Consumes

2.2.89.4. Produces

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

2.2.89.5. Tags

oapiv1

2.2.90. create an ImageStreamTag

POST /oapi/v1/imagestreamtags

2.2.90.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.138, “v1.ImageStreamTag”

2.2.90.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.138, “v1.ImageStreamTag”

2.2.90.3. Consumes

2.2.90.4. Produces

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

2.2.90.5. Tags

oapiv1

2.2.91. create a LocalResourceAccessReview

POST /oapi/v1/localresourceaccessreviews

2.2.91.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.145, “v1.LocalResourceAccessReview”

2.2.91.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.145, “v1.LocalResourceAccessReview”

2.2.91.3. Consumes

2.2.91.4. Produces

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

2.2.91.5. Tags

oapiv1

2.2.92. create a LocalSubjectAccessReview

POST /oapi/v1/localsubjectaccessreviews

2.2.92.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.146, “v1.LocalSubjectAccessReview”

2.2.92.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.146, “v1.LocalSubjectAccessReview”

2.2.92.3. Consumes

2.2.92.4. Produces

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

2.2.92.5. Tags

oapiv1

2.2.93. list objects of kind AppliedClusterResourceQuota

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

2.2.93.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.93.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.15, “v1.AppliedClusterResourceQuotaList”

2.2.93.3. Consumes

2.2.93.4. Produces

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

2.2.93.5. Tags

oapiv1

2.2.94. read the specified AppliedClusterResourceQuota

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

2.2.94.1. Parameters

Type	Name	Description	Required	Schema
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 AppliedClusterResourceQuota	true	string

2.2.94.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.14, “v1.AppliedClusterResourceQuota”

2.2.94.3. Consumes

2.2.94.4. Produces

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

2.2.94.5. Tags

oapiv1

2.2.95. delete collection of BuildConfig

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

2.2.95.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.95.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.95.3. Consumes

2.2.95.4. Produces

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

2.2.95.5. Tags

oapiv1

2.2.96. list or watch objects of kind BuildConfig

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

2.2.96.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.96.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.22, “v1.BuildConfigList”

2.2.96.3. Consumes

2.2.96.4. Produces

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

2.2.96.5. Tags

oapiv1

2.2.97. create a BuildConfig

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

2.2.97.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.21, “v1.BuildConfig”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

2.2.97.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.21, “v1.BuildConfig”

2.2.97.3. Consumes

2.2.97.4. Produces

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

2.2.97.5. Tags

oapiv1

2.2.98. delete a BuildConfig

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

2.2.98.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	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.98.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.98.3. Consumes

2.2.98.4. Produces

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

2.2.98.5. Tags

oapiv1

2.2.99. replace the specified BuildConfig

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

2.2.99.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.21, “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.99.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.21, “v1.BuildConfig”

2.2.99.3. Consumes

2.2.99.4. Produces

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

2.2.99.5. Tags

oapiv1

2.2.100. read the specified BuildConfig

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

2.2.100.1. Parameters

Type	Name	Description	Required	Schema
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.100.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.21, “v1.BuildConfig”

2.2.100.3. Consumes

2.2.100.4. Produces

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

2.2.100.5. Tags

oapiv1

2.2.101. partially update the specified BuildConfig

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

2.2.101.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “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.101.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.21, “v1.BuildConfig”

2.2.101.3. Consumes

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

2.2.101.4. Produces

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

2.2.101.5. Tags

oapiv1

2.2.102. create instantiate of a BuildRequest

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

2.2.102.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.29, “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.102.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.29, “v1.BuildRequest”

2.2.102.3. Consumes

2.2.102.4. Produces

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

2.2.102.5. Tags

oapiv1

2.2.103. connect POST requests to instantiatebinary of BinaryBuildRequestOptions

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

2.2.103.1. Parameters

Type	Name	Description	Required	Schema
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	revision.commit is the value identifying a specific commit	false	string
QueryParameter	revision.message	revision.message is the description of a specific commit	false	string
QueryParameter	revision.authorName	revision.authorName of the source control user	false	string
QueryParameter	revision.authorEmail	revision.authorEmail of the source control user	false	string
QueryParameter	revision.committerName	revision.committerName of the source control user	false	string
QueryParameter	revision.committerEmail	revision.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.103.2. Responses

HTTP Code	Description	Schema
default	success	string

2.2.103.3. Consumes

2.2.103.4. Produces

2.2.103.5. Tags

oapiv1

2.2.104. connect POST requests to webhooks of Status

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

2.2.104.1. Parameters

Type	Name	Description	Required	Schema
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.104.2. Responses

HTTP Code	Description	Schema
default	success	string

2.2.104.3. Consumes

2.2.104.4. Produces

2.2.104.5. Tags

oapiv1

2.2.105. connect POST requests to webhooks of Status

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

2.2.105.1. Parameters

Type	Name	Description	Required	Schema
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.105.2. Responses

HTTP Code	Description	Schema
default	success	string

2.2.105.3. Consumes

2.2.105.4. Produces

2.2.105.5. Tags

oapiv1

2.2.106. delete collection of Build

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

2.2.106.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.106.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.106.3. Consumes

2.2.106.4. Produces

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

2.2.106.5. Tags

oapiv1

2.2.107. list or watch objects of kind Build

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

2.2.107.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.107.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.25, “v1.BuildList”

2.2.107.3. Consumes

2.2.107.4. Produces

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

2.2.107.5. Tags

oapiv1

2.2.108. create a Build

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

2.2.108.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.20, “v1.Build”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

2.2.108.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.20, “v1.Build”

2.2.108.3. Consumes

2.2.108.4. Produces

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

2.2.108.5. Tags

oapiv1

2.2.109. delete a Build

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

2.2.109.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	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.109.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.109.3. Consumes

2.2.109.4. Produces

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

2.2.109.5. Tags

oapiv1

2.2.110. replace the specified Build

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

2.2.110.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.20, “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.110.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.20, “v1.Build”

2.2.110.3. Consumes

2.2.110.4. Produces

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

2.2.110.5. Tags

oapiv1

2.2.111. read the specified Build

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

2.2.111.1. Parameters

Type	Name	Description	Required	Schema
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.111.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.20, “v1.Build”

2.2.111.3. Consumes

2.2.111.4. Produces

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

2.2.111.5. Tags

oapiv1

2.2.112. partially update the specified Build

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

2.2.112.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “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.112.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.20, “v1.Build”

2.2.112.3. Consumes

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

2.2.112.4. Produces

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

2.2.112.5. Tags

oapiv1

2.2.113. create clone of a BuildRequest

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

2.2.113.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.29, “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.113.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.29, “v1.BuildRequest”

2.2.113.3. Consumes

2.2.113.4. Produces

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

2.2.113.5. Tags

oapiv1

2.2.114. replace details of the specified Build

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

2.2.114.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.20, “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.114.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.20, “v1.Build”

2.2.114.3. Consumes

2.2.114.4. Produces

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

2.2.114.5. Tags

oapiv1

2.2.115. read log of the specified BuildLog

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

2.2.115.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	container	cointainer 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	previous returns previous build logs. Defaults to false.	false	boolean
QueryParameter	sinceSeconds	sinceSeconds is 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	sinceTime is an RFC3339 timestamp 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	string
QueryParameter	timestamps	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	tailLines, If set, is 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	limitBytes, If set, is 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.115.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.26, “v1.BuildLog”

2.2.115.3. Consumes

2.2.115.4. Produces

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

2.2.115.5. Tags

oapiv1

2.2.116. create a DeploymentConfigRollback

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

2.2.116.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.70, “v1.DeploymentConfigRollback”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

2.2.116.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.70, “v1.DeploymentConfigRollback”

2.2.116.3. Consumes

2.2.116.4. Produces

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

2.2.116.5. Tags

oapiv1

2.2.117. delete collection of DeploymentConfig

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

2.2.117.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.117.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.117.3. Consumes

2.2.117.4. Produces

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

2.2.117.5. Tags

oapiv1

2.2.118. list or watch objects of kind DeploymentConfig

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

2.2.118.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.118.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.69, “v1.DeploymentConfigList”

2.2.118.3. Consumes

2.2.118.4. Produces

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

2.2.118.5. Tags

oapiv1

2.2.119. create a DeploymentConfig

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

2.2.119.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.68, “v1.DeploymentConfig”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

2.2.119.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.68, “v1.DeploymentConfig”

2.2.119.3. Consumes

2.2.119.4. Produces

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

2.2.119.5. Tags

oapiv1

2.2.120. delete a DeploymentConfig

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

2.2.120.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	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.120.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.120.3. Consumes

2.2.120.4. Produces

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

2.2.120.5. Tags

oapiv1

2.2.121. replace the specified DeploymentConfig

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

2.2.121.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.68, “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.121.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.68, “v1.DeploymentConfig”

2.2.121.3. Consumes

2.2.121.4. Produces

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

2.2.121.5. Tags

oapiv1

2.2.122. read the specified DeploymentConfig

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

2.2.122.1. Parameters

Type	Name	Description	Required	Schema
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.122.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.68, “v1.DeploymentConfig”

2.2.122.3. Consumes

2.2.122.4. Produces

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

2.2.122.5. Tags

oapiv1

2.2.123. partially update the specified DeploymentConfig

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

2.2.123.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “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.123.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.68, “v1.DeploymentConfig”

2.2.123.3. Consumes

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

2.2.123.4. Produces

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

2.2.123.5. Tags

oapiv1

2.2.124. create instantiate of a DeploymentRequest

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

2.2.124.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.76, “v1.DeploymentRequest”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the DeploymentRequest	true	string

2.2.124.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.76, “v1.DeploymentRequest”

2.2.124.3. Consumes

2.2.124.4. Produces

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

2.2.124.5. Tags

oapiv1

2.2.125. read log of the specified DeploymentLog

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

2.2.125.1. Parameters

Type	Name	Description	Required	Schema
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 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	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.125.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.75, “v1.DeploymentLog”

2.2.125.3. Consumes

2.2.125.4. Produces

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

2.2.125.5. Tags

oapiv1

2.2.126. create rollback of a DeploymentConfigRollback

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

2.2.126.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.70, “v1.DeploymentConfigRollback”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the DeploymentConfigRollback	true	string

2.2.126.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.70, “v1.DeploymentConfigRollback”

2.2.126.3. Consumes

2.2.126.4. Produces

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

2.2.126.5. Tags

oapiv1

2.2.127. replace scale of the specified Scale

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

2.2.127.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.263, “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.127.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.263, “v1beta1.Scale”

2.2.127.3. Consumes

2.2.127.4. Produces

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

2.2.127.5. Tags

oapiv1

2.2.128. read scale of the specified Scale

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

2.2.128.1. Parameters

Type	Name	Description	Required	Schema
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.128.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.263, “v1beta1.Scale”

2.2.128.3. Consumes

2.2.128.4. Produces

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

2.2.128.5. Tags

oapiv1

2.2.129. partially update scale of the specified Scale

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

2.2.129.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “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.129.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.263, “v1beta1.Scale”

2.2.129.3. Consumes

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

2.2.129.4. Produces

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

2.2.129.5. Tags

oapiv1

2.2.130. replace status of the specified DeploymentConfig

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

2.2.130.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.68, “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.130.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.68, “v1.DeploymentConfig”

2.2.130.3. Consumes

2.2.130.4. Produces

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

2.2.130.5. Tags

oapiv1

2.2.131. delete collection of EgressNetworkPolicy

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

2.2.131.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.131.3. Consumes

2.2.131.4. Produces

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

2.2.131.5. Tags

oapiv1

2.2.132. list or watch objects of kind EgressNetworkPolicy

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

2.2.132.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 Code	Description	Schema
200	success	Section 2.3.86, “v1.EgressNetworkPolicyList”

2.2.132.3. Consumes

2.2.132.4. Produces

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

2.2.132.5. Tags

oapiv1

2.2.133. create an EgressNetworkPolicy

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

2.2.133.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.85, “v1.EgressNetworkPolicy”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

2.2.133.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.85, “v1.EgressNetworkPolicy”

2.2.133.3. Consumes

2.2.133.4. Produces

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

2.2.133.5. Tags

oapiv1

2.2.134. delete an EgressNetworkPolicy

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

2.2.134.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the EgressNetworkPolicy	true	string

2.2.134.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.134.3. Consumes

2.2.134.4. Produces

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

2.2.134.5. Tags

oapiv1

2.2.135. replace the specified EgressNetworkPolicy

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

2.2.135.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.85, “v1.EgressNetworkPolicy”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the EgressNetworkPolicy	true	string

2.2.135.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.85, “v1.EgressNetworkPolicy”

2.2.135.3. Consumes

2.2.135.4. Produces

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

2.2.135.5. Tags

oapiv1

2.2.136. read the specified EgressNetworkPolicy

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

2.2.136.1. Parameters

Type	Name	Description	Required	Schema
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 EgressNetworkPolicy	true	string

2.2.136.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.85, “v1.EgressNetworkPolicy”

2.2.136.3. Consumes

2.2.136.4. Produces

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

2.2.136.5. Tags

oapiv1

2.2.137. partially update the specified EgressNetworkPolicy

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

2.2.137.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the EgressNetworkPolicy	true	string

2.2.137.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.85, “v1.EgressNetworkPolicy”

2.2.137.3. Consumes

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

2.2.137.4. Produces

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

2.2.137.5. Tags

oapiv1

2.2.138. read the specified DeploymentConfig

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

2.2.138.1. Parameters

Type	Name	Description	Required	Schema
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.138.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.68, “v1.DeploymentConfig”

2.2.138.3. Consumes

2.2.138.4. Produces

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

2.2.138.5. Tags

oapiv1

2.2.139. read the specified ImageStreamImage

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

2.2.139.1. Parameters

Type	Name	Description	Required	Schema
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.139.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.130, “v1.ImageStreamImage”

2.2.139.3. Consumes

2.2.139.4. Produces

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

2.2.139.5. Tags

oapiv1

2.2.140. create an ImageStreamImport

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

2.2.140.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.131, “v1.ImageStreamImport”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

2.2.140.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.131, “v1.ImageStreamImport”

2.2.140.3. Consumes

2.2.140.4. Produces

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

2.2.140.5. Tags

oapiv1

2.2.141. create an ImageStreamMapping

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

2.2.141.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.135, “v1.ImageStreamMapping”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

2.2.141.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.135, “v1.ImageStreamMapping”

2.2.141.3. Consumes

2.2.141.4. Produces

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

2.2.141.5. Tags

oapiv1

2.2.142. delete collection of ImageStream

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

2.2.142.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.142.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.142.3. Consumes

2.2.142.4. Produces

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

2.2.142.5. Tags

oapiv1

2.2.143. list or watch objects of kind ImageStream

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

2.2.143.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.143.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.134, “v1.ImageStreamList”

2.2.143.3. Consumes

2.2.143.4. Produces

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

2.2.143.5. Tags

oapiv1

2.2.144. create an ImageStream

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

2.2.144.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.129, “v1.ImageStream”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

2.2.144.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.129, “v1.ImageStream”

2.2.144.3. Consumes

2.2.144.4. Produces

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

2.2.144.5. Tags

oapiv1

2.2.145. delete an ImageStream

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

2.2.145.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	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.145.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.145.3. Consumes

2.2.145.4. Produces

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

2.2.145.5. Tags

oapiv1

2.2.146. replace the specified ImageStream

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

2.2.146.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.129, “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.146.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.129, “v1.ImageStream”

2.2.146.3. Consumes

2.2.146.4. Produces

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

2.2.146.5. Tags

oapiv1

2.2.147. read the specified ImageStream

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

2.2.147.1. Parameters

Type	Name	Description	Required	Schema
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.147.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.129, “v1.ImageStream”

2.2.147.3. Consumes

2.2.147.4. Produces

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

2.2.147.5. Tags

oapiv1

2.2.148. partially update the specified ImageStream

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

2.2.148.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “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.148.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.129, “v1.ImageStream”

2.2.148.3. Consumes

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

2.2.148.4. Produces

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

2.2.148.5. Tags

oapiv1

2.2.149. read secrets of the specified SecretList

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

2.2.149.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.149.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.226, “v1.SecretList”

2.2.149.3. Consumes

2.2.149.4. Produces

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

2.2.149.5. Tags

oapiv1

2.2.150. replace status of the specified ImageStream

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

2.2.150.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.129, “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.150.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.129, “v1.ImageStream”

2.2.150.3. Consumes

2.2.150.4. Produces

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

2.2.150.5. Tags

oapiv1

2.2.151. list objects of kind ImageStreamTag

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

2.2.151.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.151.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.139, “v1.ImageStreamTagList”

2.2.151.3. Consumes

2.2.151.4. Produces

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

2.2.151.5. Tags

oapiv1

2.2.152. create an ImageStreamTag

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

2.2.152.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.138, “v1.ImageStreamTag”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

2.2.152.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.138, “v1.ImageStreamTag”

2.2.152.3. Consumes

2.2.152.4. Produces

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

2.2.152.5. Tags

oapiv1

2.2.153. delete an ImageStreamTag

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

2.2.153.1. Parameters

Type	Name	Description	Required	Schema
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.153.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.153.3. Consumes

2.2.153.4. Produces

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

2.2.153.5. Tags

oapiv1

2.2.154. replace the specified ImageStreamTag

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

2.2.154.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.138, “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.154.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.138, “v1.ImageStreamTag”

2.2.154.3. Consumes

2.2.154.4. Produces

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

2.2.154.5. Tags

oapiv1

2.2.155. read the specified ImageStreamTag

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

2.2.155.1. Parameters

Type	Name	Description	Required	Schema
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.155.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.138, “v1.ImageStreamTag”

2.2.155.3. Consumes

2.2.155.4. Produces

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

2.2.155.5. Tags

oapiv1

2.2.156. partially update the specified ImageStreamTag

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

2.2.156.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “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.156.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.138, “v1.ImageStreamTag”

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
application/vnd.kubernetes.protobuf

2.2.156.5. Tags

oapiv1

2.2.157. create a LocalResourceAccessReview

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

2.2.157.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.145, “v1.LocalResourceAccessReview”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

2.2.157.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.145, “v1.LocalResourceAccessReview”

2.2.157.3. Consumes

2.2.157.4. Produces

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

2.2.157.5. Tags

oapiv1

2.2.158. create a LocalSubjectAccessReview

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

2.2.158.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.146, “v1.LocalSubjectAccessReview”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

2.2.158.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.146, “v1.LocalSubjectAccessReview”

2.2.158.3. Consumes

2.2.158.4. Produces

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

2.2.158.5. Tags

oapiv1

2.2.159. create a PodSecurityPolicyReview

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

2.2.159.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.171, “v1.PodSecurityPolicyReview”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

2.2.159.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.171, “v1.PodSecurityPolicyReview”

2.2.159.3. Consumes

2.2.159.4. Produces

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

2.2.159.5. Tags

oapiv1

2.2.160. create a PodSecurityPolicySelfSubjectReview

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

2.2.160.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.174, “v1.PodSecurityPolicySelfSubjectReview”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

2.2.160.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.174, “v1.PodSecurityPolicySelfSubjectReview”

2.2.160.3. Consumes

2.2.160.4. Produces

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

2.2.160.5. Tags

oapiv1

2.2.161. create a PodSecurityPolicySubjectReview

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

2.2.161.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.176, “v1.PodSecurityPolicySubjectReview”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

2.2.161.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.176, “v1.PodSecurityPolicySubjectReview”

2.2.161.3. Consumes

2.2.161.4. Produces

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

2.2.161.5. Tags

oapiv1

2.2.162. delete collection of Policy

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

2.2.162.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.162.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.162.3. Consumes

2.2.162.4. Produces

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

2.2.162.5. Tags

oapiv1

2.2.163. list or watch objects of kind Policy

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

2.2.163.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.163.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.184, “v1.PolicyList”

2.2.163.3. Consumes

2.2.163.4. Produces

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

2.2.163.5. Tags

oapiv1

2.2.164. create a Policy

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

2.2.164.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.181, “v1.Policy”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

2.2.164.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.181, “v1.Policy”

2.2.164.3. Consumes

2.2.164.4. Produces

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

2.2.164.5. Tags

oapiv1

2.2.165. delete a Policy

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

2.2.165.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	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.165.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.165.3. Consumes

2.2.165.4. Produces

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

2.2.165.5. Tags

oapiv1

2.2.166. replace the specified Policy

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

2.2.166.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.181, “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.166.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.181, “v1.Policy”

2.2.166.3. Consumes

2.2.166.4. Produces

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

2.2.166.5. Tags

oapiv1

2.2.167. read the specified Policy

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

2.2.167.1. Parameters

Type	Name	Description	Required	Schema
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.167.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.181, “v1.Policy”

2.2.167.3. Consumes

2.2.167.4. Produces

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

2.2.167.5. Tags

oapiv1

2.2.168. partially update the specified Policy

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

2.2.168.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “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.168.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.181, “v1.Policy”

2.2.168.3. Consumes

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

2.2.168.4. Produces

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

2.2.168.5. Tags

oapiv1

2.2.169. delete collection of PolicyBinding

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

2.2.169.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.169.3. Consumes

2.2.169.4. Produces

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

2.2.169.5. Tags

oapiv1

2.2.170. list or watch objects of kind PolicyBinding

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

2.2.170.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.170.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.183, “v1.PolicyBindingList”

2.2.170.3. Consumes

2.2.170.4. Produces

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

2.2.170.5. Tags

oapiv1

2.2.171. create a PolicyBinding

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

2.2.171.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.182, “v1.PolicyBinding”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

2.2.171.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.182, “v1.PolicyBinding”

2.2.171.3. Consumes

2.2.171.4. Produces

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

2.2.171.5. Tags

oapiv1

2.2.172. delete a PolicyBinding

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

2.2.172.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	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.172.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.172.3. Consumes

2.2.172.4. Produces

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

2.2.172.5. Tags

oapiv1

2.2.173. replace the specified PolicyBinding

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

2.2.173.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.182, “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.173.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.182, “v1.PolicyBinding”

2.2.173.3. Consumes

2.2.173.4. Produces

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

2.2.173.5. Tags

oapiv1

2.2.174. read the specified PolicyBinding

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

2.2.174.1. Parameters

Type	Name	Description	Required	Schema
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.174.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.182, “v1.PolicyBinding”

2.2.174.3. Consumes

2.2.174.4. Produces

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

2.2.174.5. Tags

oapiv1

2.2.175. partially update the specified PolicyBinding

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

2.2.175.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “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.175.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.182, “v1.PolicyBinding”

2.2.175.3. Consumes

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

2.2.175.4. Produces

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

2.2.175.5. Tags

oapiv1

2.2.176. create a Template

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

2.2.176.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.253, “v1.Template”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

2.2.176.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.253, “v1.Template”

2.2.176.3. Consumes

2.2.176.4. Produces

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

2.2.176.5. Tags

oapiv1

2.2.177. create a ResourceAccessReview

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

2.2.177.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.198, “v1.ResourceAccessReview”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

2.2.177.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.198, “v1.ResourceAccessReview”

2.2.177.3. Consumes

2.2.177.4. Produces

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

2.2.177.5. Tags

oapiv1

2.2.178. delete collection of RoleBindingRestriction

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

2.2.178.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.178.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.178.3. Consumes

2.2.178.4. Produces

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

2.2.178.5. Tags

oapiv1

2.2.179. list or watch objects of kind RoleBindingRestriction

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

2.2.179.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.179.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.209, “v1.RoleBindingRestrictionList”

2.2.179.3. Consumes

2.2.179.4. Produces

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

2.2.179.5. Tags

oapiv1

2.2.180. create a RoleBindingRestriction

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

2.2.180.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.208, “v1.RoleBindingRestriction”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

2.2.180.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.208, “v1.RoleBindingRestriction”

2.2.180.3. Consumes

2.2.180.4. Produces

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

2.2.180.5. Tags

oapiv1

2.2.181. delete a RoleBindingRestriction

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

2.2.181.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the RoleBindingRestriction	true	string

2.2.181.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.181.3. Consumes

2.2.181.4. Produces

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

2.2.181.5. Tags

oapiv1

2.2.182. replace the specified RoleBindingRestriction

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

2.2.182.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.208, “v1.RoleBindingRestriction”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the RoleBindingRestriction	true	string

2.2.182.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.208, “v1.RoleBindingRestriction”

2.2.182.3. Consumes

2.2.182.4. Produces

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

2.2.182.5. Tags

oapiv1

2.2.183. read the specified RoleBindingRestriction

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

2.2.183.1. Parameters

Type	Name	Description	Required	Schema
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 RoleBindingRestriction	true	string

2.2.183.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.208, “v1.RoleBindingRestriction”

2.2.183.3. Consumes

2.2.183.4. Produces

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

2.2.183.5. Tags

oapiv1

2.2.184. partially update the specified RoleBindingRestriction

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

2.2.184.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the RoleBindingRestriction	true	string

2.2.184.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.208, “v1.RoleBindingRestriction”

2.2.184.3. Consumes

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

2.2.184.4. Produces

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

2.2.184.5. Tags

oapiv1

2.2.185. list objects of kind RoleBinding

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

2.2.185.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.185.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.207, “v1.RoleBindingList”

2.2.185.3. Consumes

2.2.185.4. Produces

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

2.2.185.5. Tags

oapiv1

2.2.186. create a RoleBinding

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

2.2.186.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.206, “v1.RoleBinding”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

2.2.186.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.206, “v1.RoleBinding”

2.2.186.3. Consumes

2.2.186.4. Produces

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

2.2.186.5. Tags

oapiv1

2.2.187. delete a RoleBinding

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

2.2.187.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
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.187.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.187.3. Consumes

2.2.187.4. Produces

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

2.2.187.5. Tags

oapiv1

2.2.188. replace the specified RoleBinding

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

2.2.188.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.206, “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.188.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.206, “v1.RoleBinding”

2.2.188.3. Consumes

2.2.188.4. Produces

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

2.2.188.5. Tags

oapiv1

2.2.189. read the specified RoleBinding

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

2.2.189.1. Parameters

Type	Name	Description	Required	Schema
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.189.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.206, “v1.RoleBinding”

2.2.189.3. Consumes

2.2.189.4. Produces

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

2.2.189.5. Tags

oapiv1

2.2.190. partially update the specified RoleBinding

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

2.2.190.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “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.190.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.206, “v1.RoleBinding”

2.2.190.3. Consumes

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

2.2.190.4. Produces

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

2.2.190.5. Tags

oapiv1

2.2.191. list objects of kind Role

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

2.2.191.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.191.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.211, “v1.RoleList”

2.2.191.3. Consumes

2.2.191.4. Produces

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

2.2.191.5. Tags

oapiv1

2.2.192. create a Role

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

2.2.192.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.205, “v1.Role”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

2.2.192.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.205, “v1.Role”

2.2.192.3. Consumes

2.2.192.4. Produces

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

2.2.192.5. Tags

oapiv1

2.2.193. delete a Role

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

2.2.193.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
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.193.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.193.3. Consumes

2.2.193.4. Produces

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

2.2.193.5. Tags

oapiv1

2.2.194. replace the specified Role

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

2.2.194.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.205, “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.194.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.205, “v1.Role”

2.2.194.3. Consumes

2.2.194.4. Produces

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

2.2.194.5. Tags

oapiv1

2.2.195. read the specified Role

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

2.2.195.1. Parameters

Type	Name	Description	Required	Schema
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.195.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.205, “v1.Role”

2.2.195.3. Consumes

2.2.195.4. Produces

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

2.2.195.5. Tags

oapiv1

2.2.196. partially update the specified Role

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

2.2.196.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “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.196.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.205, “v1.Role”

2.2.196.3. Consumes

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

2.2.196.4. Produces

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

2.2.196.5. Tags

oapiv1

2.2.197. delete collection of Route

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

2.2.197.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.197.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.197.3. Consumes

2.2.197.4. Produces

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

2.2.197.5. Tags

oapiv1

2.2.198. list or watch objects of kind Route

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

2.2.198.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.198.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.216, “v1.RouteList”

2.2.198.3. Consumes

2.2.198.4. Produces

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

2.2.198.5. Tags

oapiv1

2.2.199. create a Route

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

2.2.199.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.213, “v1.Route”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

2.2.199.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.213, “v1.Route”

2.2.199.3. Consumes

2.2.199.4. Produces

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

2.2.199.5. Tags

oapiv1

2.2.200. delete a Route

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

2.2.200.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	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.200.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.200.3. Consumes

2.2.200.4. Produces

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

2.2.200.5. Tags

oapiv1

2.2.201. replace the specified Route

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

2.2.201.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.213, “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.201.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.213, “v1.Route”

2.2.201.3. Consumes

2.2.201.4. Produces

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

2.2.201.5. Tags

oapiv1

2.2.202. read the specified Route

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

2.2.202.1. Parameters

Type	Name	Description	Required	Schema
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.202.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.213, “v1.Route”

2.2.202.3. Consumes

2.2.202.4. Produces

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

2.2.202.5. Tags

oapiv1

2.2.203. partially update the specified Route

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

2.2.203.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “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.203.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.213, “v1.Route”

2.2.203.3. Consumes

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

2.2.203.4. Produces

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

2.2.203.5. Tags

oapiv1

2.2.204. replace status of the specified Route

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

2.2.204.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.213, “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.204.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.213, “v1.Route”

2.2.204.3. Consumes

2.2.204.4. Produces

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

2.2.204.5. Tags

oapiv1

2.2.205. create a SelfSubjectRulesReview

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

2.2.205.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.230, “v1.SelfSubjectRulesReview”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

2.2.205.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.230, “v1.SelfSubjectRulesReview”

2.2.205.3. Consumes

2.2.205.4. Produces

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

2.2.205.5. Tags

oapiv1

2.2.206. create a SubjectAccessReview

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

2.2.206.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.241, “v1.SubjectAccessReview”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

2.2.206.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.241, “v1.SubjectAccessReview”

2.2.206.3. Consumes

2.2.206.4. Produces

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

2.2.206.5. Tags

oapiv1

2.2.207. create a SubjectRulesReview

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

2.2.207.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.242, “v1.SubjectRulesReview”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

2.2.207.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.242, “v1.SubjectRulesReview”

2.2.207.3. Consumes

2.2.207.4. Produces

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

2.2.207.5. Tags

oapiv1

2.2.208. delete collection of Template

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

2.2.208.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.208.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.208.3. Consumes

2.2.208.4. Produces

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

2.2.208.5. Tags

oapiv1

2.2.209. list or watch objects of kind Template

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

2.2.209.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.209.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.254, “v1.TemplateList”

2.2.209.3. Consumes

2.2.209.4. Produces

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

2.2.209.5. Tags

oapiv1

2.2.210. create a Template

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

2.2.210.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.253, “v1.Template”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

2.2.210.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.253, “v1.Template”

2.2.210.3. Consumes

2.2.210.4. Produces

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

2.2.210.5. Tags

oapiv1

2.2.211. delete a Template

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

2.2.211.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	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.211.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.211.3. Consumes

2.2.211.4. Produces

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

2.2.211.5. Tags

oapiv1

2.2.212. replace the specified Template

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

2.2.212.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.253, “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.212.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.253, “v1.Template”

2.2.212.3. Consumes

2.2.212.4. Produces

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

2.2.212.5. Tags

oapiv1

2.2.213. read the specified Template

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

2.2.213.1. Parameters

Type	Name	Description	Required	Schema
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.213.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.253, “v1.Template”

2.2.213.3. Consumes

2.2.213.4. Produces

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

2.2.213.5. Tags

oapiv1

2.2.214. partially update the specified Template

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

2.2.214.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “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.214.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.253, “v1.Template”

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
application/vnd.kubernetes.protobuf

2.2.214.5. Tags

oapiv1

2.2.215. delete collection of NetNamespace

DELETE /oapi/v1/netnamespaces

2.2.215.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.215.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.215.3. Consumes

2.2.215.4. Produces

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

2.2.215.5. Tags

oapiv1

2.2.216. list or watch objects of kind NetNamespace

GET /oapi/v1/netnamespaces

2.2.216.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.216.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.154, “v1.NetNamespaceList”

2.2.216.3. Consumes

2.2.216.4. Produces

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

2.2.216.5. Tags

oapiv1

2.2.217. create a NetNamespace

POST /oapi/v1/netnamespaces

2.2.217.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.153, “v1.NetNamespace”

2.2.217.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.153, “v1.NetNamespace”

2.2.217.3. Consumes

2.2.217.4. Produces

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

2.2.217.5. Tags

oapiv1

2.2.218. delete a NetNamespace

DELETE /oapi/v1/netnamespaces/{name}

2.2.218.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	name	name of the NetNamespace	true	string

2.2.218.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.218.3. Consumes

2.2.218.4. Produces

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

2.2.218.5. Tags

oapiv1

2.2.219. replace the specified NetNamespace

PUT /oapi/v1/netnamespaces/{name}

2.2.219.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.153, “v1.NetNamespace”
PathParameter	name	name of the NetNamespace	true	string

2.2.219.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.153, “v1.NetNamespace”

2.2.219.3. Consumes

2.2.219.4. Produces

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

2.2.219.5. Tags

oapiv1

2.2.220. read the specified NetNamespace

GET /oapi/v1/netnamespaces/{name}

2.2.220.1. Parameters

Type	Name	Description	Required	Schema
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.220.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.153, “v1.NetNamespace”

2.2.220.3. Consumes

2.2.220.4. Produces

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

2.2.220.5. Tags

oapiv1

2.2.221. partially update the specified NetNamespace

PATCH /oapi/v1/netnamespaces/{name}

2.2.221.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	name	name of the NetNamespace	true	string

2.2.221.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.153, “v1.NetNamespace”

2.2.221.3. Consumes

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

2.2.221.4. Produces

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

2.2.221.5. Tags

oapiv1

2.2.222. delete collection of OAuthAccessToken

DELETE /oapi/v1/oauthaccesstokens

2.2.222.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.222.3. Consumes

2.2.222.4. Produces

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

2.2.222.5. Tags

oapiv1

2.2.223. list or watch objects of kind OAuthAccessToken

GET /oapi/v1/oauthaccesstokens

2.2.223.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.223.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.156, “v1.OAuthAccessTokenList”

2.2.223.3. Consumes

2.2.223.4. Produces

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

2.2.223.5. Tags

oapiv1

2.2.224. create an OAuthAccessToken

POST /oapi/v1/oauthaccesstokens

2.2.224.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.155, “v1.OAuthAccessToken”

2.2.224.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.155, “v1.OAuthAccessToken”

2.2.224.3. Consumes

2.2.224.4. Produces

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

2.2.224.5. Tags

oapiv1

2.2.225. delete an OAuthAccessToken

DELETE /oapi/v1/oauthaccesstokens/{name}

2.2.225.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	name	name of the OAuthAccessToken	true	string

2.2.225.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.225.3. Consumes

2.2.225.4. Produces

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

2.2.225.5. Tags

oapiv1

2.2.226. replace the specified OAuthAccessToken

PUT /oapi/v1/oauthaccesstokens/{name}

2.2.226.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.155, “v1.OAuthAccessToken”
PathParameter	name	name of the OAuthAccessToken	true	string

2.2.226.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.155, “v1.OAuthAccessToken”

2.2.226.3. Consumes

2.2.226.4. Produces

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

2.2.226.5. Tags

oapiv1

2.2.227. read the specified OAuthAccessToken

GET /oapi/v1/oauthaccesstokens/{name}

2.2.227.1. Parameters

Type	Name	Description	Required	Schema
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 OAuthAccessToken	true	string

2.2.227.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.155, “v1.OAuthAccessToken”

2.2.227.3. Consumes

2.2.227.4. Produces

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

2.2.227.5. Tags

oapiv1

2.2.228. partially update the specified OAuthAccessToken

PATCH /oapi/v1/oauthaccesstokens/{name}

2.2.228.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	name	name of the OAuthAccessToken	true	string

2.2.228.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.155, “v1.OAuthAccessToken”

2.2.228.3. Consumes

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

2.2.228.4. Produces

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

2.2.228.5. Tags

oapiv1

2.2.229. delete collection of OAuthAuthorizeToken

DELETE /oapi/v1/oauthauthorizetokens

2.2.229.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.229.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.229.3. Consumes

2.2.229.4. Produces

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

2.2.229.5. Tags

oapiv1

2.2.230. list or watch objects of kind OAuthAuthorizeToken

GET /oapi/v1/oauthauthorizetokens

2.2.230.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.230.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.158, “v1.OAuthAuthorizeTokenList”

2.2.230.3. Consumes

2.2.230.4. Produces

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

2.2.230.5. Tags

oapiv1

2.2.231. create an OAuthAuthorizeToken

POST /oapi/v1/oauthauthorizetokens

2.2.231.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.157, “v1.OAuthAuthorizeToken”

2.2.231.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.157, “v1.OAuthAuthorizeToken”

2.2.231.3. Consumes

2.2.231.4. Produces

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

2.2.231.5. Tags

oapiv1

2.2.232. delete an OAuthAuthorizeToken

DELETE /oapi/v1/oauthauthorizetokens/{name}

2.2.232.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	name	name of the OAuthAuthorizeToken	true	string

2.2.232.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.232.3. Consumes

2.2.232.4. Produces

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

2.2.232.5. Tags

oapiv1

2.2.233. replace the specified OAuthAuthorizeToken

PUT /oapi/v1/oauthauthorizetokens/{name}

2.2.233.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.157, “v1.OAuthAuthorizeToken”
PathParameter	name	name of the OAuthAuthorizeToken	true	string

2.2.233.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.157, “v1.OAuthAuthorizeToken”

2.2.233.3. Consumes

2.2.233.4. Produces

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

2.2.233.5. Tags

oapiv1

2.2.234. read the specified OAuthAuthorizeToken

GET /oapi/v1/oauthauthorizetokens/{name}

2.2.234.1. Parameters

Type	Name	Description	Required	Schema
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 OAuthAuthorizeToken	true	string

2.2.234.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.157, “v1.OAuthAuthorizeToken”

2.2.234.3. Consumes

2.2.234.4. Produces

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

2.2.234.5. Tags

oapiv1

2.2.235. partially update the specified OAuthAuthorizeToken

PATCH /oapi/v1/oauthauthorizetokens/{name}

2.2.235.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	name	name of the OAuthAuthorizeToken	true	string

2.2.235.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.157, “v1.OAuthAuthorizeToken”

2.2.235.3. Consumes

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

2.2.235.4. Produces

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

2.2.235.5. Tags

oapiv1

2.2.236. delete collection of OAuthClientAuthorization

DELETE /oapi/v1/oauthclientauthorizations

2.2.236.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.236.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.236.3. Consumes

2.2.236.4. Produces

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

2.2.236.5. Tags

oapiv1

2.2.237. list or watch objects of kind OAuthClientAuthorization

GET /oapi/v1/oauthclientauthorizations

2.2.237.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.237.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.161, “v1.OAuthClientAuthorizationList”

2.2.237.3. Consumes

2.2.237.4. Produces

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

2.2.237.5. Tags

oapiv1

2.2.238. create an OAuthClientAuthorization

POST /oapi/v1/oauthclientauthorizations

2.2.238.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.160, “v1.OAuthClientAuthorization”

2.2.238.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.160, “v1.OAuthClientAuthorization”

2.2.238.3. Consumes

2.2.238.4. Produces

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

2.2.238.5. Tags

oapiv1

2.2.239. delete an OAuthClientAuthorization

DELETE /oapi/v1/oauthclientauthorizations/{name}

2.2.239.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	name	name of the OAuthClientAuthorization	true	string

2.2.239.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.239.3. Consumes

2.2.239.4. Produces

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

2.2.239.5. Tags

oapiv1

2.2.240. replace the specified OAuthClientAuthorization

PUT /oapi/v1/oauthclientauthorizations/{name}

2.2.240.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.160, “v1.OAuthClientAuthorization”
PathParameter	name	name of the OAuthClientAuthorization	true	string

2.2.240.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.160, “v1.OAuthClientAuthorization”

2.2.240.3. Consumes

2.2.240.4. Produces

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

2.2.240.5. Tags

oapiv1

2.2.241. read the specified OAuthClientAuthorization

GET /oapi/v1/oauthclientauthorizations/{name}

2.2.241.1. Parameters

Type	Name	Description	Required	Schema
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.241.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.160, “v1.OAuthClientAuthorization”

2.2.241.3. Consumes

2.2.241.4. Produces

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

2.2.241.5. Tags

oapiv1

2.2.242. partially update the specified OAuthClientAuthorization

PATCH /oapi/v1/oauthclientauthorizations/{name}

2.2.242.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	name	name of the OAuthClientAuthorization	true	string

2.2.242.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.160, “v1.OAuthClientAuthorization”

2.2.242.3. Consumes

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

2.2.242.4. Produces

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

2.2.242.5. Tags

oapiv1

2.2.243. delete collection of OAuthClient

DELETE /oapi/v1/oauthclients

2.2.243.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.243.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.243.3. Consumes

2.2.243.4. Produces

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

2.2.243.5. Tags

oapiv1

2.2.244. list or watch objects of kind OAuthClient

GET /oapi/v1/oauthclients

2.2.244.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 Code	Description	Schema
200	success	Section 2.3.162, “v1.OAuthClientList”

2.2.244.3. Consumes

2.2.244.4. Produces

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

2.2.244.5. Tags

oapiv1

2.2.245. create an OAuthClient

POST /oapi/v1/oauthclients

2.2.245.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.159, “v1.OAuthClient”

2.2.245.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.159, “v1.OAuthClient”

2.2.245.3. Consumes

2.2.245.4. Produces

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

2.2.245.5. Tags

oapiv1

2.2.246. delete an OAuthClient

DELETE /oapi/v1/oauthclients/{name}

2.2.246.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	name	name of the OAuthClient	true	string

2.2.246.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.246.3. Consumes

2.2.246.4. Produces

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

2.2.246.5. Tags

oapiv1

2.2.247. replace the specified OAuthClient

PUT /oapi/v1/oauthclients/{name}

2.2.247.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.159, “v1.OAuthClient”
PathParameter	name	name of the OAuthClient	true	string

2.2.247.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.159, “v1.OAuthClient”

2.2.247.3. Consumes

2.2.247.4. Produces

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

2.2.247.5. Tags

oapiv1

2.2.248. read the specified OAuthClient

GET /oapi/v1/oauthclients/{name}

2.2.248.1. Parameters

Type	Name	Description	Required	Schema
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.248.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.159, “v1.OAuthClient”

2.2.248.3. Consumes

2.2.248.4. Produces

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

2.2.248.5. Tags

oapiv1

2.2.249. partially update the specified OAuthClient

PATCH /oapi/v1/oauthclients/{name}

2.2.249.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	name	name of the OAuthClient	true	string

2.2.249.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.159, “v1.OAuthClient”

2.2.249.3. Consumes

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

2.2.249.4. Produces

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

2.2.249.5. Tags

oapiv1

2.2.250. create a PodSecurityPolicyReview

POST /oapi/v1/podsecuritypolicyreviews

2.2.250.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.171, “v1.PodSecurityPolicyReview”

2.2.250.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.171, “v1.PodSecurityPolicyReview”

2.2.250.3. Consumes

2.2.250.4. Produces

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

2.2.250.5. Tags

oapiv1

2.2.251. create a PodSecurityPolicySelfSubjectReview

POST /oapi/v1/podsecuritypolicyselfsubjectreviews

2.2.251.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.174, “v1.PodSecurityPolicySelfSubjectReview”

2.2.251.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.174, “v1.PodSecurityPolicySelfSubjectReview”

2.2.251.3. Consumes

2.2.251.4. Produces

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

2.2.251.5. Tags

oapiv1

2.2.252. create a PodSecurityPolicySubjectReview

POST /oapi/v1/podsecuritypolicysubjectreviews

2.2.252.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.176, “v1.PodSecurityPolicySubjectReview”

2.2.252.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.176, “v1.PodSecurityPolicySubjectReview”

2.2.252.3. Consumes

2.2.252.4. Produces

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

2.2.252.5. Tags

oapiv1

2.2.253. list or watch objects of kind Policy

GET /oapi/v1/policies

2.2.253.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 Code	Description	Schema
200	success	Section 2.3.184, “v1.PolicyList”

2.2.253.3. Consumes

2.2.253.4. Produces

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

2.2.253.5. Tags

oapiv1

2.2.254. create a Policy

POST /oapi/v1/policies

2.2.254.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.181, “v1.Policy”

2.2.254.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.181, “v1.Policy”

2.2.254.3. Consumes

2.2.254.4. Produces

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

2.2.254.5. Tags

oapiv1

2.2.255. list or watch objects of kind PolicyBinding

GET /oapi/v1/policybindings

2.2.255.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 Code	Description	Schema
200	success	Section 2.3.183, “v1.PolicyBindingList”

2.2.255.3. Consumes

2.2.255.4. Produces

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

2.2.255.5. Tags

oapiv1

2.2.256. create a PolicyBinding

POST /oapi/v1/policybindings

2.2.256.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.182, “v1.PolicyBinding”

2.2.256.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.182, “v1.PolicyBinding”

2.2.256.3. Consumes

2.2.256.4. Produces

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

2.2.256.5. Tags

oapiv1

2.2.257. create a Template

POST /oapi/v1/processedtemplates

2.2.257.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.253, “v1.Template”

2.2.257.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.253, “v1.Template”

2.2.257.3. Consumes

2.2.257.4. Produces

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

2.2.257.5. Tags

oapiv1

2.2.258. list objects of kind ProjectRequest

GET /oapi/v1/projectrequests

2.2.258.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.258.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.258.3. Consumes

2.2.258.4. Produces

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

2.2.258.5. Tags

oapiv1

2.2.259. create a ProjectRequest

POST /oapi/v1/projectrequests

2.2.259.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.190, “v1.ProjectRequest”

2.2.259.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.190, “v1.ProjectRequest”

2.2.259.3. Consumes

2.2.259.4. Produces

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

2.2.259.5. Tags

oapiv1

2.2.260. list or watch objects of kind Project

GET /oapi/v1/projects

2.2.260.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.260.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.189, “v1.ProjectList”

2.2.260.3. Consumes

2.2.260.4. Produces

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

2.2.260.5. Tags

oapiv1

2.2.261. create a Project

POST /oapi/v1/projects

2.2.261.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.188, “v1.Project”

2.2.261.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.188, “v1.Project”

2.2.261.3. Consumes

2.2.261.4. Produces

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

2.2.261.5. Tags

oapiv1

2.2.262. delete a Project

DELETE /oapi/v1/projects/{name}

2.2.262.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	name	name of the Project	true	string

2.2.262.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.262.3. Consumes

2.2.262.4. Produces

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

2.2.262.5. Tags

oapiv1

2.2.263. replace the specified Project

PUT /oapi/v1/projects/{name}

2.2.263.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.188, “v1.Project”
PathParameter	name	name of the Project	true	string

2.2.263.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.188, “v1.Project”

2.2.263.3. Consumes

2.2.263.4. Produces

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

2.2.263.5. Tags

oapiv1

2.2.264. read the specified Project

GET /oapi/v1/projects/{name}

2.2.264.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	name	name of the Project	true	string

2.2.264.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.188, “v1.Project”

2.2.264.3. Consumes

2.2.264.4. Produces

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

2.2.264.5. Tags

oapiv1

2.2.265. partially update the specified Project

PATCH /oapi/v1/projects/{name}

2.2.265.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	name	name of the Project	true	string

2.2.265.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.188, “v1.Project”

2.2.265.3. Consumes

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

2.2.265.4. Produces

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

2.2.265.5. Tags

oapiv1

2.2.266. create a ResourceAccessReview

POST /oapi/v1/resourceaccessreviews

2.2.266.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.198, “v1.ResourceAccessReview”

2.2.266.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.198, “v1.ResourceAccessReview”

2.2.266.3. Consumes

2.2.266.4. Produces

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

2.2.266.5. Tags

oapiv1

2.2.267. list or watch objects of kind RoleBindingRestriction

GET /oapi/v1/rolebindingrestrictions

2.2.267.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.267.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.209, “v1.RoleBindingRestrictionList”

2.2.267.3. Consumes

2.2.267.4. Produces

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

2.2.267.5. Tags

oapiv1

2.2.268. create a RoleBindingRestriction

POST /oapi/v1/rolebindingrestrictions

2.2.268.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.208, “v1.RoleBindingRestriction”

2.2.268.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.208, “v1.RoleBindingRestriction”

2.2.268.3. Consumes

2.2.268.4. Produces

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

2.2.268.5. Tags

oapiv1

2.2.269. list objects of kind RoleBinding

GET /oapi/v1/rolebindings

2.2.269.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.269.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.207, “v1.RoleBindingList”

2.2.269.3. Consumes

2.2.269.4. Produces

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

2.2.269.5. Tags

oapiv1

2.2.270. create a RoleBinding

POST /oapi/v1/rolebindings

2.2.270.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.206, “v1.RoleBinding”

2.2.270.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.206, “v1.RoleBinding”

2.2.270.3. Consumes

2.2.270.4. Produces

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

2.2.270.5. Tags

oapiv1

2.2.271. list objects of kind Role

GET /oapi/v1/roles

2.2.271.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.271.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.211, “v1.RoleList”

2.2.271.3. Consumes

2.2.271.4. Produces

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

2.2.271.5. Tags

oapiv1

2.2.272. create a Role

POST /oapi/v1/roles

2.2.272.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.205, “v1.Role”

2.2.272.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.205, “v1.Role”

2.2.272.3. Consumes

2.2.272.4. Produces

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

2.2.272.5. Tags

oapiv1

2.2.273. list or watch objects of kind Route

GET /oapi/v1/routes

2.2.273.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.273.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.216, “v1.RouteList”

2.2.273.3. Consumes

2.2.273.4. Produces

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

2.2.273.5. Tags

oapiv1

2.2.274. create a Route

POST /oapi/v1/routes

2.2.274.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.213, “v1.Route”

2.2.274.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.213, “v1.Route”

2.2.274.3. Consumes

2.2.274.4. Produces

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

2.2.274.5. Tags

oapiv1

2.2.275. create a SelfSubjectRulesReview

POST /oapi/v1/selfsubjectrulesreviews

2.2.275.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.230, “v1.SelfSubjectRulesReview”

2.2.275.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.230, “v1.SelfSubjectRulesReview”

2.2.275.3. Consumes

2.2.275.4. Produces

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

2.2.275.5. Tags

oapiv1

2.2.276. create a SubjectAccessReview

POST /oapi/v1/subjectaccessreviews

2.2.276.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.241, “v1.SubjectAccessReview”

2.2.276.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.241, “v1.SubjectAccessReview”

2.2.276.3. Consumes

2.2.276.4. Produces

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

2.2.276.5. Tags

oapiv1

2.2.277. create a SubjectRulesReview

POST /oapi/v1/subjectrulesreviews

2.2.277.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.242, “v1.SubjectRulesReview”

2.2.277.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.242, “v1.SubjectRulesReview”

2.2.277.3. Consumes

2.2.277.4. Produces

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

2.2.277.5. Tags

oapiv1

2.2.278. list or watch objects of kind Template

GET /oapi/v1/templates

2.2.278.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 Code	Description	Schema
200	success	Section 2.3.254, “v1.TemplateList”

2.2.278.3. Consumes

2.2.278.4. Produces

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

2.2.278.5. Tags

oapiv1

2.2.279. create a Template

POST /oapi/v1/templates

2.2.279.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.253, “v1.Template”

2.2.279.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.253, “v1.Template”

2.2.279.3. Consumes

2.2.279.4. Produces

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

2.2.279.5. Tags

oapiv1

2.2.280. create an UserIdentityMapping

POST /oapi/v1/useridentitymappings

2.2.280.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.256, “v1.UserIdentityMapping”

2.2.280.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.256, “v1.UserIdentityMapping”

2.2.280.3. Consumes

2.2.280.4. Produces

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

2.2.280.5. Tags

oapiv1

2.2.281. delete an UserIdentityMapping

DELETE /oapi/v1/useridentitymappings/{name}

2.2.281.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	name	name of the UserIdentityMapping	true	string

2.2.281.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.281.3. Consumes

2.2.281.4. Produces

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

2.2.281.5. Tags

oapiv1

2.2.282. replace the specified UserIdentityMapping

PUT /oapi/v1/useridentitymappings/{name}

2.2.282.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.256, “v1.UserIdentityMapping”
PathParameter	name	name of the UserIdentityMapping	true	string

2.2.282.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.256, “v1.UserIdentityMapping”

2.2.282.3. Consumes

2.2.282.4. Produces

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

2.2.282.5. Tags

oapiv1

2.2.283. read the specified UserIdentityMapping

GET /oapi/v1/useridentitymappings/{name}

2.2.283.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	name	name of the UserIdentityMapping	true	string

2.2.283.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.256, “v1.UserIdentityMapping”

2.2.283.3. Consumes

2.2.283.4. Produces

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

2.2.283.5. Tags

oapiv1

2.2.284. partially update the specified UserIdentityMapping

PATCH /oapi/v1/useridentitymappings/{name}

2.2.284.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	name	name of the UserIdentityMapping	true	string

2.2.284.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.256, “v1.UserIdentityMapping”

2.2.284.3. Consumes

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

2.2.284.4. Produces

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

2.2.284.5. Tags

oapiv1

2.2.285. delete collection of User

DELETE /oapi/v1/users

2.2.285.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.285.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.285.3. Consumes

2.2.285.4. Produces

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

2.2.285.5. Tags

oapiv1

2.2.286. list or watch objects of kind User

GET /oapi/v1/users

2.2.286.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.286.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.257, “v1.UserList”

2.2.286.3. Consumes

2.2.286.4. Produces

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

2.2.286.5. Tags

oapiv1

2.2.287. create an User

POST /oapi/v1/users

2.2.287.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.255, “v1.User”

2.2.287.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.255, “v1.User”

2.2.287.3. Consumes

2.2.287.4. Produces

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

2.2.287.5. Tags

oapiv1

2.2.288. delete an User

DELETE /oapi/v1/users/{name}

2.2.288.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	name	name of the User	true	string

2.2.288.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

2.2.288.3. Consumes

2.2.288.4. Produces

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

2.2.288.5. Tags

oapiv1

2.2.289. replace the specified User

PUT /oapi/v1/users/{name}

2.2.289.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.255, “v1.User”
PathParameter	name	name of the User	true	string

2.2.289.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.255, “v1.User”

2.2.289.3. Consumes

2.2.289.4. Produces

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

2.2.289.5. Tags

oapiv1

2.2.290. read the specified User

GET /oapi/v1/users/{name}

2.2.290.1. Parameters

Type	Name	Description	Required	Schema
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.290.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.255, “v1.User”

2.2.290.3. Consumes

2.2.290.4. Produces

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

2.2.290.5. Tags

oapiv1

2.2.291. partially update the specified User

PATCH /oapi/v1/users/{name}

2.2.291.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	name	name of the User	true	string

2.2.291.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.255, “v1.User”

2.2.291.3. Consumes

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

2.2.291.4. Produces

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

2.2.291.5. Tags

oapiv1

2.2.292. watch individual changes to a list of BuildConfig

GET /oapi/v1/watch/buildconfigs

2.2.292.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.292.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.292.3. Consumes

2.2.292.4. Produces

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

2.2.292.5. Tags

oapiv1

2.2.293. watch individual changes to a list of Build

GET /oapi/v1/watch/builds

2.2.293.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.293.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.293.3. Consumes

2.2.293.4. Produces

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

2.2.293.5. Tags

oapiv1

2.2.294. watch individual changes to a list of ClusterNetwork

GET /oapi/v1/watch/clusternetworks

2.2.294.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.294.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.294.3. Consumes

2.2.294.4. Produces

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

2.2.294.5. Tags

oapiv1

2.2.295. watch changes to an object of kind ClusterNetwork

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

2.2.295.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.295.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.295.3. Consumes

2.2.295.4. Produces

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

2.2.295.5. Tags

oapiv1

2.2.296. watch individual changes to a list of ClusterPolicy

GET /oapi/v1/watch/clusterpolicies

2.2.296.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.296.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.296.3. Consumes

2.2.296.4. Produces

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

2.2.296.5. Tags

oapiv1

2.2.297. watch changes to an object of kind ClusterPolicy

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

2.2.297.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.297.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.297.3. Consumes

2.2.297.4. Produces

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

2.2.297.5. Tags

oapiv1

2.2.298. watch individual changes to a list of ClusterPolicyBinding

GET /oapi/v1/watch/clusterpolicybindings

2.2.298.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.298.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.298.3. Consumes

2.2.298.4. Produces

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

2.2.298.5. Tags

oapiv1

2.2.299. watch changes to an object of kind ClusterPolicyBinding

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

2.2.299.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.299.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.299.3. Consumes

2.2.299.4. Produces

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

2.2.299.5. Tags

oapiv1

2.2.300. watch individual changes to a list of ClusterResourceQuota

GET /oapi/v1/watch/clusterresourcequotas

2.2.300.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.300.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.300.3. Consumes

2.2.300.4. Produces

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

2.2.300.5. Tags

oapiv1

2.2.301. watch changes to an object of kind ClusterResourceQuota

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

2.2.301.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 ClusterResourceQuota	true	string

2.2.301.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.301.3. Consumes

2.2.301.4. Produces

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

2.2.301.5. Tags

oapiv1

2.2.302. watch individual changes to a list of DeploymentConfig

GET /oapi/v1/watch/deploymentconfigs

2.2.302.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.302.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.302.3. Consumes

2.2.302.4. Produces

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

2.2.302.5. Tags

oapiv1

2.2.303. watch individual changes to a list of EgressNetworkPolicy

GET /oapi/v1/watch/egressnetworkpolicies

2.2.303.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.303.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.303.3. Consumes

2.2.303.4. Produces

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

2.2.303.5. Tags

oapiv1

2.2.304. watch individual changes to a list of Group

GET /oapi/v1/watch/groups

2.2.304.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.304.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.304.3. Consumes

2.2.304.4. Produces

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

2.2.304.5. Tags

oapiv1

2.2.305. watch changes to an object of kind Group

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

2.2.305.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.305.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.305.3. Consumes

2.2.305.4. Produces

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

2.2.305.5. Tags

oapiv1

2.2.306. watch individual changes to a list of HostSubnet

GET /oapi/v1/watch/hostsubnets

2.2.306.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.306.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.306.3. Consumes

2.2.306.4. Produces

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

2.2.306.5. Tags

oapiv1

2.2.307. watch changes to an object of kind HostSubnet

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

2.2.307.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.307.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.307.3. Consumes

2.2.307.4. Produces

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

2.2.307.5. Tags

oapiv1

2.2.308. watch individual changes to a list of Identity

GET /oapi/v1/watch/identities

2.2.308.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.308.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.308.3. Consumes

2.2.308.4. Produces

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

2.2.308.5. Tags

oapiv1

2.2.309. watch changes to an object of kind Identity

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

2.2.309.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.309.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.309.3. Consumes

2.2.309.4. Produces

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

2.2.309.5. Tags

oapiv1

2.2.310. watch individual changes to a list of Image

GET /oapi/v1/watch/images

2.2.310.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.310.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.310.3. Consumes

2.2.310.4. Produces

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

2.2.310.5. Tags

oapiv1

2.2.311. watch changes to an object of kind Image

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

2.2.311.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.311.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.311.3. Consumes

2.2.311.4. Produces

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

2.2.311.5. Tags

oapiv1

2.2.312. watch individual changes to a list of ImageStream

GET /oapi/v1/watch/imagestreams

2.2.312.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.312.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.312.3. Consumes

2.2.312.4. Produces

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

2.2.312.5. Tags

oapiv1

2.2.313. watch individual changes to a list of BuildConfig

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

2.2.313.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.313.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.313.3. Consumes

2.2.313.4. Produces

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

2.2.313.5. Tags

oapiv1

2.2.314. watch changes to an object of kind BuildConfig

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

2.2.314.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.314.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.314.3. Consumes

2.2.314.4. Produces

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

2.2.314.5. Tags

oapiv1

2.2.315. watch individual changes to a list of Build

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

2.2.315.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.315.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.315.3. Consumes

2.2.315.4. Produces

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

2.2.315.5. Tags

oapiv1

2.2.316. watch changes to an object of kind Build

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

2.2.316.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.316.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.316.3. Consumes

2.2.316.4. Produces

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

2.2.316.5. Tags

oapiv1

2.2.317. watch individual changes to a list of DeploymentConfig

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

2.2.317.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.317.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.317.3. Consumes

2.2.317.4. Produces

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

2.2.317.5. Tags

oapiv1

2.2.318. watch changes to an object of kind DeploymentConfig

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

2.2.318.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.318.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.318.3. Consumes

2.2.318.4. Produces

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

2.2.318.5. Tags

oapiv1

2.2.319. watch individual changes to a list of EgressNetworkPolicy

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

2.2.319.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.319.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.319.3. Consumes

2.2.319.4. Produces

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

2.2.319.5. Tags

oapiv1

2.2.320. watch changes to an object of kind EgressNetworkPolicy

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

2.2.320.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 EgressNetworkPolicy	true	string

2.2.320.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.320.3. Consumes

2.2.320.4. Produces

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

2.2.320.5. Tags

oapiv1

2.2.321. watch individual changes to a list of ImageStream

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

2.2.321.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.321.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.321.3. Consumes

2.2.321.4. Produces

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

2.2.321.5. Tags

oapiv1

2.2.322. watch changes to an object of kind ImageStream

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

2.2.322.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.322.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.322.3. Consumes

2.2.322.4. Produces

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

2.2.322.5. Tags

oapiv1

2.2.323. watch individual changes to a list of Policy

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

2.2.323.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.323.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.323.3. Consumes

2.2.323.4. Produces

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

2.2.323.5. Tags

oapiv1

2.2.324. watch changes to an object of kind Policy

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

2.2.324.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.324.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.324.3. Consumes

2.2.324.4. Produces

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

2.2.324.5. Tags

oapiv1

2.2.325. watch individual changes to a list of PolicyBinding

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

2.2.325.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.325.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.325.3. Consumes

2.2.325.4. Produces

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

2.2.325.5. Tags

oapiv1

2.2.326. watch changes to an object of kind PolicyBinding

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

2.2.326.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.326.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.326.3. Consumes

2.2.326.4. Produces

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

2.2.326.5. Tags

oapiv1

2.2.327. watch individual changes to a list of RoleBindingRestriction

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

2.2.327.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.327.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.327.3. Consumes

2.2.327.4. Produces

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

2.2.327.5. Tags

oapiv1

2.2.328. watch changes to an object of kind RoleBindingRestriction

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

2.2.328.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 RoleBindingRestriction	true	string

2.2.328.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.328.3. Consumes

2.2.328.4. Produces

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

2.2.328.5. Tags

oapiv1

2.2.329. watch individual changes to a list of Route

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

2.2.329.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.329.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.329.3. Consumes

2.2.329.4. Produces

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

2.2.329.5. Tags

oapiv1

2.2.330. watch changes to an object of kind Route

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

2.2.330.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.330.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.330.3. Consumes

2.2.330.4. Produces

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

2.2.330.5. Tags

oapiv1

2.2.331. watch individual changes to a list of Template

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

2.2.331.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.331.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.331.3. Consumes

2.2.331.4. Produces

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

2.2.331.5. Tags

oapiv1

2.2.332. watch changes to an object of kind Template

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

2.2.332.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.332.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.332.3. Consumes

2.2.332.4. Produces

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

2.2.332.5. Tags

oapiv1

2.2.333. watch individual changes to a list of NetNamespace

GET /oapi/v1/watch/netnamespaces

2.2.333.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.333.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.333.3. Consumes

2.2.333.4. Produces

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

2.2.333.5. Tags

oapiv1

2.2.334. watch changes to an object of kind NetNamespace

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

2.2.334.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.334.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.334.3. Consumes

2.2.334.4. Produces

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

2.2.334.5. Tags

oapiv1

2.2.335. watch individual changes to a list of OAuthAccessToken

GET /oapi/v1/watch/oauthaccesstokens

2.2.335.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.335.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.335.3. Consumes

2.2.335.4. Produces

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

2.2.335.5. Tags

oapiv1

2.2.336. watch changes to an object of kind OAuthAccessToken

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

2.2.336.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 OAuthAccessToken	true	string

2.2.336.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.336.3. Consumes

2.2.336.4. Produces

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

2.2.336.5. Tags

oapiv1

2.2.337. watch individual changes to a list of OAuthAuthorizeToken

GET /oapi/v1/watch/oauthauthorizetokens

2.2.337.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.337.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.337.3. Consumes

2.2.337.4. Produces

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

2.2.337.5. Tags

oapiv1

2.2.338. watch changes to an object of kind OAuthAuthorizeToken

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

2.2.338.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 OAuthAuthorizeToken	true	string

2.2.338.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.338.3. Consumes

2.2.338.4. Produces

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

2.2.338.5. Tags

oapiv1

2.2.339. watch individual changes to a list of OAuthClientAuthorization

GET /oapi/v1/watch/oauthclientauthorizations

2.2.339.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.339.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.339.3. Consumes

2.2.339.4. Produces

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

2.2.339.5. Tags

oapiv1

2.2.340. watch changes to an object of kind OAuthClientAuthorization

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

2.2.340.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.340.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.340.3. Consumes

2.2.340.4. Produces

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

2.2.340.5. Tags

oapiv1

2.2.341. watch individual changes to a list of OAuthClient

GET /oapi/v1/watch/oauthclients

2.2.341.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.341.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.341.3. Consumes

2.2.341.4. Produces

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

2.2.341.5. Tags

oapiv1

2.2.342. watch changes to an object of kind OAuthClient

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

2.2.342.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.342.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.342.3. Consumes

2.2.342.4. Produces

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

2.2.342.5. Tags

oapiv1

2.2.343. watch individual changes to a list of Policy

GET /oapi/v1/watch/policies

2.2.343.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.343.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.343.3. Consumes

2.2.343.4. Produces

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

2.2.343.5. Tags

oapiv1

2.2.344. watch individual changes to a list of PolicyBinding

GET /oapi/v1/watch/policybindings

2.2.344.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.344.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.344.3. Consumes

2.2.344.4. Produces

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

2.2.344.5. Tags

oapiv1

2.2.345. watch individual changes to a list of Project

GET /oapi/v1/watch/projects

2.2.345.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.345.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.345.3. Consumes

2.2.345.4. Produces

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

2.2.345.5. Tags

oapiv1

2.2.346. watch changes to an object of kind Project

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

2.2.346.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 Project	true	string

2.2.346.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.346.3. Consumes

2.2.346.4. Produces

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

2.2.346.5. Tags

oapiv1

2.2.347. watch individual changes to a list of RoleBindingRestriction

GET /oapi/v1/watch/rolebindingrestrictions

2.2.347.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.347.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.347.3. Consumes

2.2.347.4. Produces

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

2.2.347.5. Tags

oapiv1

2.2.348. watch individual changes to a list of Route

GET /oapi/v1/watch/routes

2.2.348.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.348.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.348.3. Consumes

2.2.348.4. Produces

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

2.2.348.5. Tags

oapiv1

2.2.349. watch individual changes to a list of Template

GET /oapi/v1/watch/templates

2.2.349.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.349.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.349.3. Consumes

2.2.349.4. Produces

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

2.2.349.5. Tags

oapiv1

2.2.350. watch individual changes to a list of User

GET /oapi/v1/watch/users

2.2.350.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.350.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.350.3. Consumes

2.2.350.4. Produces

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

2.2.350.5. Tags

oapiv1

2.2.351. watch changes to an object of kind User

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

2.2.351.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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.351.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

2.2.351.3. Consumes

2.2.351.4. Produces

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

2.2.351.5. Tags

oapiv1

2.3. Definitions

2.3.1. 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.2. runtime.RawExtension

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

2.3.3. types.UID

2.3.4. unversioned.APIResource

APIResource specifies the name of a resource and whether it is namespaced.

Name	Description	Required	Schema
name	name is the name of the resource.	true	string
namespaced	namespaced indicates if a resource is namespaced or not.	true	boolean
kind	kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')	true	string

2.3.5. unversioned.APIResourceList

APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
groupVersion	groupVersion is the group and version this APIResourceList is for.	true	string
resources	resources contains the name of the resources and if they are namespaced.	true	Section 2.3.4, “unversioned.APIResource” array

2.3.6. unversioned.LabelSelector

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

Name	Description	Required	Schema	Default
matchLabels	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false	object
matchExpressions	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false	Section 2.3.7, “unversioned.LabelSelectorRequirement” array

2.3.7. unversioned.LabelSelectorRequirement

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Description	Required	Schema
key	key is the label key that the selector applies to.	true	string
operator	operator represents a key’s relationship to a set of values. Valid operators ard In, NotIn, Exists and DoesNotExist.	true	string
values	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false	string array

2.3.8. 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}.

Name	Description	Required	Schema	Default
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/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency	false	string

2.3.9. unversioned.Patch

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

2.3.10. unversioned.Status

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

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	Section 2.3.8, “unversioned.ListMeta”
status	Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/HEAD/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.12, “unversioned.StatusDetails”
code	Suggested HTTP return code for this status, 0 if not set.	false	integer (int32)

2.3.11. unversioned.StatusCause

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

Name	Description	Required	Schema
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.12. 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.

Name	Description	Required	Schema
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/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
causes	The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.	false	Section 2.3.11, “unversioned.StatusCause” array
retryAfterSeconds	If specified, the time in seconds before the operation should be retried.	false	integer (int32)

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

Name	Description	Required	Schema
volumeID	Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: http://kubernetes.io/docs/user-guide/volumes#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://kubernetes.io/docs/user-guide/volumes#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://kubernetes.io/docs/user-guide/volumes#awselasticblockstore	false	boolean

2.3.14. v1.AppliedClusterResourceQuota

AppliedClusterResourceQuota mirrors ClusterResourceQuota at a project scope, for projection into a project. It allows a project-admin to know which ClusterResourceQuotas are applied to his project and their associated usage.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	true	Section 2.3.164, “v1.ObjectMeta”
spec	Spec defines the desired quota	true	Section 2.3.51, “v1.ClusterResourceQuotaSpec”
status	Status defines the actual enforced quota and its current usage	false	Section 2.3.52, “v1.ClusterResourceQuotaStatus”

2.3.15. v1.AppliedClusterResourceQuotaList

AppliedClusterResourceQuotaList is a collection of AppliedClusterResourceQuotas

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is a list of AppliedClusterResourceQuota	true	Section 2.3.14, “v1.AppliedClusterResourceQuota” array

2.3.16. v1.AzureDataDiskCachingMode

2.3.17. v1.AzureDiskVolumeSource

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

Name	Description	Required	Schema
diskName	The Name of the data disk in the blob storage	true	string
diskURI	The URI the data disk in the blob storage	true	string
cachingMode	Host Caching mode: None, Read Only, Read Write.	false	Section 2.3.16, “v1.AzureDataDiskCachingMode”
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	Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false	boolean

2.3.18. v1.AzureFileVolumeSource

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

Name	Description	Required	Schema
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.19. 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.

Name	Description	Required	Schema	Default
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.20. 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.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “v1.ObjectMeta”
spec	spec is all the inputs used to execute the build.	false	Section 2.3.31, “v1.BuildSpec”
status	status is the current status of the build.	false	Section 2.3.32, “v1.BuildStatus”

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

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	metadata for BuildConfig.	false	Section 2.3.164, “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.23, “v1.BuildConfigSpec”
status	status holds any relevant information about a build config	true	Section 2.3.24, “v1.BuildConfigStatus”

2.3.22. v1.BuildConfigList

BuildConfigList is a collection of BuildConfigs.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	metadata for BuildConfigList.	false	Section 2.3.8, “unversioned.ListMeta”
items	items is a list of build configs	true	Section 2.3.21, “v1.BuildConfig” array

2.3.23. v1.BuildConfigSpec

BuildConfigSpec describes when and how builds are created

Name	Description	Required	Schema
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.37, “v1.BuildTriggerPolicy” array
runPolicy	RunPolicy describes how the new build created from this build configuration will be scheduled for execution. This is optional, if not specified we default to "Serial".	false	string
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.30, “v1.BuildSource”
revision	revision is the information from the source for a specific repo snapshot. This is optional.	false	Section 2.3.240, “v1.SourceRevision”
strategy	strategy defines how to perform a build.	true	Section 2.3.35, “v1.BuildStrategy”
output	output describes the Docker image the Strategy should produce.	false	Section 2.3.27, “v1.BuildOutput”
resources	resources computes resource requirements to execute the build.	false	Section 2.3.204, “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.28, “v1.BuildPostCommitSpec”
completionDeadlineSeconds	completionDeadlineSeconds is an 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)
nodeSelector	nodeSelector is a selector which must be true for the build pod to fit on a node If nil, it can be overridden by default build nodeselector values for the cluster. If set to an empty map or a map with any values, default build nodeselector values are ignored.	true	object

2.3.24. v1.BuildConfigStatus

BuildConfigStatus contains current state of the build config object.

Name	Description	Required	Schema	Default
lastVersion	lastVersion is used to inform about number of last triggered build.	true	integer (int64)

2.3.25. v1.BuildList

BuildList is a collection of Builds.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	metadata for BuildList.	false	Section 2.3.8, “unversioned.ListMeta”
items	items is a list of builds	true	Section 2.3.20, “v1.Build” array

2.3.26. v1.BuildLog

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

Name	Description	Required	Schema	Default
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string

2.3.27. v1.BuildOutput

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

Name	Description	Required	Schema
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.165, “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.144, “v1.LocalObjectReference”
imageLabels	imageLabels define a list of labels that are applied to the resulting image. If there are multiple labels with the same name then the last one in the list is used.	false	Section 2.3.123, “v1.ImageLabel” array

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

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"]
}

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

Pass arguments to the default entrypoint:

"postCommit": {
 "args": ["rake", "test", "--verbose"]
}

This form is only useful if the image entrypoint can handle arguments.

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.

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.

Name	Description	Required	Schema
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.29. v1.BuildRequest

BuildRequest is the resource used to pass parameters to build generator

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	metadata for BuildRequest.	false	Section 2.3.164, “v1.ObjectMeta”
revision	revision is the information from the source for a specific repo snapshot.	false	Section 2.3.240, “v1.SourceRevision”
triggeredByImage	triggeredByImage is the Image that triggered this build.	false	Section 2.3.165, “v1.ObjectReference”
from	from is the reference to the ImageStreamTag that triggered the build.	false	Section 2.3.165, “v1.ObjectReference”
binary	binary indicates a request to build from a binary provided to the builder	false	Section 2.3.19, “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 (int64)
env	env contains additional environment variables you want to pass into a builder container	false	Section 2.3.91, “v1.EnvVar” array
triggeredBy	triggeredBy describes which triggers started the most recent update to the build configuration and contains information about those triggers.	true	Section 2.3.36, “v1.BuildTriggerCause” array

2.3.30. v1.BuildSource

BuildSource is the SCM used for the build.

Name	Description	Required	Schema
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.19, “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.101, “v1.GitBuildSource”
images	images describes a set of images to be used to provide source for the build	false	Section 2.3.127, “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.144, “v1.LocalObjectReference”
secrets	secrets represents a list of secrets and their destinations that will be used only for the build.	false	Section 2.3.224, “v1.SecretBuildSource” array

2.3.31. v1.BuildSpec

BuildSpec has the information to represent a build and also additional information about a build

Name	Description	Required	Schema
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.30, “v1.BuildSource”
revision	revision is the information from the source for a specific repo snapshot. This is optional.	false	Section 2.3.240, “v1.SourceRevision”
strategy	strategy defines how to perform a build.	true	Section 2.3.35, “v1.BuildStrategy”
output	output describes the Docker image the Strategy should produce.	false	Section 2.3.27, “v1.BuildOutput”
resources	resources computes resource requirements to execute the build.	false	Section 2.3.204, “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.28, “v1.BuildPostCommitSpec”
completionDeadlineSeconds	completionDeadlineSeconds is an 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)
nodeSelector	nodeSelector is a selector which must be true for the build pod to fit on a node If nil, it can be overridden by default build nodeselector values for the cluster. If set to an empty map or a map with any values, default build nodeselector values are ignored.	true	object
triggeredBy	triggeredBy describes which triggers started the most recent update to the build configuration and contains information about those triggers.	true	Section 2.3.36, “v1.BuildTriggerCause” array

2.3.32. v1.BuildStatus

BuildStatus contains the status of a build

Name	Description	Required	Schema
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. Its 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.165, “v1.ObjectReference”
output	output describes the Docker image the build has produced.	false	Section 2.3.33, “v1.BuildStatusOutput”

2.3.33. v1.BuildStatusOutput

BuildStatusOutput contains the status of the built image.

Name	Description	Required	Schema	Default
to	to describes the status of the built image being pushed to a registry.	false	Section 2.3.34, “v1.BuildStatusOutputTo”

2.3.34. v1.BuildStatusOutputTo

BuildStatusOutputTo describes the status of the built image with regards to image registry to which it was supposed to be pushed.

Name	Description	Required	Schema	Default
imageDigest	imageDigest is the digest of the built Docker image. The digest uniquely identifies the image in the registry to which it was pushed. Please note that this field may not always be set even if the push completes successfully - e.g. when the registry returns no digest or returns it in a format that the builder doesn’t understand.	false	string

2.3.35. v1.BuildStrategy

BuildStrategy contains the details of how to perform a build.

Name	Description	Required	Schema
type	type is the kind of build strategy.	true	string
dockerStrategy	dockerStrategy holds the parameters to the Docker build strategy.	false	Section 2.3.82, “v1.DockerBuildStrategy”
sourceStrategy	sourceStrategy holds the parameters to the Source build strategy.	false	Section 2.3.238, “v1.SourceBuildStrategy”
customStrategy	customStrategy holds the parameters to the Custom build strategy	false	Section 2.3.62, “v1.CustomBuildStrategy”
jenkinsPipelineStrategy	JenkinsPipelineStrategy holds the parameters to the Jenkins Pipeline build strategy. This strategy is in tech preview.	false	Section 2.3.140, “v1.JenkinsPipelineBuildStrategy”

2.3.36. v1.BuildTriggerCause

BuildTriggerCause holds information about a triggered build. It is used for displaying build trigger data for each build and build configuration in oc describe. It is also used to describe which triggers led to the most recent update in the build configuration.

Name	Description	Required	Schema
message	message is used to store a human readable message for why the build was triggered. E.g.: "Manually triggered by user", "Configuration change",etc.	false	string
genericWebHook	genericWebHook holds data about a builds generic webhook trigger.	false	Section 2.3.100, “v1.GenericWebHookCause”
githubWebHook	gitHubWebHook represents data for a GitHub webhook that fired a specific build.	false	Section 2.3.102, “v1.GitHubWebHookCause”
imageChangeBuild	imageChangeBuild stores information about an imagechange event that triggered a new build.	false	Section 2.3.119, “v1.ImageChangeCause”

2.3.37. v1.BuildTriggerPolicy

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

Name	Description	Required	Schema
type	type is the type of build trigger	true	string
github	github contains the parameters for a GitHub webhook type of trigger	false	Section 2.3.262, “v1.WebHookTrigger”
generic	generic contains the parameters for a Generic webhook type of trigger	false	Section 2.3.262, “v1.WebHookTrigger”
imageChange	imageChange contains parameters for an ImageChange type of trigger	false	Section 2.3.120, “v1.ImageChangeTrigger”

2.3.38. v1.Capabilities

Adds and removes POSIX capabilities from running containers.

Name	Description	Required	Schema	Default
add	Added capabilities	false	Section 2.3.39, “v1.Capability” array
drop	Removed capabilities	false	Section 2.3.39, “v1.Capability” array

2.3.39. v1.Capability

2.3.40. v1.CephFSVolumeSource

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

Name	Description	Required	Schema
monitors	Required: Monitors is a collection of Ceph monitors More info: http://releases.k8s.io/HEAD/examples/volumes/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/HEAD/examples/volumes/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/HEAD/examples/volumes/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/HEAD/examples/volumes/cephfs/README.md#how-to-use-it	false	Section 2.3.144, “v1.LocalObjectReference”
readOnly	Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it	false	boolean

2.3.41. v1.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. Cinder volumes support ownership management and SELinux relabeling.

Name	Description	Required	Schema
volumeID	volume id used to identify the volume in cinder More info: http://releases.k8s.io/HEAD/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/HEAD/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/HEAD/examples/mysql-cinder-pd/README.md	false	boolean

2.3.42. v1.ClusterNetwork

ClusterNetwork describes the cluster network. There is normally only one object of this type, named "default", which is created by the SDN network plugin based on the master configuration when the cluster is brought up for the first time.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “v1.ObjectMeta”
network	Network is a CIDR string specifying the global overlay network’s L3 space	true	string
hostsubnetlength	HostSubnetLength is the number of bits of network to allocate to each node. eg, 8 would mean that each node would have a /24 slice of the overlay network for its pods	true	integer
serviceNetwork	ServiceNetwork is the CIDR range that Service IP addresses are allocated from	true	string
pluginName	PluginName is the name of the network plugin being used	false	string

2.3.43. v1.ClusterNetworkList

ClusterNetworkList is a collection of ClusterNetworks

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is the list of cluster networks	true	Section 2.3.42, “v1.ClusterNetwork” array

2.3.44. v1.ClusterPolicy

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

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “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.148, “v1.NamedClusterRole” array

2.3.45. v1.ClusterPolicyBinding

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

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “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.165, “v1.ObjectReference”
roleBindings	RoleBindings holds all the ClusterRoleBindings held by this ClusterPolicyBinding, mapped by ClusterRoleBinding.Name	true	Section 2.3.149, “v1.NamedClusterRoleBinding” array

2.3.46. v1.ClusterPolicyBindingList

ClusterPolicyBindingList is a collection of ClusterPolicyBindings

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is a list of ClusterPolicyBindings	true	Section 2.3.45, “v1.ClusterPolicyBinding” array

2.3.47. v1.ClusterPolicyList

ClusterPolicyList is a collection of ClusterPolicies

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is a list of ClusterPolicies	true	Section 2.3.44, “v1.ClusterPolicy” array

2.3.48. v1.ClusterResourceQuota

ClusterResourceQuota mirrors ResourceQuota at a cluster scope. This object is easily convertible to synthetic ResourceQuota object to allow quota evaluation re-use.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	true	Section 2.3.164, “v1.ObjectMeta”
spec	Spec defines the desired quota	true	Section 2.3.51, “v1.ClusterResourceQuotaSpec”
status	Status defines the actual enforced quota and its current usage	false	Section 2.3.52, “v1.ClusterResourceQuotaStatus”

2.3.49. v1.ClusterResourceQuotaList

ClusterResourceQuotaList is a collection of ClusterResourceQuotas

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is a list of ClusterResourceQuotas	true	Section 2.3.48, “v1.ClusterResourceQuota” array

2.3.50. v1.ClusterResourceQuotaSelector

ClusterResourceQuotaSelector is used to select projects. At least one of LabelSelector or AnnotationSelector must present. If only one is present, it is the only selection criteria. If both are specified, the project must match both restrictions.

Name	Description	Required	Schema	Default
labels	LabelSelector is used to select projects by label.	true	Section 2.3.6, “unversioned.LabelSelector”
annotations	AnnotationSelector is used to select projects by annotation.	true	object

2.3.51. v1.ClusterResourceQuotaSpec

ClusterResourceQuotaSpec defines the desired quota restrictions

Name	Description	Required	Schema	Default
selector	Selector is the selector used to match projects. It should only select active projects on the scale of dozens (though it can select many more less active projects). These projects will contend on object creation through this resource.	true	Section 2.3.50, “v1.ClusterResourceQuotaSelector”
quota	Quota defines the desired quota	true	Section 2.3.201, “v1.ResourceQuotaSpec”

2.3.52. v1.ClusterResourceQuotaStatus

ClusterResourceQuotaStatus defines the actual enforced quota and its current usage

Name	Description	Required	Schema	Default
total	Total defines the actual enforced quota and its current usage across all projects	true	Section 2.3.202, “v1.ResourceQuotaStatus”
namespaces	Namespaces slices the usage by project. This division allows for quick resolution of deletion reconciliation inside of a single project without requiring a recalculation across all projects. This can be used to pull the deltas for a given project.	true	Section 2.3.203, “v1.ResourceQuotaStatusByNamespace” array

2.3.53. v1.ClusterRole

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

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “v1.ObjectMeta”
rules	Rules holds all the PolicyRules for this ClusterRole	true	Section 2.3.185, “v1.PolicyRule” array

2.3.54. 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) OR Subjects 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).

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “v1.ObjectMeta”
userNames	UserNames holds all the usernames directly bound to the role. This field should only be specified when supporting legacy clients and servers. See Subjects for further details.	true	string array
groupNames	GroupNames holds all the groups directly bound to the role. This field should only be specified when supporting legacy clients and servers. See Subjects for further details.	true	string array
subjects	Subjects hold object references to authorize with this rule. This field is ignored if UserNames or GroupNames are specified to support legacy clients and servers. Thus newer clients that do not need to support backwards compatibility should send only fully qualified Subjects and should omit the UserNames and GroupNames fields. Clients that need to support backwards compatibility can use this field to build the UserNames and GroupNames.	true	Section 2.3.165, “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.165, “v1.ObjectReference”

2.3.55. v1.ClusterRoleBindingList

ClusterRoleBindingList is a collection of ClusterRoleBindings

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is a list of ClusterRoleBindings	true	Section 2.3.54, “v1.ClusterRoleBinding” array

2.3.56. v1.ClusterRoleList

ClusterRoleList is a collection of ClusterRoles

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is a list of ClusterRoles	true	Section 2.3.53, “v1.ClusterRole” array

2.3.57. v1.ClusterRoleScopeRestriction

ClusterRoleScopeRestriction describes restrictions on cluster role scopes

Name	Description	Required	Schema
roleNames	RoleNames is the list of cluster roles that can referenced. * means anything	true	string array
namespaces	Namespaces is the list of namespaces that can be referenced. * means any of them (including *)	true	string array
allowEscalation	AllowEscalation indicates whether you can request roles and their escalating resources	true	boolean

2.3.58. v1.ConfigMapKeySelector

Selects a key from a ConfigMap.

Name	Description	Required	Schema	Default
name	Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names	false	string
key	The key to select.	true	string

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

Name	Description	Required	Schema
name	Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#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.141, “v1.KeyToPath” array
defaultMode	Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.	false	integer (int32)

2.3.60. v1.Container

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

Name	Description	Required	Schema
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://kubernetes.io/docs/user-guide/images	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://kubernetes.io/docs/user-guide/containers#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://kubernetes.io/docs/user-guide/containers#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.61, “v1.ContainerPort” array
env	List of environment variables to set in the container. Cannot be updated.	false	Section 2.3.91, “v1.EnvVar” array
resources	Compute Resources required by this container. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#resources	false	Section 2.3.204, “v1.ResourceRequirements”
volumeMounts	Pod volumes to mount into the container’s filesystem. Cannot be updated.	false	Section 2.3.260, “v1.VolumeMount” array
livenessProbe	Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes	false	Section 2.3.187, “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://kubernetes.io/docs/user-guide/pod-states#container-probes	false	Section 2.3.187, “v1.Probe”
lifecycle	Actions that the management system should take in response to container lifecycle events. Cannot be updated.	false	Section 2.3.142, “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://kubernetes.io/docs/user-guide/images#updating-images	false	string
securityContext	Security options the pod should run with. More info: http://releases.k8s.io/HEAD/docs/design/security_context.md	false	Section 2.3.229, “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.61. v1.ContainerPort

ContainerPort represents a network port in a single container.

Name	Description	Required	Schema
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.62. v1.CustomBuildStrategy

CustomBuildStrategy defines input parameters specific to Custom build.

Name	Description	Required	Schema
from	from is reference to an DockerImage, ImageStreamTag, or ImageStreamImage from which the docker image should be pulled	true	Section 2.3.165, “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.144, “v1.LocalObjectReference”
env	env contains additional environment variables you want to pass into a builder container	false	Section 2.3.91, “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.227, “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.63. v1.CustomDeploymentStrategyParams

CustomDeploymentStrategyParams are the input to the Custom deployment strategy.

Name	Description	Required	Schema
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.91, “v1.EnvVar” array
command	Command is optional and overrides CMD in the container Image.	false	string array

2.3.64. v1.DeleteOptions

DeleteOptions may be provided when deleting an API object

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer (int64)
preconditions	Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.	false	Section 2.3.186, “v1.Preconditions”
orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean

2.3.65. v1.DeploymentCause

DeploymentCause captures information about a particular cause of a deployment.

Name	Description	Required	Schema	Default
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.66, “v1.DeploymentCauseImageTrigger”

2.3.66. v1.DeploymentCauseImageTrigger

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

Name	Description	Required	Schema	Default
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.165, “v1.ObjectReference”

2.3.67. v1.DeploymentCondition

DeploymentCondition describes the state of a deployment config at a certain point.

Name	Description	Required	Schema
type	Type of deployment condition.	true	string
status	Status of the condition, one of True, False, Unknown.	true	string
lastUpdateTime	The last time this condition was updated.	false	string
lastTransitionTime	The last time the condition transitioned from one status to another.	false	string
reason	The reason for the condition’s last transition.	false	string
message	A human readable message indicating details about the transition.	false	string

2.3.68. 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. The latestVersion field is updated when a new deployment is triggered by any means.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “v1.ObjectMeta”
spec	Spec represents a desired deployment state and how to deploy to it.	true	Section 2.3.72, “v1.DeploymentConfigSpec”
status	Status represents the current deployment state.	true	Section 2.3.73, “v1.DeploymentConfigStatus”

2.3.69. v1.DeploymentConfigList

DeploymentConfigList is a collection of deployment configs.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is a list of deployment configs	true	Section 2.3.68, “v1.DeploymentConfig” array

2.3.70. v1.DeploymentConfigRollback

DeploymentConfigRollback provides the input to rollback generation.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
name	Name of the deployment config that will be rolled back.	true	string
updatedAnnotations	UpdatedAnnotations is a set of new annotations that will be added in the deployment config.	false	object
spec	Spec defines the options to rollback generation.	true	Section 2.3.71, “v1.DeploymentConfigRollbackSpec”

2.3.71. v1.DeploymentConfigRollbackSpec

DeploymentConfigRollbackSpec represents the options for rollback generation.

Name	Description	Required	Schema
from	From points to a ReplicationController which is a deployment.	true	Section 2.3.165, “v1.ObjectReference”
revision	Revision to rollback to. If set to 0, rollback to the last revision.	false	integer (int64)
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.72. v1.DeploymentConfigSpec

DeploymentConfigSpec represents the desired state of the deployment.

Name	Description	Required	Schema
strategy	Strategy describes how a deployment is executed.	true	Section 2.3.77, “v1.DeploymentStrategy”
minReadySeconds	MinReadySeconds is the minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)	false	integer (int32)
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. If null, defaults to having a config change trigger.	true	Section 2.3.79, “v1.DeploymentTriggerPolicy” array
replicas	Replicas is the number of desired replicas.	true	integer (int32)
revisionHistoryLimit	RevisionHistoryLimit is the number of old ReplicationControllers to retain to allow for rollbacks. This field is a pointer to allow for differentiation between an explicit zero and not specified.	false	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
paused	Paused indicates that the deployment config is paused resulting in no new deployments on template changes or changes in the template caused by other triggers.	false	boolean
selector	Selector is a label query over pods that should match the Replicas count.	false	object
template	Template is the object that describes the pod that will be created if insufficient replicas are detected.	false	Section 2.3.180, “v1.PodTemplateSpec”

2.3.73. v1.DeploymentConfigStatus

DeploymentConfigStatus represents the current deployment state.

Name	Description	Required	Schema
latestVersion	LatestVersion is used to determine whether the current deployment associated with a deployment config is out of sync.	true	integer (int64)
observedGeneration	ObservedGeneration is the most recent generation observed by the deployment config controller.	true	integer (int64)
replicas	Replicas is the total number of pods targeted by this deployment config.	true	integer (int32)
updatedReplicas	UpdatedReplicas is the total number of non-terminated pods targeted by this deployment config that have the desired template spec.	true	integer (int32)
availableReplicas	AvailableReplicas is the total number of available pods targeted by this deployment config.	true	integer (int32)
unavailableReplicas	UnavailableReplicas is the total number of unavailable pods targeted by this deployment config.	true	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.74, “v1.DeploymentDetails”
conditions	Conditions represents the latest available observations of a deployment config’s current state.	false	Section 2.3.67, “v1.DeploymentCondition” array
readyReplicas	Total number of ready pods targeted by this deployment.	false	integer (int32)

2.3.74. v1.DeploymentDetails

DeploymentDetails captures information about the causes of a deployment.

Name	Description	Required	Schema	Default
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	true	Section 2.3.65, “v1.DeploymentCause” array

2.3.75. v1.DeploymentLog

DeploymentLog represents the logs for a deployment

Name	Description	Required	Schema	Default
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string

2.3.76. v1.DeploymentRequest

DeploymentRequest is a request to a deployment config for a new deployment.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
name	Name of the deployment config for requesting a new deployment.	true	string
latest	Latest will update the deployment config with the latest state from all triggers.	true	boolean
force	Force will try to force a new deployment to run. If the deployment config is paused, then setting this to true will return an Invalid error.	true	boolean

2.3.77. v1.DeploymentStrategy

DeploymentStrategy describes how to perform a deployment.

Name	Description	Required	Schema
type	Type is the name of a deployment strategy.	false	string
customParams	CustomParams are the input to the Custom deployment strategy, and may also be specified for the Recreate and Rolling strategies to customize the execution process that runs the deployment.	false	Section 2.3.63, “v1.CustomDeploymentStrategyParams”
recreateParams	RecreateParams are the input to the Recreate deployment strategy.	false	Section 2.3.195, “v1.RecreateDeploymentStrategyParams”
rollingParams	RollingParams are the input to the Rolling deployment strategy.	false	Section 2.3.212, “v1.RollingDeploymentStrategyParams”
resources	Resources contains resource requirements to execute the deployment and any hooks.	false	Section 2.3.204, “v1.ResourceRequirements”
labels	Labels is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods.	false	object
annotations	Annotations is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods.	false	object
activeDeadlineSeconds	ActiveDeadlineSeconds is the duration in seconds that the deployer pods for this deployment config may be active on a node before the system actively tries to terminate them.	false	integer (int64)

2.3.78. v1.DeploymentTriggerImageChangeParams

DeploymentTriggerImageChangeParams represents the parameters to the ImageChange trigger.

Name	Description	Required	Schema
automatic	Automatic means that the detection of a new tag value should result in an image update inside the pod template.	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.165, “v1.ObjectReference”
lastTriggeredImage	LastTriggeredImage is the last image to be triggered.	false	string

2.3.79. v1.DeploymentTriggerPolicy

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

Name	Description	Required	Schema	Default
type	Type of the trigger	false	string
imageChangeParams	ImageChangeParams represents the parameters for the ImageChange trigger.	false	Section 2.3.78, “v1.DeploymentTriggerImageChangeParams”

2.3.80. v1.DeprecatedDownwardAPIVolumeFile

DeprecatedDownwardAPIVolumeFile represents information to create the file containing the pod field This type is deprecated and should be replaced by use of the downwardAPI volume source.

Name	Description	Required	Schema
name	Required: Name 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.	false	Section 2.3.163, “v1.ObjectFieldSelector”
resourceFieldRef	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false	Section 2.3.199, “v1.ResourceFieldSelector”
mode	Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.	false	integer (int32)

2.3.81. v1.DeprecatedDownwardAPIVolumeSource

DeprecatedDownwardAPIVolumeSource represents a volume containing downward API info. This type is deprecated and should be replaced by use of the downwardAPI volume source.

Name	Description	Required	Schema	Default
items	Items is a list of downward API volume file	false	Section 2.3.80, “v1.DeprecatedDownwardAPIVolumeFile” array
defaultMode	Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.	false	integer (int32)

2.3.82. v1.DockerBuildStrategy

DockerBuildStrategy defines input parameters specific to Docker build.

Name	Description	Required	Schema
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.165, “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.144, “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.91, “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.83. v1.DownwardAPIVolumeFile

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Description	Required	Schema
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.	false	Section 2.3.163, “v1.ObjectFieldSelector”
resourceFieldRef	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false	Section 2.3.199, “v1.ResourceFieldSelector”
mode	Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.	false	integer (int32)

2.3.84. v1.DownwardAPIVolumeSource

DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.

Name	Description	Required	Schema	Default
items	Items is a list of downward API volume file	false	Section 2.3.83, “v1.DownwardAPIVolumeFile” array
defaultMode	Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.	false	integer (int32)

2.3.85. v1.EgressNetworkPolicy

EgressNetworkPolicy describes the current egress network policy for a Namespace. When using the 'redhat/openshift-ovs-multitenant' network plugin, traffic from a pod to an IP address outside the cluster will be checked against each EgressNetworkPolicyRule in the pod’s namespace’s EgressNetworkPolicy, in order. If no rule matches (or no EgressNetworkPolicy is present) then the traffic will be allowed by default.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	metadata for EgressNetworkPolicy	false	Section 2.3.164, “v1.ObjectMeta”
spec	spec is the specification of the current egress network policy	true	Section 2.3.89, “v1.EgressNetworkPolicySpec”

2.3.86. v1.EgressNetworkPolicyList

EgressNetworkPolicyList is a collection of EgressNetworkPolicy

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	metadata for EgressNetworkPolicyList	false	Section 2.3.8, “unversioned.ListMeta”
items	items is the list of policies	true	Section 2.3.85, “v1.EgressNetworkPolicy” array

2.3.87. v1.EgressNetworkPolicyPeer

EgressNetworkPolicyPeer specifies a target to apply egress network policy to

Name	Description	Required	Schema	Default
cidrSelector	cidrSelector is the CIDR range to allow/deny traffic to	true	string

2.3.88. v1.EgressNetworkPolicyRule

EgressNetworkPolicyRule contains a single egress network policy rule

Name	Description	Required	Schema	Default
type	type marks this as an "Allow" or "Deny" rule	true	string
to	to is the target that traffic is allowed/denied to	true	Section 2.3.87, “v1.EgressNetworkPolicyPeer”

2.3.89. v1.EgressNetworkPolicySpec

EgressNetworkPolicySpec provides a list of policies on outgoing network traffic

Name	Description	Required	Schema	Default
egress	egress contains the list of egress policy rules	true	Section 2.3.88, “v1.EgressNetworkPolicyRule” array

2.3.90. v1.EmptyDirVolumeSource

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

Name	Description	Required	Schema	Default
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://kubernetes.io/docs/user-guide/volumes#emptydir	false	string

2.3.91. v1.EnvVar

EnvVar represents an environment variable present in a Container.

Name	Description	Required	Schema
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.92, “v1.EnvVarSource”

2.3.92. v1.EnvVarSource

EnvVarSource represents a source for the value of an EnvVar.

Name	Description	Required	Schema
fieldRef	Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP.	false	Section 2.3.163, “v1.ObjectFieldSelector”
resourceFieldRef	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false	Section 2.3.199, “v1.ResourceFieldSelector”
configMapKeyRef	Selects a key of a ConfigMap.	false	Section 2.3.58, “v1.ConfigMapKeySelector”
secretKeyRef	Selects a key of a secret in the pod’s namespace	false	Section 2.3.225, “v1.SecretKeySelector”

2.3.93. v1.ExecAction

ExecAction describes a "run in container" action.

Name	Description	Required	Schema	Default
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.94. 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.

Name	Description	Required	Schema
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.91, “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.95. 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.

Name	Description	Required	Schema
targetWWNs	Required: FC target worldwide 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.96. v1.FinalizerName

2.3.97. v1.FlexVolumeSource

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.

Name	Description	Required	Schema
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 secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.	false	Section 2.3.144, “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	object

2.3.98. v1.FlockerVolumeSource

Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.

Name	Description	Required	Schema	Default
datasetName	Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated	false	string
datasetUUID	UUID of the dataset. This is unique identifier of a Flocker dataset	false	string

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

Name	Description	Required	Schema
pdName	Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: http://kubernetes.io/docs/user-guide/volumes#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://kubernetes.io/docs/user-guide/volumes#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://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk	false	integer (int32)
readOnly	ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk	false	boolean

2.3.100. v1.GenericWebHookCause

GenericWebHookCause holds information about a generic WebHook that triggered a build.

Name	Description	Required	Schema	Default
revision	revision is an optional field that stores the git source revision information of the generic webhook trigger when it is available.	false	Section 2.3.240, “v1.SourceRevision”
secret	secret is the obfuscated webhook secret that triggered a build.	false	string

2.3.101. v1.GitBuildSource

GitBuildSource defines the parameters of a Git SCM

Name	Description	Required	Schema
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
noProxy	noProxy is the list of domains for which the proxy should not be used	false	string

2.3.102. v1.GitHubWebHookCause

GitHubWebHookCause has information about a GitHub webhook that triggered a build.

Name	Description	Required	Schema	Default
revision	revision is the git revision information of the trigger.	false	Section 2.3.240, “v1.SourceRevision”
secret	secret is the obfuscated webhook secret that triggered a build.	false	string

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

Name	Description	Required	Schema
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.104. v1.GitSourceRevision

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

Name	Description	Required	Schema
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.239, “v1.SourceControlUser”
committer	committer is the committer of a specific commit	false	Section 2.3.239, “v1.SourceControlUser”
message	message is the description of a specific commit	false	string

2.3.105. v1.GlusterfsVolumeSource

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

Name	Description	Required	Schema
endpoints	EndpointsName is the endpoint name that details Glusterfs topology. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod	true	string
path	Path is the Glusterfs volume path. More info: http://releases.k8s.io/HEAD/examples/volumes/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/HEAD/examples/volumes/glusterfs/README.md#create-a-pod	false	boolean

2.3.106. v1.Group

Group represents a referenceable set of Users

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “v1.ObjectMeta”
users	Users is the list of users in this group.	true	string array

2.3.107. v1.GroupList

GroupList is a collection of Groups

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is the list of groups	true	Section 2.3.106, “v1.Group” array

2.3.108. v1.GroupRestriction

GroupRestriction matches a group either by a string match on the group name or a label selector applied to group labels.

Name	Description	Required	Schema	Default
groups	Groups is a list of groups used to match against an individual user’s groups. If the user is a member of one of the whitelisted groups, the user is allowed to be bound to a role.	true	string array
labels	Selectors specifies a list of label selectors over group labels.	true	Section 2.3.6, “unversioned.LabelSelector” array

2.3.109. v1.HTTPGetAction

HTTPGetAction describes an action based on HTTP Get requests.

Name	Description	Required	Schema
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.110, “v1.HTTPHeader” array

2.3.110. v1.HTTPHeader

HTTPHeader describes a custom header to be used in HTTP probes

Name	Description	Required	Schema	Default
name	The header field name	true	string
value	The header field value	true	string

2.3.111. v1.Handler

Handler defines a specific action that should be taken

Name	Description	Required	Schema
exec	One and only one of the following should be specified. Exec specifies the action to take.	false	Section 2.3.93, “v1.ExecAction”
httpGet	HTTPGet specifies the http request to perform.	false	Section 2.3.109, “v1.HTTPGetAction”
tcpSocket	TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported	false	Section 2.3.245, “v1.TCPSocketAction”

2.3.112. v1.HostPathVolumeSource

Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.

Name	Description	Required	Schema	Default
path	Path of the directory on the host. More info: http://kubernetes.io/docs/user-guide/volumes#hostpath	true	string

2.3.113. v1.HostSubnet

HostSubnet describes the container subnet network on a node. The HostSubnet object must have the same name as the Node object it corresponds to.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “v1.ObjectMeta”
host	Host is the name of the node. (This is redundant with the object’s name, and this field is not actually used any more.)	true	string
hostIP	HostIP is the IP address to be used as a VTEP by other nodes in the overlay network	true	string
subnet	Subnet is the CIDR range of the overlay network assigned to the node for its pods	true	string

2.3.114. v1.HostSubnetList

HostSubnetList is a collection of HostSubnets

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is the list of host subnets	true	Section 2.3.113, “v1.HostSubnet” array

2.3.115. v1.ISCSIVolumeSource

Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.

Name	Description	Required	Schema
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://kubernetes.io/docs/user-guide/volumes#iscsi	false	string
readOnly	ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.	false	boolean

2.3.116. v1.Identity

Identity records a successful authentication of a user with an identity provider. The information about the source of authentication is stored on the identity, and the identity is then associated with a single user object. Multiple identities can reference a single user. Information retrieved from the authentication provider is stored in the extra field using a schema determined by the provider.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “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.165, “v1.ObjectReference”
extra	Extra holds extra information about this identity	false	object

2.3.117. v1.IdentityList

IdentityList is a collection of Identities

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is the list of identities	true	Section 2.3.116, “v1.Identity” array

2.3.118. v1.Image

Image is an immutable representation of a Docker image and metadata at a point in time.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “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.124, “v1.ImageLayer” array
signatures	Signatures holds all signatures of the image.	false	Section 2.3.126, “v1.ImageSignature” array
dockerImageSignatures	DockerImageSignatures provides the signatures as opaque blobs. This is a part of manifest schema v1.	false	v1.Image.dockerImageSignatures array
dockerImageManifestMediaType	DockerImageManifestMediaType specifies the mediaType of manifest. This is a part of manifest schema v2.	false	string
dockerImageConfig	DockerImageConfig is a JSON blob that the runtime uses to set up the container. This is a part of manifest schema v2.	false	string

2.3.119. v1.ImageChangeCause

ImageChangeCause contains information about the image that triggered a build

Name	Description	Required	Schema	Default
imageID	imageID is the ID of the image that triggered a a new build.	false	string
fromRef	fromRef contains detailed information about an image that triggered a build.	false	Section 2.3.165, “v1.ObjectReference”

2.3.120. v1.ImageChangeTrigger

ImageChangeTrigger allows builds to be triggered when an ImageStream changes

Name	Description	Required	Schema	Default
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.165, “v1.ObjectReference”

2.3.121. v1.ImageImportSpec

ImageImportSpec describes a request to import a specific image.

Name	Description	Required	Schema
from	From is the source of an image to import; only kind DockerImage is allowed	true	Section 2.3.165, “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.144, “v1.LocalObjectReference”
importPolicy	ImportPolicy is the policy controlling how the image is imported	false	Section 2.3.250, “v1.TagImportPolicy”
includeManifest	IncludeManifest determines if the manifest for each image is returned in the response	false	boolean

2.3.122. v1.ImageImportStatus

ImageImportStatus describes the result of an image import.

Name	Description	Required	Schema
status	Status is the status of the image import, including errors encountered while retrieving the image	true	Section 2.3.10, “unversioned.Status”
image	Image is the metadata of that image, if the image was located	false	Section 2.3.118, “v1.Image”
tag	Tag is the tag this image was located under, if any	false	string

2.3.123. v1.ImageLabel

ImageLabel represents a label applied to the resulting image.

Name	Description	Required	Schema	Default
name	name defines the name of the label. It must have non-zero length.	true	string
value	value defines the literal value of the label.	false	string

2.3.124. v1.ImageLayer

ImageLayer represents a single layer of the image. Some images may have multiple layers. Some may have none.

Name	Description	Required	Schema
name	Name of the layer as defined by the underlying store.	true	string
size	Size of the layer in bytes as defined by the underlying store.	true	integer (int64)
mediaType	MediaType of the referenced object.	true	string

2.3.125. v1.ImageList

ImageList is a list of Image objects.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is a list of images	true	Section 2.3.118, “v1.Image” array

2.3.126. v1.ImageSignature

ImageSignature holds a signature of an image. It allows to verify image identity and possibly other claims as long as the signature is trusted. Based on this information it is possible to restrict runnable images to those matching cluster-wide policy. Mandatory fields should be parsed by clients doing image verification. The others are parsed from signature’s content by the server. They serve just an informative purpose.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “v1.ObjectMeta”
type	Required: Describes a type of stored blob.	true	string
content	Required: An opaque binary string which is an image’s signature.	true	string
conditions	Conditions represent the latest available observations of a signature’s current state.	false	Section 2.3.235, “v1.SignatureCondition” array
imageIdentity	A human readable string representing image’s identity. It could be a product name and version, or an image pull spec (e.g. "registry.access.redhat.com/rhel7/rhel:7.2").	false	string
signedClaims	Contains claims from the signature.	false	object
created	If specified, it is the time of signature’s creation.	false	string
issuedBy	If specified, it holds information about an issuer of signing certificate or key (a person or entity who signed the signing certificate or key).	false	Section 2.3.236, “v1.SignatureIssuer”
issuedTo	If specified, it holds information about a subject of signing certificate or key (a person or entity who signed the image).	false	Section 2.3.237, “v1.SignatureSubject”

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

Name	Description	Required	Schema
from	from is a reference to an ImageStreamTag, ImageStreamImage, or DockerImage to copy source from.	true	Section 2.3.165, “v1.ObjectReference”
paths	paths is a list of source and destination paths to copy from the image.	true	Section 2.3.128, “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 registry, this field does not need to be set.	false	Section 2.3.144, “v1.LocalObjectReference”

2.3.128. v1.ImageSourcePath

ImageSourcePath describes a path to be copied from a source image and its destination within the build directory.

Name	Description	Required	Schema	Default
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.129. 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.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “v1.ObjectMeta”
spec	Spec describes the desired state of this stream	true	Section 2.3.136, “v1.ImageStreamSpec”
status	Status describes the current state of this stream	false	Section 2.3.137, “v1.ImageStreamStatus”

2.3.130. v1.ImageStreamImage

ImageStreamImage represents an Image that is retrieved by image name from an ImageStream.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “v1.ObjectMeta”
image	Image associated with the ImageStream and image name.	true	Section 2.3.118, “v1.Image”

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

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “v1.ObjectMeta”
spec	Spec is a description of the images that the user wishes to import	true	Section 2.3.132, “v1.ImageStreamImportSpec”
status	Status is the the result of importing the image	true	Section 2.3.133, “v1.ImageStreamImportStatus”

2.3.132. v1.ImageStreamImportSpec

ImageStreamImportSpec defines what images should be imported.

Name	Description	Required	Schema
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.196, “v1.RepositoryImportSpec”
images	Images are a list of individual images to import.	false	Section 2.3.121, “v1.ImageImportSpec” array

2.3.133. v1.ImageStreamImportStatus

ImageStreamImportStatus contains information about the status of an image stream import.

Name	Description	Required	Schema
import	Import is the image stream that was successfully updated or created when 'to' was set.	false	Section 2.3.129, “v1.ImageStream”
repository	Repository is set if spec.repository was set to the outcome of the import	false	Section 2.3.197, “v1.RepositoryImportStatus”
images	Images is set with the result of importing spec.images	false	Section 2.3.122, “v1.ImageImportStatus” array

2.3.134. v1.ImageStreamList

ImageStreamList is a list of ImageStream objects.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is a list of imageStreams	true	Section 2.3.129, “v1.ImageStream” array

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

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “v1.ObjectMeta”
image	Image is a Docker image.	true	Section 2.3.118, “v1.Image”
tag	Tag is a string value this image can be located with inside the stream.	true	string

2.3.136. v1.ImageStreamSpec

ImageStreamSpec represents options for ImageStreams.

Name	Description	Required	Schema	Default
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.251, “v1.TagReference” array

2.3.137. v1.ImageStreamStatus

ImageStreamStatus contains information about the state of this image stream.

Name	Description	Required	Schema	Default
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.152, “v1.NamedTagEventList” array

2.3.138. v1.ImageStreamTag

ImageStreamTag represents an Image that is retrieved by tag name from an ImageStream.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “v1.ObjectMeta”
tag	Tag is the spec tag associated with this image stream tag, and it may be null if only pushes have occurred to this image stream.	true	Section 2.3.251, “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.248, “v1.TagEventCondition” array
image	Image associated with the ImageStream and tag.	true	Section 2.3.118, “v1.Image”

2.3.139. v1.ImageStreamTagList

ImageStreamTagList is a list of ImageStreamTag objects.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is the list of image stream tags	true	Section 2.3.138, “v1.ImageStreamTag” array

2.3.140. v1.JenkinsPipelineBuildStrategy

JenkinsPipelineBuildStrategy holds parameters specific to a Jenkins Pipeline build. This strategy is in tech preview.

Name	Description	Required	Schema	Default
jenkinsfilePath	JenkinsfilePath is the optional path of the Jenkinsfile that will be used to configure the pipeline relative to the root of the context (contextDir). If both JenkinsfilePath & Jenkinsfile are both not specified, this defaults to Jenkinsfile in the root of the specified contextDir.	false	string
jenkinsfile	Jenkinsfile defines the optional raw contents of a Jenkinsfile which defines a Jenkins pipeline build.	false	string

2.3.141. v1.KeyToPath

Maps a string key to a path within a volume.

Name	Description	Required	Schema
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
mode	Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.	false	integer (int32)

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

Name	Description	Required	Schema	Default
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://kubernetes.io/docs/user-guide/container-environment#hook-details	false	Section 2.3.111, “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://kubernetes.io/docs/user-guide/container-environment#hook-details	false	Section 2.3.111, “v1.Handler”

2.3.143. v1.LifecycleHook

LifecycleHook defines a specific deployment lifecycle action. Only one type of action may be specified at any time.

Name	Description	Required	Schema
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.94, “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.249, “v1.TagImageHook” array

2.3.144. v1.LocalObjectReference

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

Name	Description	Required	Schema	Default
name	Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names	false	string

2.3.145. v1.LocalResourceAccessReview

LocalResourceAccessReview is a means to request a list of which users and groups are authorized to perform the action specified by spec in a particular namespace

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
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
path	Path is the path of a non resource URL	true	string
isNonResourceURL	IsNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hieraarchy)	true	boolean
content	Content is the actual content of the request for create and update	false	string

2.3.146. v1.LocalSubjectAccessReview

LocalSubjectAccessReview is an object for requesting information about whether a user or group can perform an action in a particular namespace

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
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
path	Path is the path of a non resource URL	true	string
isNonResourceURL	IsNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hieraarchy)	true	boolean
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
scopes	Scopes to use for the evaluation. Empty means "use the unscoped (full) permissions of the user/groups". Nil for a self-SAR, means "use the scopes on this request". Nil for a regular SAR, means the same as empty.	true	string array

2.3.147. v1.NFSVolumeSource

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

Name	Description	Required	Schema
server	Server is the hostname or IP address of the NFS server. More info: http://kubernetes.io/docs/user-guide/volumes#nfs	true	string
path	Path that is exported by the NFS server. More info: http://kubernetes.io/docs/user-guide/volumes#nfs	true	string
readOnly	ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: http://kubernetes.io/docs/user-guide/volumes#nfs	false	boolean

2.3.148. v1.NamedClusterRole

NamedClusterRole relates a name with a cluster role

Name	Description	Required	Schema	Default
name	Name is the name of the cluster role	true	string
role	Role is the cluster role being named	true	Section 2.3.53, “v1.ClusterRole”

2.3.149. v1.NamedClusterRoleBinding

NamedClusterRoleBinding relates a name with a cluster role binding

Name	Description	Required	Schema	Default
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.54, “v1.ClusterRoleBinding”

2.3.150. v1.NamedRole

NamedRole relates a Role with a name

Name	Description	Required	Schema	Default
name	Name is the name of the role	true	string
role	Role is the role being named	true	Section 2.3.205, “v1.Role”

2.3.151. v1.NamedRoleBinding

NamedRoleBinding relates a role binding with a name

Name	Description	Required	Schema	Default
name	Name is the name of the role binding	true	string
roleBinding	RoleBinding is the role binding being named	true	Section 2.3.206, “v1.RoleBinding”

2.3.152. v1.NamedTagEventList

NamedTagEventList relates a tag to its image history.

Name	Description	Required	Schema
tag	Tag is the tag for which the history is recorded	true	string
items	Standard object’s metadata.	true	Section 2.3.247, “v1.TagEvent” array
conditions	Conditions is an array of conditions that apply to the tag event list.	false	Section 2.3.248, “v1.TagEventCondition” array

2.3.153. v1.NetNamespace

NetNamespace describes a single isolated network. When using the redhat/openshift-ovs-multitenant plugin, every Namespace will have a corresponding NetNamespace object with the same name. (When using redhat/openshift-ovs-subnet, NetNamespaces are not used.)

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “v1.ObjectMeta”
netname	NetName is the name of the network namespace. (This is the same as the object’s name, but both fields must be set.)	true	string
netid	NetID is the network identifier of the network namespace assigned to each overlay network packet. This can be manipulated with the "oc adm pod-network" commands.	true	integer

2.3.154. v1.NetNamespaceList

NetNamespaceList is a collection of NetNamespaces

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is the list of net namespaces	true	Section 2.3.153, “v1.NetNamespace” array

2.3.155. v1.OAuthAccessToken

OAuthAccessToken describes an OAuth access token

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “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.156. v1.OAuthAccessTokenList

OAuthAccessTokenList is a collection of OAuth access tokens

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is the list of OAuth access tokens	true	Section 2.3.155, “v1.OAuthAccessToken” array

2.3.157. v1.OAuthAuthorizeToken

OAuthAuthorizeToken describes an OAuth authorization token

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “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
codeChallenge	CodeChallenge is the optional code_challenge associated with this authorization code, as described in rfc7636	false	string
codeChallengeMethod	CodeChallengeMethod is the optional code_challenge_method associated with this authorization code, as described in rfc7636	false	string

2.3.158. v1.OAuthAuthorizeTokenList

OAuthAuthorizeTokenList is a collection of OAuth authorization tokens

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is the list of OAuth authorization tokens	true	Section 2.3.157, “v1.OAuthAuthorizeToken” array

2.3.159. v1.OAuthClient

OAuthClient describes an OAuth client

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “v1.ObjectMeta”
secret	Secret is the unique secret associated with a client	false	string
additionalSecrets	AdditionalSecrets holds other secrets that may be used to identify the client. This is useful for rotation and for service account token validation	false	string array
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
grantMethod	GrantMethod determines how to handle grants for this client. If no method is provided, the cluster default grant handling method will be used. Valid grant handling methods are: - auto: always approves grant requests, useful for trusted clients - prompt: prompts the end user for approval of grant requests, useful for third-party clients - deny: always denies grant requests, useful for black-listed clients	false	string
scopeRestrictions	ScopeRestrictions describes which scopes this client can request. Each requested scope is checked against each restriction. If any restriction matches, then the scope is allowed. If no restriction matches, then the scope is denied.	false	Section 2.3.222, “v1.ScopeRestriction” array

2.3.160. v1.OAuthClientAuthorization

OAuthClientAuthorization describes an authorization created by an OAuth client

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “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.161. v1.OAuthClientAuthorizationList

OAuthClientAuthorizationList is a collection of OAuth client authorizations

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is the list of OAuth client authorizations	true	Section 2.3.160, “v1.OAuthClientAuthorization” array

2.3.162. v1.OAuthClientList

OAuthClientList is a collection of OAuth clients

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is the list of OAuth clients	true	Section 2.3.159, “v1.OAuthClient” array

2.3.163. v1.ObjectFieldSelector

ObjectFieldSelector selects an APIVersioned field of an object.

Name	Description	Required	Schema	Default
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.164. v1.ObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

Name	Description	Required	Schema
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://kubernetes.io/docs/user-guide/identifiers#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/HEAD/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://kubernetes.io/docs/user-guide/namespaces	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://kubernetes.io/docs/user-guide/identifiers#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/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency	false	string
generation	A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.	false	integer (int64)
creationTimestamp	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/HEAD/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 is expected to 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. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. 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/HEAD/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://kubernetes.io/docs/user-guide/labels	false	object
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://kubernetes.io/docs/user-guide/annotations	false	object
ownerReferences	List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.	false	Section 2.3.166, “v1.OwnerReference” array
finalizers	Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.	false	string array
clusterName	The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.	false	string

2.3.165. v1.ObjectReference

ObjectReference contains enough information to let you inspect or modify the referred object.

Name	Description	Required	Schema
kind	Kind of the referent. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
namespace	Namespace of the referent. More info: http://kubernetes.io/docs/user-guide/namespaces	false	string
name	Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names	false	string
uid	UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#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/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency	false	string
fieldPath	If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. 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.166. v1.OwnerReference

OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

Name	Description	Required	Schema
apiVersion	API version of the referent.	true	string
kind	Kind of the referent. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	true	string
name	Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names	true	string
uid	UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids	true	string
controller	If true, this reference points to the managing controller.	false	boolean

2.3.167. v1.Parameter

Parameter defines a name/value variable that is to be processed during the Template to Config transformation.

Name	Description	Required	Schema	Default
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. The only supported generator is "expression", which accepts a "from" value in the form of a simple regular expression containing the range expression "[a-zA-Z0-9]", and the length expression "a{length}". Examples: from	value	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.168. 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).

Name	Description	Required	Schema	Default
claimName	ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims	true	string
readOnly	Will force the ReadOnly setting in VolumeMounts. Default false.	false	boolean

2.3.169. v1.PhotonPersistentDiskVolumeSource

Represents a Photon Controller persistent disk resource.

Name	Description	Required	Schema	Default
pdID	ID that identifies Photon Controller persistent disk	true	string
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

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

Name	Description	Required	Schema
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.221, “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	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.171. v1.PodSecurityPolicyReview

PodSecurityPolicyReview checks which service accounts (not users, since that would be cluster-wide) can create the PodTemplateSpec in question.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
spec	spec is the PodSecurityPolicy to check.	true	Section 2.3.172, “v1.PodSecurityPolicyReviewSpec”
status	status represents the current information/status for the PodSecurityPolicyReview.	false	Section 2.3.173, “v1.PodSecurityPolicyReviewStatus”

2.3.172. v1.PodSecurityPolicyReviewSpec

PodSecurityPolicyReviewSpec defines specification for PodSecurityPolicyReview

Name	Description	Required	Schema	Default
template	template is the PodTemplateSpec to check. The template.spec.serviceAccountName field is used if serviceAccountNames is empty, unless the template.spec.serviceAccountName is empty, in which case "default" is used. If serviceAccountNames is specified, template.spec.serviceAccountName is ignored.	true	Section 2.3.180, “v1.PodTemplateSpec”
serviceAccountNames	serviceAccountNames is an optional set of ServiceAccounts to run the check with. If serviceAccountNames is empty, the template.spec.serviceAccountName is used, unless it’s empty, in which case "default" is used instead. If serviceAccountNames is specified, template.spec.serviceAccountName is ignored.	false	string array

2.3.173. v1.PodSecurityPolicyReviewStatus

PodSecurityPolicyReviewStatus represents the status of PodSecurityPolicyReview.

Name	Description	Required	Schema	Default
allowedServiceAccounts	allowedServiceAccounts returns the list of service accounts in this namespace that have the power to create the PodTemplateSpec.	true	Section 2.3.232, “v1.ServiceAccountPodSecurityPolicyReviewStatus” array

2.3.174. v1.PodSecurityPolicySelfSubjectReview

PodSecurityPolicySelfSubjectReview checks whether this user/SA tuple can create the PodTemplateSpec

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
spec	spec defines specification the PodSecurityPolicySelfSubjectReview.	true	Section 2.3.175, “v1.PodSecurityPolicySelfSubjectReviewSpec”
status	status represents the current information/status for the PodSecurityPolicySelfSubjectReview.	false	Section 2.3.178, “v1.PodSecurityPolicySubjectReviewStatus”

2.3.175. v1.PodSecurityPolicySelfSubjectReviewSpec

PodSecurityPolicySelfSubjectReviewSpec contains specification for PodSecurityPolicySelfSubjectReview.

Name	Description	Required	Schema	Default
template	template is the PodTemplateSpec to check.	true	Section 2.3.180, “v1.PodTemplateSpec”

2.3.176. v1.PodSecurityPolicySubjectReview

PodSecurityPolicySubjectReview checks whether a particular user/SA tuple can create the PodTemplateSpec.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
spec	spec defines specification for the PodSecurityPolicySubjectReview.	true	Section 2.3.177, “v1.PodSecurityPolicySubjectReviewSpec”
status	status represents the current information/status for the PodSecurityPolicySubjectReview.	false	Section 2.3.178, “v1.PodSecurityPolicySubjectReviewStatus”

2.3.177. v1.PodSecurityPolicySubjectReviewSpec

PodSecurityPolicySubjectReviewSpec defines specification for PodSecurityPolicySubjectReview

Name	Description	Required	Schema
template	template is the PodTemplateSpec to check. If template.spec.serviceAccountName is empty it will not be defaulted. If its non-empty, it will be checked.	true	Section 2.3.180, “v1.PodTemplateSpec”
user	user is the user you’re testing for. If you specify "user" but not "group", then is it interpreted as "What if user were not a member of any groups. If user and groups are empty, then the check is performed using only the serviceAccountName in the template.	false	string
groups	groups is the groups you’re testing for.	false	string array

2.3.178. v1.PodSecurityPolicySubjectReviewStatus

PodSecurityPolicySubjectReviewStatus contains information/status for PodSecurityPolicySubjectReview.

Name	Description	Required	Schema
allowedBy	allowedBy is a reference to the rule that allows the PodTemplateSpec. A rule can be a SecurityContextConstraint or a PodSecurityPolicy A `nil`, indicates that it was denied.	false	Section 2.3.165, “v1.ObjectReference”
reason	A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available.	false	string
template	template is the PodTemplateSpec after the defaulting is applied.	false	Section 2.3.180, “v1.PodTemplateSpec”

2.3.179. v1.PodSpec

PodSpec is a description of a pod.

Name	Description	Required	Schema
volumes	List of volumes that can be mounted by containers belonging to the pod. More info: http://kubernetes.io/docs/user-guide/volumes	false	Section 2.3.259, “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://kubernetes.io/docs/user-guide/containers	true	Section 2.3.60, “v1.Container” array
restartPolicy	Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://kubernetes.io/docs/user-guide/pod-states#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://kubernetes.io/docs/user-guide/node-selection/README	false	object
serviceAccountName	ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: http://releases.k8s.io/HEAD/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.170, “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://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod	false	Section 2.3.144, “v1.LocalObjectReference” array
hostname	Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value.	false	string
subdomain	If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all.	false	string

2.3.180. v1.PodTemplateSpec

PodTemplateSpec describes the data a pod should have when created from a template

Name	Description	Required	Schema	Default
metadata	Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.164, “v1.ObjectMeta”
spec	Specification of the desired behavior of the pod. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 2.3.179, “v1.PodSpec”

2.3.181. v1.Policy

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

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “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.150, “v1.NamedRole” array

2.3.182. v1.PolicyBinding

PolicyBinding is a object that holds all the RoleBindings for a particular namespace. There is one PolicyBinding document per referenced Policy namespace

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “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.165, “v1.ObjectReference”
roleBindings	RoleBindings holds all the RoleBindings held by this PolicyBinding, mapped by RoleBinding.Name	true	Section 2.3.151, “v1.NamedRoleBinding” array

2.3.183. v1.PolicyBindingList

PolicyBindingList is a collection of PolicyBindings

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is a list of PolicyBindings	true	Section 2.3.182, “v1.PolicyBinding” array

2.3.184. v1.PolicyList

PolicyList is a collection of Policies

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is a list of Policies	true	Section 2.3.181, “v1.Policy” array

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

Name	Description	Required	Schema
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.186. v1.Preconditions

Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

Name	Description	Required	Schema	Default
uid	Specifies the target UID.	false	Section 2.3.3, “types.UID”

2.3.187. v1.Probe

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

Name	Description	Required	Schema
exec	One and only one of the following should be specified. Exec specifies the action to take.	false	Section 2.3.93, “v1.ExecAction”
httpGet	HTTPGet specifies the http request to perform.	false	Section 2.3.109, “v1.HTTPGetAction”
tcpSocket	TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported	false	Section 2.3.245, “v1.TCPSocketAction”
initialDelaySeconds	Number of seconds after the container has started before liveness probes are initiated. More info: http://kubernetes.io/docs/user-guide/pod-states#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://kubernetes.io/docs/user-guide/pod-states#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.188. v1.Project

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

Listing or watching projects will return only projects the user has the reader role on.

An OpenShift project is an alternative representation of a Kubernetes namespace. Projects are exposed as editable to end users while namespaces are not. Direct creation of a project is typically restricted to administrators, while end users should use the requestproject resource.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “v1.ObjectMeta”
spec	Spec defines the behavior of the Namespace.	false	Section 2.3.191, “v1.ProjectSpec”
status	Status describes the current status of a Namespace	false	Section 2.3.192, “v1.ProjectStatus”

2.3.189. v1.ProjectList

ProjectList is a list of Project objects.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is the list of projects	true	Section 2.3.188, “v1.Project” array

2.3.190. v1.ProjectRequest

ProjectRequest is the set of options necessary to fully qualify a project request

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	true	string
metadata	Standard object’s metadata.	subfield `name`	Section 2.3.164, “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.191. v1.ProjectSpec

ProjectSpec describes the attributes on a Project

Name	Description	Required	Schema	Default
finalizers	Finalizers is an opaque list of values that must be empty to permanently remove object from storage	false	Section 2.3.96, “v1.FinalizerName” array

2.3.192. v1.ProjectStatus

ProjectStatus is information about the current status of a Project

Name	Description	Required	Schema	Default
phase	Phase is the current lifecycle phase of the project	false	string

2.3.193. v1.QuobyteVolumeSource

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

Name	Description	Required	Schema
registry	Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes	true	string
volume	Volume is a string that references an already created Quobyte volume by name.	true	string
readOnly	ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.	false	boolean
user	User to map volume access to Defaults to serivceaccount user	false	string
group	Group to map volume access to Default is no group	false	string

2.3.194. v1.RBDVolumeSource

Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.

Name	Description	Required	Schema
monitors	A collection of Ceph monitors. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it	true	string array
image	The rados image name. More info: http://releases.k8s.io/HEAD/examples/volumes/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://kubernetes.io/docs/user-guide/volumes#rbd	false	string
pool	The rados pool name. Default is rbd. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it.	false	string
user	The rados user name. Default is admin. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it	false	string
keyring	Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it	false	string
secretRef	SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it	false	Section 2.3.144, “v1.LocalObjectReference”
readOnly	ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it	false	boolean

2.3.195. v1.RecreateDeploymentStrategyParams

RecreateDeploymentStrategyParams are the input to the Recreate deployment strategy.

Name	Description	Required	Schema
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.143, “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.143, “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.143, “v1.LifecycleHook”

2.3.196. v1.RepositoryImportSpec

RepositoryImportSpec describes a request to import images from a Docker image repository.

Name	Description	Required	Schema
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.165, “v1.ObjectReference”
importPolicy	ImportPolicy is the policy controlling how the image is imported	false	Section 2.3.250, “v1.TagImportPolicy”
includeManifest	IncludeManifest determines if the manifest for each image is returned in the response	false	boolean

2.3.197. v1.RepositoryImportStatus

RepositoryImportStatus describes the result of an image repository import

Name	Description	Required	Schema
status	Status reflects whether any failure occurred during import	false	Section 2.3.10, “unversioned.Status”
images	Images is a list of images successfully retrieved by the import of the repository.	false	Section 2.3.122, “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.198. v1.ResourceAccessReview

ResourceAccessReview is a means to request a list of which users and groups are authorized to perform the action specified by spec

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
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
path	Path is the path of a non resource URL	true	string
isNonResourceURL	IsNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hieraarchy)	true	boolean
content	Content is the actual content of the request for create and update	false	string

2.3.199. v1.ResourceFieldSelector

ResourceFieldSelector represents container resources (cpu, memory) and their output format

Name	Description	Required	Schema
containerName	Container name: required for volumes, optional for env vars	false	string
resource	Required: resource to select	true	string
divisor	Specifies the output format of the exposed resources, defaults to "1"	false	string

2.3.200. v1.ResourceQuotaScope

2.3.201. v1.ResourceQuotaSpec

ResourceQuotaSpec defines the desired hard limits to enforce for Quota.

Name	Description	Required	Schema	Default
hard	Hard is the set of desired hard limits for each named resource. More info: http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota	false	object
scopes	A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects.	false	Section 2.3.200, “v1.ResourceQuotaScope” array

2.3.202. v1.ResourceQuotaStatus

ResourceQuotaStatus defines the enforced hard limits and observed use.

Name	Description	Required	Schema	Default
hard	Hard is the set of enforced hard limits for each named resource. More info: http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota	false	object
used	Used is the current observed total usage of the resource in the namespace.	false	object

2.3.203. v1.ResourceQuotaStatusByNamespace

ResourceQuotaStatusByNamespace gives status for a particular project

Name	Description	Required	Schema	Default
namespace	Namespace the project this status applies to	true	string
status	Status indicates how many resources have been consumed by this project	true	Section 2.3.202, “v1.ResourceQuotaStatus”

2.3.204. v1.ResourceRequirements

ResourceRequirements describes the compute resource requirements.

Name	Description	Required	Schema	Default
limits	Limits describes the maximum amount of compute resources allowed. More info: http://kubernetes.io/docs/user-guide/compute-resources/	false	object
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://kubernetes.io/docs/user-guide/compute-resources/	false	object

2.3.205. v1.Role

Role is a logical grouping of PolicyRules that can be referenced as a unit by RoleBindings.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “v1.ObjectMeta”
rules	Rules holds all the PolicyRules for this Role	true	Section 2.3.185, “v1.PolicyRule” array

2.3.206. 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) OR Subjects 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).

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “v1.ObjectMeta”
userNames	UserNames holds all the usernames directly bound to the role. This field should only be specified when supporting legacy clients and servers. See Subjects for further details.	true	string array
groupNames	GroupNames holds all the groups directly bound to the role. This field should only be specified when supporting legacy clients and servers. See Subjects for further details.	true	string array
subjects	Subjects hold object references to authorize with this rule. This field is ignored if UserNames or GroupNames are specified to support legacy clients and servers. Thus newer clients that do not need to support backwards compatibility should send only fully qualified Subjects and should omit the UserNames and GroupNames fields. Clients that need to support backwards compatibility can use this field to build the UserNames and GroupNames.	true	Section 2.3.165, “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.165, “v1.ObjectReference”

2.3.207. v1.RoleBindingList

RoleBindingList is a collection of RoleBindings

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is a list of RoleBindings	true	Section 2.3.206, “v1.RoleBinding” array

2.3.208. v1.RoleBindingRestriction

RoleBindingRestriction is an object that can be matched against a subject (user, group, or service account) to determine whether rolebindings on that subject are allowed in the namespace to which the RoleBindingRestriction belongs. If any one of those RoleBindingRestriction objects matches a subject, rolebindings on that subject in the namespace are allowed.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	true	Section 2.3.164, “v1.ObjectMeta”
spec	Spec defines the matcher.	true	Section 2.3.210, “v1.RoleBindingRestrictionSpec”

2.3.209. v1.RoleBindingRestrictionList

RoleBindingRestrictionList is a collection of RoleBindingRestriction objects.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is a list of RoleBindingRestriction objects.	true	Section 2.3.208, “v1.RoleBindingRestriction” array

2.3.210. v1.RoleBindingRestrictionSpec

RoleBindingRestrictionSpec defines a rolebinding restriction. Exactly one field must be non-nil.

Name	Description	Required	Schema
userrestriction	UserRestriction matches against user subjects.	true	Section 2.3.258, “v1.UserRestriction”
grouprestriction	GroupRestriction matches against group subjects.	true	Section 2.3.108, “v1.GroupRestriction”
serviceaccountrestriction	ServiceAccountRestriction matches against service-account subjects.	true	Section 2.3.234, “v1.ServiceAccountRestriction”

2.3.211. v1.RoleList

RoleList is a collection of Roles

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is a list of Roles	true	Section 2.3.205, “v1.Role” array

2.3.212. v1.RollingDeploymentStrategyParams

RollingDeploymentStrategyParams are the input to the Rolling deployment strategy.

Name	Description	Required	Schema
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 down. 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
pre	Pre is a lifecycle hook which is executed before the deployment process begins. All LifecycleHookFailurePolicy values are supported.	false	Section 2.3.143, “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.143, “v1.LifecycleHook”

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

Once a route is created, the host field may not be changed. Generally, routers use the oldest route with a given host when resolving conflicts.

Routers are subject to additional customization and may support additional controls via the annotations field.

Because administrators may configure multiple routers, the route status field is used to return information to clients about the names and states of the route under each router. If a client chooses a duplicate name, for instance, the route status conditions are used to indicate the route cannot be chosen.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object metadata.	false	Section 2.3.164, “v1.ObjectMeta”
spec	spec is the desired state of the route	true	Section 2.3.218, “v1.RouteSpec”
status	status is the current state of the route	true	Section 2.3.219, “v1.RouteStatus”

2.3.214. v1.RouteIngress

RouteIngress holds information about the places where a route is exposed.

Name	Description	Required	Schema
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.215, “v1.RouteIngressCondition” array
wildcardPolicy	Wildcard policy is the wildcard policy that was allowed where this route is exposed.	false	string
routerCanonicalHostname	CanonicalHostname is the external host name for the router that can be used as a CNAME for the host requested for this route. This value is optional and may not be set in all cases.	false	string

2.3.215. v1.RouteIngressCondition

RouteIngressCondition contains details for the current condition of this route on a particular router.

Name	Description	Required	Schema
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.216. v1.RouteList

RouteList is a collection of Routes.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object metadata.	false	Section 2.3.8, “unversioned.ListMeta”
items	items is a list of routes	true	Section 2.3.213, “v1.Route” array

2.3.217. v1.RoutePort

RoutePort defines a port mapping from a router to an endpoint in the service endpoints.

Name	Description	Required	Schema	Default
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.218. v1.RouteSpec

RouteSpec describes the hostname or path the route exposes, any security information, and one or more backends the route points to. Weights on each backend can define the balance of traffic sent to each backend - if all weights are zero the route will be considered to have no backends and return a standard 503 response.

The tls field is optional and allows specific certificates or behavior for the route. Routers typically configure a default certificate on a wildcard domain to terminate routes without explicit certificates, but custom hostnames usually must choose passthrough (send traffic directly to the backend via the TLS Server-Name- Indication field) or provide a certificate.

Name	Description	Required	Schema
host	host is an alias/DNS that points to the service. Optional. If not specified a route name will typically be automatically chosen. 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 should use as the primary backend. Only the Service kind is allowed, and it will be defaulted to Service. If the weight field is set to zero, no traffic will be sent to this service.	true	Section 2.3.220, “v1.RouteTargetReference”
alternateBackends	alternateBackends is an extension of the 'to' field. If more than one service needs to be pointed to, then use this field. Use the weight field in RouteTargetReference object to specify relative preference. If the weight field is zero, the backend is ignored.	false	Section 2.3.220, “v1.RouteTargetReference” array
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.217, “v1.RoutePort”
tls	The tls field provides the ability to configure certificates and termination for the route.	false	Section 2.3.246, “v1.TLSConfig”
wildcardPolicy	Wildcard policy if any for the route. Currently only 'Subdomain' or 'None' is allowed.	false	string

2.3.219. v1.RouteStatus

RouteStatus provides relevant info about the status of a route, including which routers acknowledge it.

Name	Description	Required	Schema	Default
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.214, “v1.RouteIngress” array

2.3.220. v1.RouteTargetReference

RouteTargetReference specifies the target that resolve into endpoints. Only the 'Service' kind is allowed. Use 'weight' field to emphasize one over others.

Name	Description	Required	Schema
kind	The kind of target that the route is referring to. Currently, only 'Service' is allowed	true	string
name	name of the service/target that is being referred to. e.g. name of the service	true	string
weight	weight as an integer between 1 and 256 that specifies the target’s relative weight against other target reference objects	true	integer (int32)

2.3.221. v1.SELinuxOptions

SELinuxOptions are the labels to be applied to the container

Name	Description	Required	Schema
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.222. v1.ScopeRestriction

ScopeRestriction describe one restriction on scopes. Exactly one option must be non-nil.

Name	Description	Required	Schema	Default
literals	ExactValues means the scope has to match a particular set of strings exactly	false	string array
clusterRole	ClusterRole describes a set of restrictions for cluster role scoping.	false	Section 2.3.57, “v1.ClusterRoleScopeRestriction”

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

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.164, “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	object
stringData	stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API.	false	object
type	Used to facilitate programmatic handling of secret data.	false	string

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

Name	Description	Required	Schema	Default
secret	secret is a reference to an existing secret that you want to use in your build.	true	Section 2.3.144, “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.225. v1.SecretKeySelector

SecretKeySelector selects a key of a Secret.

Name	Description	Required	Schema	Default
name	Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names	false	string
key	The key of the secret to select from. Must be a valid secret key.	true	string

2.3.226. v1.SecretList

SecretList is a list of Secret.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is a list of secret objects. More info: http://kubernetes.io/docs/user-guide/secrets	true	Section 2.3.223, “v1.Secret” array

2.3.227. v1.SecretSpec

SecretSpec specifies a secret to be included in a build pod and its corresponding mount point

Name	Description	Required	Schema	Default
secretSource	secretSource is a reference to the secret	true	Section 2.3.144, “v1.LocalObjectReference”
mountPath	mountPath is the path at which to mount the secret	true	string

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

Name	Description	Required	Schema
secretName	Name of the secret in the pod’s namespace to use. More info: http://kubernetes.io/docs/user-guide/volumes#secrets	false	string
items	If unspecified, each key-value pair in the Data field of the referenced Secret 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 Secret, the volume setup will error. Paths must be relative and may not contain the '..' path or start with '..'.	false	Section 2.3.141, “v1.KeyToPath” array
defaultMode	Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.	false	integer (int32)

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

Name	Description	Required	Schema
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.38, “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.221, “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.230. v1.SelfSubjectRulesReview

SelfSubjectRulesReview is a resource you can create to determine which actions you can perform in a namespace

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
spec	Spec adds information about how to conduct the check	true	Section 2.3.231, “v1.SelfSubjectRulesReviewSpec”
status	Status is completed by the server to tell which permissions you have	false	Section 2.3.244, “v1.SubjectRulesReviewStatus”

2.3.231. v1.SelfSubjectRulesReviewSpec

SelfSubjectRulesReviewSpec adds information about how to conduct the check

Name	Description	Required	Schema	Default
scopes	Scopes to use for the evaluation. Empty means "use the unscoped (full) permissions of the user/groups". Nil means "use the scopes on this request".	true	string array

2.3.232. v1.ServiceAccountPodSecurityPolicyReviewStatus

ServiceAccountPodSecurityPolicyReviewStatus represents ServiceAccount name and related review status

Name	Description	Required	Schema
allowedBy	allowedBy is a reference to the rule that allows the PodTemplateSpec. A rule can be a SecurityContextConstraint or a PodSecurityPolicy A `nil`, indicates that it was denied.	false	Section 2.3.165, “v1.ObjectReference”
reason	A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available.	false	string
template	template is the PodTemplateSpec after the defaulting is applied.	false	Section 2.3.180, “v1.PodTemplateSpec”
name	name contains the allowed and the denied ServiceAccount name	true	string

2.3.233. v1.ServiceAccountReference

ServiceAccountReference specifies a service account and namespace by their names.

Name	Description	Required	Schema	Default
name	Name is the name of the service account.	true	string
namespace	Namespace is the namespace of the service account. Service accounts from inside the whitelisted namespaces are allowed to be bound to roles. If Namespace is empty, then the namespace of the RoleBindingRestriction in which the ServiceAccountReference is embedded is used.	true	string

2.3.234. v1.ServiceAccountRestriction

ServiceAccountRestriction matches a service account by a string match on either the service-account name or the name of the service account’s namespace.

Name	Description	Required	Schema	Default
serviceaccounts	ServiceAccounts specifies a list of literal service-account names.	true	Section 2.3.233, “v1.ServiceAccountReference” array
namespaces	Namespaces specifies a list of literal namespace names.	true	string array

2.3.235. v1.SignatureCondition

SignatureCondition describes an image signature condition of particular kind at particular probe time.

Name	Description	Required	Schema
type	Type of signature condition, Complete or Failed.	true	string
status	Status of the condition, one of True, False, Unknown.	true	string
lastProbeTime	Last time the condition was checked.	false	string
lastTransitionTime	Last time the condition transit from one status to another.	false	string
reason	(brief) reason for the condition’s last transition.	false	string
message	Human readable message indicating details about last transition.	false	string

2.3.236. v1.SignatureIssuer

SignatureIssuer holds information about an issuer of signing certificate or key.

Name	Description	Required	Schema	Default
organization	Organization name.	false	string
commonName	Common name (e.g. openshift-signing-service).	false	string

2.3.237. v1.SignatureSubject

SignatureSubject holds information about a person or entity who created the signature.

Name	Description	Required	Schema
organization	Organization name.	false	string
commonName	Common name (e.g. openshift-signing-service).	false	string
publicKeyID	If present, it is a human readable key id of public key belonging to the subject used to verify image signature. It should contain at least 64 lowest bits of public key’s fingerprint (e.g. 0x685ebe62bf278440).	true	string

2.3.238. v1.SourceBuildStrategy

SourceBuildStrategy defines input parameters specific to an Source build.

Name	Description	Required	Schema
from	from is reference to an DockerImage, ImageStreamTag, or ImageStreamImage from which the docker image should be pulled	true	Section 2.3.165, “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.144, “v1.LocalObjectReference”
env	env contains additional environment variables you want to pass into a builder container	false	Section 2.3.91, “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
runtimeImage	runtimeImage is an optional image that is used to run an application without unneeded dependencies installed. The building of the application is still done in the builder image but, post build, you can copy the needed artifacts in the runtime image for use. This field and the feature it enables are in tech preview.	false	Section 2.3.165, “v1.ObjectReference”
runtimeArtifacts	runtimeArtifacts specifies a list of source/destination pairs that will be copied from the builder to the runtime image. sourcePath can be a file or directory. destinationDir must be a directory. destinationDir can also be empty or equal to ".", in this case it just refers to the root of WORKDIR. This field and the feature it enables are in tech preview.	false	Section 2.3.128, “v1.ImageSourcePath” array

2.3.239. v1.SourceControlUser

SourceControlUser defines the identity of a user of source control

Name	Description	Required	Schema	Default
name	name of the source control user	false	string
email	email of the source control user	false	string

2.3.240. v1.SourceRevision

SourceRevision is the revision or commit information from the source for the build

Name	Description	Required	Schema	Default
type	type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images'	true	string
git	Git contains information about git-based build source	false	Section 2.3.104, “v1.GitSourceRevision”

2.3.241. v1.SubjectAccessReview

SubjectAccessReview is an object for requesting information about whether a user or group can perform an action

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
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
path	Path is the path of a non resource URL	true	string
isNonResourceURL	IsNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hieraarchy)	true	boolean
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
scopes	Scopes to use for the evaluation. Empty means "use the unscoped (full) permissions of the user/groups". Nil for a self-SAR, means "use the scopes on this request". Nil for a regular SAR, means the same as empty.	true	string array

2.3.242. v1.SubjectRulesReview

SubjectRulesReview is a resource you can create to determine which actions another user can perform in a namespace

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
spec	Spec adds information about how to conduct the check	true	Section 2.3.243, “v1.SubjectRulesReviewSpec”
status	Status is completed by the server to tell which permissions you have	false	Section 2.3.244, “v1.SubjectRulesReviewStatus”

2.3.243. v1.SubjectRulesReviewSpec

SubjectRulesReviewSpec adds information about how to conduct the check

Name	Description	Required	Schema
user	User is optional. At least one of User and Groups must be specified.	true	string
groups	Groups is optional. Groups is the list of groups to which the User belongs. At least one of User and Groups must be specified.	true	string array
scopes	Scopes to use for the evaluation. Empty means "use the unscoped (full) permissions of the user/groups".	true	string array

2.3.244. v1.SubjectRulesReviewStatus

SubjectRulesReviewStatus is contains the result of a rules check

Name	Description	Required	Schema	Default
rules	Rules is the list of rules (no particular sort) that are allowed for the subject	true	Section 2.3.185, “v1.PolicyRule” array
evaluationError	EvaluationError can appear in combination with Rules. It means some error happened during evaluation that may have prevented additional rules from being populated.	false	string

2.3.245. v1.TCPSocketAction

TCPSocketAction describes an action based on opening a socket

Name	Description	Required	Schema	Default
port	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true	string

2.3.246. v1.TLSConfig

TLSConfig defines config used to secure a route and provide termination

Name	Description	Required	Schema
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 a route. While each router may make its own decisions on which ports to expose, this is normally port 80. * Allow - traffic is sent to the server on the insecure port (default) * Disable - no traffic is allowed on the insecure port. * Redirect - clients are redirected to the secure port.	false	string

2.3.247. v1.TagEvent

TagEvent is used by ImageStreamStatus to keep a historical record of images associated with a tag.

Name	Description	Required	Schema
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.248. v1.TagEventCondition

TagEventCondition contains condition information for a tag event.

Name	Description	Required	Schema
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.249. v1.TagImageHook

TagImageHook is a request to tag the image in a particular container onto an ImageStreamTag.

Name	Description	Required	Schema	Default
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.165, “v1.ObjectReference”

2.3.250. v1.TagImportPolicy

TagImportPolicy controls how images related to this tag will be imported.

Name	Description	Required	Schema	Default
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.251. 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.

Name	Description	Required	Schema
name	Name of the tag	true	string
annotations	Annotations associated with images using this tag	true	object
from	From is a reference to an image stream tag or image stream this tag should track	false	Section 2.3.165, “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.250, “v1.TagImportPolicy”
referencePolicy	ReferencePolicy defines how other components should consume the image	false	Section 2.3.252, “v1.TagReferencePolicy”

2.3.252. v1.TagReferencePolicy

TagReferencePolicy describes how pull-specs for images in this image stream tag are generated when image change triggers in deployment configs or builds are resolved. This allows the image stream author to control how images are accessed.

Name	Description	Required	Schema	Default
type	Type determines how the image pull spec should be transformed when the image stream tag is used in deployment config triggers or new builds. The default value is `Source`, indicating the original location of the image should be used (if imported). The user may also specify `Local`, indicating that the pull spec should point to the integrated Docker registry and leverage the registry’s ability to proxy the pull to an upstream registry. `Local` allows the credentials used to pull this image to be managed from the image stream’s namespace, so others on the platform can access a remote image but have no access to the remote secret. It also allows the image layers to be mirrored into the local registry which the images can still be pulled even if the upstream registry is unavailable.	true	string

2.3.253. v1.Template

Template contains the inputs needed to produce a Config.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “v1.ObjectMeta”
message	message is an optional instructional message that will be displayed when this template is instantiated. This field should inform the user how to utilize the newly created resources. Parameter substitution will be performed on the message before being displayed so that generated credentials and other parameters can be included in the output.	false	string
objects	objects is an array of resources to include in this template. If a namespace value is hardcoded in the object, it will be removed during template instantiation, however if the namespace value is, or contains, a ${PARAMETER_REFERENCE}, the resolved value after parameter substitution will be respected and the object will be created in that namespace.	true	Section 2.3.2, “runtime.RawExtension” array
parameters	parameters is an optional array of Parameters used during the Template to Config transformation.	false	Section 2.3.167, “v1.Parameter” array
labels	labels is a optional set of labels that are applied to every object during the Template to Config transformation.	false	object

2.3.254. v1.TemplateList

TemplateList is a list of Template objects.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is a list of templates	true	Section 2.3.253, “v1.Template” array

2.3.255. 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 depending on the configuration of the system.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “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 specifies group names this user is a member of. This field is deprecated and will be removed in a future release. Instead, create a Group object containing the name of this User.	true	string array

2.3.256. v1.UserIdentityMapping

UserIdentityMapping maps a user to an identity

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.164, “v1.ObjectMeta”
identity	Identity is a reference to an identity	false	Section 2.3.165, “v1.ObjectReference”
user	User is a reference to a user	false	Section 2.3.165, “v1.ObjectReference”

2.3.257. v1.UserList

UserList is a collection of Users

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata.	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is the list of users	true	Section 2.3.255, “v1.User” array

2.3.258. v1.UserRestriction

UserRestriction matches a user either by a string match on the user name, a string match on the name of a group to which the user belongs, or a label selector applied to the user labels.

Name	Description	Required	Schema
users	Users specifies a list of literal user names.	true	string array
groups	Groups specifies a list of literal group names.	true	string array
labels	Selectors specifies a list of label selectors over user labels.	true	Section 2.3.6, “unversioned.LabelSelector” array

2.3.259. v1.Volume

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

Name	Description	Required	Schema
name	Volume’s name. Must be a DNS_LABEL and unique within the pod. More info: http://kubernetes.io/docs/user-guide/identifiers#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://kubernetes.io/docs/user-guide/volumes#hostpath	false	Section 2.3.112, “v1.HostPathVolumeSource”
emptyDir	EmptyDir represents a temporary directory that shares a pod’s lifetime. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir	false	Section 2.3.90, “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://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk	false	Section 2.3.99, “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://kubernetes.io/docs/user-guide/volumes#awselasticblockstore	false	Section 2.3.13, “v1.AWSElasticBlockStoreVolumeSource”
gitRepo	GitRepo represents a git repository at a particular revision.	false	Section 2.3.103, “v1.GitRepoVolumeSource”
secret	Secret represents a secret that should populate this volume. More info: http://kubernetes.io/docs/user-guide/volumes#secrets	false	Section 2.3.228, “v1.SecretVolumeSource”
nfs	NFS represents an NFS mount on the host that shares a pod’s lifetime More info: http://kubernetes.io/docs/user-guide/volumes#nfs	false	Section 2.3.147, “v1.NFSVolumeSource”
iscsi	ISCSI represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/HEAD/examples/volumes/iscsi/README.md	false	Section 2.3.115, “v1.ISCSIVolumeSource”
glusterfs	Glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md	false	Section 2.3.105, “v1.GlusterfsVolumeSource”
persistentVolumeClaim	PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims	false	Section 2.3.168, “v1.PersistentVolumeClaimVolumeSource”
rbd	RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md	false	Section 2.3.194, “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.97, “v1.FlexVolumeSource”
cinder	Cinder represents a cinder volume attached and mounted on kubelets host machine More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md	false	Section 2.3.41, “v1.CinderVolumeSource”
cephfs	CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime	false	Section 2.3.40, “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.98, “v1.FlockerVolumeSource”
downwardAPI	DownwardAPI represents downward API about the pod that should populate this volume	false	Section 2.3.84, “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.95, “v1.FCVolumeSource”
azureFile	AzureFile represents an Azure File Service mount on the host and bind mount to the pod.	false	Section 2.3.18, “v1.AzureFileVolumeSource”
configMap	ConfigMap represents a configMap that should populate this volume	false	Section 2.3.59, “v1.ConfigMapVolumeSource”
vsphereVolume	VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine	false	Section 2.3.261, “v1.VsphereVirtualDiskVolumeSource”
quobyte	Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime	false	Section 2.3.193, “v1.QuobyteVolumeSource”
azureDisk	AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.	false	Section 2.3.17, “v1.AzureDiskVolumeSource”
photonPersistentDisk	PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine	false	Section 2.3.169, “v1.PhotonPersistentDiskVolumeSource”
metadata	Metadata represents metadata about the pod that should populate this volume Deprecated: Use downwardAPI instead.	false	Section 2.3.81, “v1.DeprecatedDownwardAPIVolumeSource”

2.3.260. v1.VolumeMount

VolumeMount describes a mounting of a Volume within a container.

Name	Description	Required	Schema
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
subPath	Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root).	false	string

2.3.261. v1.VsphereVirtualDiskVolumeSource

Represents a vSphere volume resource.

Name	Description	Required	Schema	Default
volumePath	Path that identifies vSphere volume vmdk	true	string
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

2.3.262. v1.WebHookTrigger

WebHookTrigger is a trigger that gets invoked using a webhook type of post

Name	Description	Required	Schema	Default
secret	secret used to validate requests.	false	string
allowEnv	allowEnv determines whether the webhook can set environment variables; can only be set to true for GenericWebHook.	false	boolean

2.3.263. v1beta1.Scale

represents a scaling request for a resource.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object metadata; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata.	false	Section 2.3.164, “v1.ObjectMeta”
spec	defines the behavior of the scale. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status.	false	Section 2.3.264, “v1beta1.ScaleSpec”
status	current status of the scale. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status. Read-only.	false	Section 2.3.265, “v1beta1.ScaleStatus”

2.3.264. v1beta1.ScaleSpec

describes the attributes of a scale subresource

Name	Description	Required	Schema	Default
replicas	desired number of instances for the scaled object.	false	integer (int32)

2.3.265. v1beta1.ScaleStatus

represents the current status of a scale subresource.

Name	Description	Required	Schema
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://kubernetes.io/docs/user-guide/labels#label-selectors	false	object
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://kubernetes.io/docs/user-guide/labels#label-selectors	false	string

2.3.266. versioned.Event

Name	Description	Required	Schema	Default
type		true	string
object		true	string

Chapter 3. Kubernetes v1 REST API

3.1. Overview

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

3.1.1. Version information

Version: v1

3.1.2. URI scheme

Host: 127.0.0.1:8443
BasePath: /
Schemes: HTTPS

3.2. Paths

3.2.1. get available resources

GET /api/v1

3.2.1.1. Responses

HTTP Code	Description	Schema
default	success	Section 2.3.5, “unversioned.APIResourceList”

3.2.1.2. Consumes

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

3.2.1.3. Produces

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

3.2.1.4. Tags

apiv1

3.2.2. create a Binding

POST /api/v1/bindings

3.2.2.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.16, “v1.Binding”

3.2.2.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.16, “v1.Binding”

3.2.2.3. Consumes

3.2.2.4. Produces

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

3.2.2.5. Tags

apiv1

3.2.3. list objects of kind ComponentStatus

GET /api/v1/componentstatuses

3.2.3.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.3.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.23, “v1.ComponentStatusList”

3.2.3.3. Consumes

3.2.3.4. Produces

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

3.2.3.5. Tags

apiv1

3.2.4. read the specified ComponentStatus

GET /api/v1/componentstatuses/{name}

3.2.4.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	name	name of the ComponentStatus	true	string

3.2.4.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.22, “v1.ComponentStatus”

3.2.4.3. Consumes

3.2.4.4. Produces

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

3.2.4.5. Tags

apiv1

3.2.5. list or watch objects of kind ConfigMap

GET /api/v1/configmaps

3.2.5.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.5.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.26, “v1.ConfigMapList”

3.2.5.3. Consumes

3.2.5.4. Produces

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

3.2.5.5. Tags

apiv1

3.2.6. create a ConfigMap

POST /api/v1/configmaps

3.2.6.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.24, “v1.ConfigMap”

3.2.6.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.24, “v1.ConfigMap”

3.2.6.3. Consumes

3.2.6.4. Produces

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

3.2.6.5. Tags

apiv1

3.2.7. list or watch objects of kind Endpoints

GET /api/v1/endpoints

3.2.7.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.7.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.47, “v1.EndpointsList”

3.2.7.3. Consumes

3.2.7.4. Produces

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

3.2.7.5. Tags

apiv1

3.2.8. create Endpoints

POST /api/v1/endpoints

3.2.8.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.46, “v1.Endpoints”

3.2.8.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.46, “v1.Endpoints”

3.2.8.3. Consumes

3.2.8.4. Produces

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

3.2.8.5. Tags

apiv1

3.2.9. list or watch objects of kind Event

GET /api/v1/events

3.2.9.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.9.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.51, “v1.EventList”

3.2.9.3. Consumes

3.2.9.4. Produces

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

3.2.9.5. Tags

apiv1

3.2.10. create an Event

POST /api/v1/events

3.2.10.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.50, “v1.Event”

3.2.10.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.50, “v1.Event”

3.2.10.3. Consumes

3.2.10.4. Produces

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

3.2.10.5. Tags

apiv1

3.2.11. list or watch objects of kind LimitRange

GET /api/v1/limitranges

3.2.11.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.11.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.73, “v1.LimitRangeList”

3.2.11.3. Consumes

3.2.11.4. Produces

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

3.2.11.5. Tags

apiv1

3.2.12. create a LimitRange

POST /api/v1/limitranges

3.2.12.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.71, “v1.LimitRange”

3.2.12.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.71, “v1.LimitRange”

3.2.12.3. Consumes

3.2.12.4. Produces

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

3.2.12.5. Tags

apiv1

3.2.13. delete collection of Namespace

DELETE /api/v1/namespaces

3.2.13.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.13.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.13.3. Consumes

3.2.13.4. Produces

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

3.2.13.5. Tags

apiv1

3.2.14. list or watch objects of kind Namespace

GET /api/v1/namespaces

3.2.14.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.14.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.80, “v1.NamespaceList”

3.2.14.3. Consumes

3.2.14.4. Produces

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

3.2.14.5. Tags

apiv1

3.2.15. create a Namespace

POST /api/v1/namespaces

3.2.15.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.79, “v1.Namespace”

3.2.15.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.79, “v1.Namespace”

3.2.15.3. Consumes

3.2.15.4. Produces

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

3.2.15.5. Tags

apiv1

3.2.16. create a Binding

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

3.2.16.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.16, “v1.Binding”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.16.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.16, “v1.Binding”

3.2.16.3. Consumes

3.2.16.4. Produces

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

3.2.16.5. Tags

apiv1

3.2.17. delete collection of ConfigMap

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

3.2.17.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.17.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.17.3. Consumes

3.2.17.4. Produces

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

3.2.17.5. Tags

apiv1

3.2.18. list or watch objects of kind ConfigMap

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

3.2.18.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.18.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.26, “v1.ConfigMapList”

3.2.18.3. Consumes

3.2.18.4. Produces

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

3.2.18.5. Tags

apiv1

3.2.19. create a ConfigMap

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

3.2.19.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.24, “v1.ConfigMap”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.19.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.24, “v1.ConfigMap”

3.2.19.3. Consumes

3.2.19.4. Produces

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

3.2.19.5. Tags

apiv1

3.2.20. delete a ConfigMap

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

3.2.20.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ConfigMap	true	string

3.2.20.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.20.3. Consumes

3.2.20.4. Produces

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

3.2.20.5. Tags

apiv1

3.2.21. replace the specified ConfigMap

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

3.2.21.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.24, “v1.ConfigMap”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ConfigMap	true	string

3.2.21.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.24, “v1.ConfigMap”

3.2.21.3. Consumes

3.2.21.4. Produces

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

3.2.21.5. Tags

apiv1

3.2.22. read the specified ConfigMap

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

3.2.22.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	export	Should this value be exported. Export strips fields that a user can not specify.	false	boolean
QueryParameter	exact	Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'	false	boolean
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ConfigMap	true	string

3.2.22.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.24, “v1.ConfigMap”

3.2.22.3. Consumes

3.2.22.4. Produces

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

3.2.22.5. Tags

apiv1

3.2.23. partially update the specified ConfigMap

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

3.2.23.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ConfigMap	true	string

3.2.23.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.24, “v1.ConfigMap”

3.2.23.3. Consumes

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

3.2.23.4. Produces

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

3.2.23.5. Tags

apiv1

3.2.24. delete collection of Endpoints

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

3.2.24.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.24.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.24.3. Consumes

3.2.24.4. Produces

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

3.2.24.5. Tags

apiv1

3.2.25. list or watch objects of kind Endpoints

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

3.2.25.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.25.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.47, “v1.EndpointsList”

3.2.25.3. Consumes

3.2.25.4. Produces

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

3.2.25.5. Tags

apiv1

3.2.26. create Endpoints

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

3.2.26.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.46, “v1.Endpoints”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.26.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.46, “v1.Endpoints”

3.2.26.3. Consumes

3.2.26.4. Produces

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

3.2.26.5. Tags

apiv1

3.2.27. delete Endpoints

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

3.2.27.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Endpoints	true	string

3.2.27.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.27.3. Consumes

3.2.27.4. Produces

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

3.2.27.5. Tags

apiv1

3.2.28. replace the specified Endpoints

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

3.2.28.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.46, “v1.Endpoints”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Endpoints	true	string

3.2.28.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.46, “v1.Endpoints”

3.2.28.3. Consumes

3.2.28.4. Produces

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

3.2.28.5. Tags

apiv1

3.2.29. read the specified Endpoints

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

3.2.29.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	export	Should this value be exported. Export strips fields that a user can not specify.	false	boolean
QueryParameter	exact	Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'	false	boolean
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Endpoints	true	string

3.2.29.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.46, “v1.Endpoints”

3.2.29.3. Consumes

3.2.29.4. Produces

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

3.2.29.5. Tags

apiv1

3.2.30. partially update the specified Endpoints

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

3.2.30.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Endpoints	true	string

3.2.30.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.46, “v1.Endpoints”

3.2.30.3. Consumes

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

3.2.30.4. Produces

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

3.2.30.5. Tags

apiv1

3.2.31. delete collection of Event

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

3.2.31.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.31.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.31.3. Consumes

3.2.31.4. Produces

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

3.2.31.5. Tags

apiv1

3.2.32. list or watch objects of kind Event

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

3.2.32.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.32.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.51, “v1.EventList”

3.2.32.3. Consumes

3.2.32.4. Produces

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

3.2.32.5. Tags

apiv1

3.2.33. create an Event

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

3.2.33.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.50, “v1.Event”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.33.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.50, “v1.Event”

3.2.33.3. Consumes

3.2.33.4. Produces

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

3.2.33.5. Tags

apiv1

3.2.34. delete an Event

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

3.2.34.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Event	true	string

3.2.34.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.34.3. Consumes

3.2.34.4. Produces

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

3.2.34.5. Tags

apiv1

3.2.35. replace the specified Event

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

3.2.35.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.50, “v1.Event”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Event	true	string

3.2.35.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.50, “v1.Event”

3.2.35.3. Consumes

3.2.35.4. Produces

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

3.2.35.5. Tags

apiv1

3.2.36. read the specified Event

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

3.2.36.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	export	Should this value be exported. Export strips fields that a user can not specify.	false	boolean
QueryParameter	exact	Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'	false	boolean
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Event	true	string

3.2.36.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.50, “v1.Event”

3.2.36.3. Consumes

3.2.36.4. Produces

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

3.2.36.5. Tags

apiv1

3.2.37. partially update the specified Event

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

3.2.37.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Event	true	string

3.2.37.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.50, “v1.Event”

3.2.37.3. Consumes

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

3.2.37.4. Produces

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

3.2.37.5. Tags

apiv1

3.2.38. delete collection of LimitRange

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

3.2.38.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.38.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.38.3. Consumes

3.2.38.4. Produces

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

3.2.38.5. Tags

apiv1

3.2.39. list or watch objects of kind LimitRange

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

3.2.39.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.39.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.73, “v1.LimitRangeList”

3.2.39.3. Consumes

3.2.39.4. Produces

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

3.2.39.5. Tags

apiv1

3.2.40. create a LimitRange

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

3.2.40.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.71, “v1.LimitRange”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.40.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.71, “v1.LimitRange”

3.2.40.3. Consumes

3.2.40.4. Produces

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

3.2.40.5. Tags

apiv1

3.2.41. delete a LimitRange

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

3.2.41.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the LimitRange	true	string

3.2.41.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.41.3. Consumes

3.2.41.4. Produces

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

3.2.41.5. Tags

apiv1

3.2.42. replace the specified LimitRange

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

3.2.42.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.71, “v1.LimitRange”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the LimitRange	true	string

3.2.42.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.71, “v1.LimitRange”

3.2.42.3. Consumes

3.2.42.4. Produces

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

3.2.42.5. Tags

apiv1

3.2.43. read the specified LimitRange

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

3.2.43.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	export	Should this value be exported. Export strips fields that a user can not specify.	false	boolean
QueryParameter	exact	Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'	false	boolean
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the LimitRange	true	string

3.2.43.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.71, “v1.LimitRange”

3.2.43.3. Consumes

3.2.43.4. Produces

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

3.2.43.5. Tags

apiv1

3.2.44. partially update the specified LimitRange

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

3.2.44.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the LimitRange	true	string

3.2.44.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.71, “v1.LimitRange”

3.2.44.3. Consumes

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

3.2.44.4. Produces

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

3.2.44.5. Tags

apiv1

3.2.45. delete collection of PersistentVolumeClaim

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

3.2.45.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.45.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.45.3. Consumes

3.2.45.4. Produces

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

3.2.45.5. Tags

apiv1

3.2.46. list or watch objects of kind PersistentVolumeClaim

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

3.2.46.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.46.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.98, “v1.PersistentVolumeClaimList”

3.2.46.3. Consumes

3.2.46.4. Produces

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

3.2.46.5. Tags

apiv1

3.2.47. create a PersistentVolumeClaim

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

3.2.47.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.97, “v1.PersistentVolumeClaim”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.47.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.97, “v1.PersistentVolumeClaim”

3.2.47.3. Consumes

3.2.47.4. Produces

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

3.2.47.5. Tags

apiv1

3.2.48. delete a PersistentVolumeClaim

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

3.2.48.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the PersistentVolumeClaim	true	string

3.2.48.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.48.3. Consumes

3.2.48.4. Produces

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

3.2.48.5. Tags

apiv1

3.2.49. replace the specified PersistentVolumeClaim

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

3.2.49.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.97, “v1.PersistentVolumeClaim”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the PersistentVolumeClaim	true	string

3.2.49.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.97, “v1.PersistentVolumeClaim”

3.2.49.3. Consumes

3.2.49.4. Produces

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

3.2.49.5. Tags

apiv1

3.2.50. read the specified PersistentVolumeClaim

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

3.2.50.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	export	Should this value be exported. Export strips fields that a user can not specify.	false	boolean
QueryParameter	exact	Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'	false	boolean
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the PersistentVolumeClaim	true	string

3.2.50.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.97, “v1.PersistentVolumeClaim”

3.2.50.3. Consumes

3.2.50.4. Produces

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

3.2.50.5. Tags

apiv1

3.2.51. partially update the specified PersistentVolumeClaim

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

3.2.51.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the PersistentVolumeClaim	true	string

3.2.51.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.97, “v1.PersistentVolumeClaim”

3.2.51.3. Consumes

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

3.2.51.4. Produces

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

3.2.51.5. Tags

apiv1

3.2.52. replace status of the specified PersistentVolumeClaim

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

3.2.52.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.97, “v1.PersistentVolumeClaim”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the PersistentVolumeClaim	true	string

3.2.52.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.97, “v1.PersistentVolumeClaim”

3.2.52.3. Consumes

3.2.52.4. Produces

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

3.2.52.5. Tags

apiv1

3.2.53. read status of the specified PersistentVolumeClaim

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

3.2.53.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the PersistentVolumeClaim	true	string

3.2.53.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.97, “v1.PersistentVolumeClaim”

3.2.53.3. Consumes

3.2.53.4. Produces

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

3.2.53.5. Tags

apiv1

3.2.54. partially update status of the specified PersistentVolumeClaim

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

3.2.54.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the PersistentVolumeClaim	true	string

3.2.54.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.97, “v1.PersistentVolumeClaim”

3.2.54.3. Consumes

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

3.2.54.4. Produces

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

3.2.54.5. Tags

apiv1

3.2.55. delete collection of Pod

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

3.2.55.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.55.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.55.3. Consumes

3.2.55.4. Produces

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

3.2.55.5. Tags

apiv1

3.2.56. list or watch objects of kind Pod

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

3.2.56.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.56.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.108, “v1.PodList”

3.2.56.3. Consumes

3.2.56.4. Produces

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

3.2.56.5. Tags

apiv1

3.2.57. create a Pod

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

3.2.57.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.106, “v1.Pod”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.57.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.106, “v1.Pod”

3.2.57.3. Consumes

3.2.57.4. Produces

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

3.2.57.5. Tags

apiv1

3.2.58. delete a Pod

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

3.2.58.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.58.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.58.3. Consumes

3.2.58.4. Produces

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

3.2.58.5. Tags

apiv1

3.2.59. replace the specified Pod

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

3.2.59.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.106, “v1.Pod”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.59.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.106, “v1.Pod”

3.2.59.3. Consumes

3.2.59.4. Produces

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

3.2.59.5. Tags

apiv1

3.2.60. read the specified Pod

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

3.2.60.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	export	Should this value be exported. Export strips fields that a user can not specify.	false	boolean
QueryParameter	exact	Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'	false	boolean
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.60.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.106, “v1.Pod”

3.2.60.3. Consumes

3.2.60.4. Produces

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

3.2.60.5. Tags

apiv1

3.2.61. partially update the specified Pod

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

3.2.61.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.61.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.106, “v1.Pod”

3.2.61.3. Consumes

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

3.2.61.4. Produces

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

3.2.61.5. Tags

apiv1

3.2.62. connect GET requests to attach of Pod

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

3.2.62.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	stdin	Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false.	false	boolean
QueryParameter	stdout	Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true.	false	boolean
QueryParameter	stderr	Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true.	false	boolean
QueryParameter	tty	TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false.	false	boolean
QueryParameter	container	The container in which to execute the command. Defaults to only container if there is only one container in the pod.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.62.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.62.3. Consumes

3.2.62.4. Produces

3.2.62.5. Tags

apiv1

3.2.63. connect POST requests to attach of Pod

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

3.2.63.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	stdin	Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false.	false	boolean
QueryParameter	stdout	Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true.	false	boolean
QueryParameter	stderr	Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true.	false	boolean
QueryParameter	tty	TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false.	false	boolean
QueryParameter	container	The container in which to execute the command. Defaults to only container if there is only one container in the pod.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.63.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.63.3. Consumes

3.2.63.4. Produces

3.2.63.5. Tags

apiv1

3.2.64. create binding of a Binding

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

3.2.64.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.16, “v1.Binding”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Binding	true	string

3.2.64.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.16, “v1.Binding”

3.2.64.3. Consumes

3.2.64.4. Produces

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

3.2.64.5. Tags

apiv1

3.2.65. create eviction of an Eviction

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

3.2.65.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.157, “v1beta1.Eviction”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Eviction	true	string

3.2.65.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.157, “v1beta1.Eviction”

3.2.65.3. Consumes

3.2.65.4. Produces

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

3.2.65.5. Tags

apiv1

3.2.66. connect GET requests to exec of Pod

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

3.2.66.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	stdin	Redirect the standard input stream of the pod for this call. Defaults to false.	false	boolean
QueryParameter	stdout	Redirect the standard output stream of the pod for this call. Defaults to true.	false	boolean
QueryParameter	stderr	Redirect the standard error stream of the pod for this call. Defaults to true.	false	boolean
QueryParameter	tty	TTY if true indicates that a tty will be allocated for the exec call. Defaults to false.	false	boolean
QueryParameter	container	Container in which to execute the command. Defaults to only container if there is only one container in the pod.	false	string
QueryParameter	command	Command is the remote command to execute. argv array. Not executed within a shell.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.66.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.66.3. Consumes

3.2.66.4. Produces

3.2.66.5. Tags

apiv1

3.2.67. connect POST requests to exec of Pod

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

3.2.67.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	stdin	Redirect the standard input stream of the pod for this call. Defaults to false.	false	boolean
QueryParameter	stdout	Redirect the standard output stream of the pod for this call. Defaults to true.	false	boolean
QueryParameter	stderr	Redirect the standard error stream of the pod for this call. Defaults to true.	false	boolean
QueryParameter	tty	TTY if true indicates that a tty will be allocated for the exec call. Defaults to false.	false	boolean
QueryParameter	container	Container in which to execute the command. Defaults to only container if there is only one container in the pod.	false	string
QueryParameter	command	Command is the remote command to execute. argv array. Not executed within a shell.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.67.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.67.3. Consumes

3.2.67.4. Produces

3.2.67.5. Tags

apiv1

3.2.68. read log of the specified Pod

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

3.2.68.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	container	The container for which to stream logs. Defaults to only container if there is one container in the pod.	false	string
QueryParameter	follow	Follow the log stream of the pod. Defaults to false.	false	boolean
QueryParameter	previous	Return previous terminated container logs. Defaults to false.	false	boolean
QueryParameter	sinceSeconds	A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.	false	integer
QueryParameter	sinceTime	An RFC3339 timestamp 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	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
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.68.2. Responses

HTTP Code	Description	Schema
200	success	string

3.2.68.3. Consumes

3.2.68.4. Produces

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

3.2.68.5. Tags

apiv1

3.2.69. connect GET requests to portforward of Pod

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

3.2.69.1. Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.69.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.69.3. Consumes

3.2.69.4. Produces

3.2.69.5. Tags

apiv1

3.2.70. connect POST requests to portforward of Pod

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

3.2.70.1. Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.70.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.70.3. Consumes

3.2.70.4. Produces

3.2.70.5. Tags

apiv1

3.2.71. connect DELETE requests to proxy of Pod

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

3.2.71.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the URL path to use for the current proxy request to pod.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.71.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.71.3. Consumes

3.2.71.4. Produces

3.2.71.5. Tags

apiv1

3.2.72. connect PUT requests to proxy of Pod

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

3.2.72.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the URL path to use for the current proxy request to pod.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.72.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.72.3. Consumes

3.2.72.4. Produces

3.2.72.5. Tags

apiv1

3.2.73. connect GET requests to proxy of Pod

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

3.2.73.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the URL path to use for the current proxy request to pod.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.73.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.73.3. Consumes

3.2.73.4. Produces

3.2.73.5. Tags

apiv1

3.2.74. connect POST requests to proxy of Pod

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

3.2.74.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the URL path to use for the current proxy request to pod.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.74.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.74.3. Consumes

3.2.74.4. Produces

3.2.74.5. Tags

apiv1

3.2.75. connect HEAD requests to proxy of Pod

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

3.2.75.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the URL path to use for the current proxy request to pod.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.75.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.75.3. Consumes

3.2.75.4. Produces

3.2.75.5. Tags

apiv1

3.2.76. connect OPTIONS requests to proxy of Pod

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

3.2.76.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the URL path to use for the current proxy request to pod.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.76.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.76.3. Consumes

3.2.76.4. Produces

3.2.76.5. Tags

apiv1

3.2.77. connect DELETE requests to proxy of Pod

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

3.2.77.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the URL path to use for the current proxy request to pod.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string
PathParameter	path	path to the resource	true	string

3.2.77.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.77.3. Consumes

3.2.77.4. Produces

3.2.77.5. Tags

apiv1

3.2.78. connect PUT requests to proxy of Pod

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

3.2.78.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the URL path to use for the current proxy request to pod.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string
PathParameter	path	path to the resource	true	string

3.2.78.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.78.3. Consumes

3.2.78.4. Produces

3.2.78.5. Tags

apiv1

3.2.79. connect GET requests to proxy of Pod

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

3.2.79.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the URL path to use for the current proxy request to pod.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string
PathParameter	path	path to the resource	true	string

3.2.79.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.79.3. Consumes

3.2.79.4. Produces

3.2.79.5. Tags

apiv1

3.2.80. connect POST requests to proxy of Pod

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

3.2.80.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the URL path to use for the current proxy request to pod.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string
PathParameter	path	path to the resource	true	string

3.2.80.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.80.3. Consumes

3.2.80.4. Produces

3.2.80.5. Tags

apiv1

3.2.81. connect HEAD requests to proxy of Pod

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

3.2.81.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the URL path to use for the current proxy request to pod.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string
PathParameter	path	path to the resource	true	string

3.2.81.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.81.3. Consumes

3.2.81.4. Produces

3.2.81.5. Tags

apiv1

3.2.82. connect OPTIONS requests to proxy of Pod

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

3.2.82.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the URL path to use for the current proxy request to pod.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string
PathParameter	path	path to the resource	true	string

3.2.82.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.82.3. Consumes

3.2.82.4. Produces

3.2.82.5. Tags

apiv1

3.2.83. replace status of the specified Pod

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

3.2.83.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.106, “v1.Pod”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.83.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.106, “v1.Pod”

3.2.83.3. Consumes

3.2.83.4. Produces

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

3.2.83.5. Tags

apiv1

3.2.84. read status of the specified Pod

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

3.2.84.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.84.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.106, “v1.Pod”

3.2.84.3. Consumes

3.2.84.4. Produces

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

3.2.84.5. Tags

apiv1

3.2.85. partially update status of the specified Pod

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

3.2.85.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.85.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.106, “v1.Pod”

3.2.85.3. Consumes

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

3.2.85.4. Produces

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

3.2.85.5. Tags

apiv1

3.2.86. delete collection of PodTemplate

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

3.2.86.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.86.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.86.3. Consumes

3.2.86.4. Produces

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

3.2.86.5. Tags

apiv1

3.2.87. list or watch objects of kind PodTemplate

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

3.2.87.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.87.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.113, “v1.PodTemplateList”

3.2.87.3. Consumes

3.2.87.4. Produces

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

3.2.87.5. Tags

apiv1

3.2.88. create a PodTemplate

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

3.2.88.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.112, “v1.PodTemplate”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.88.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.112, “v1.PodTemplate”

3.2.88.3. Consumes

3.2.88.4. Produces

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

3.2.88.5. Tags

apiv1

3.2.89. delete a PodTemplate

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

3.2.89.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the PodTemplate	true	string

3.2.89.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.89.3. Consumes

3.2.89.4. Produces

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

3.2.89.5. Tags

apiv1

3.2.90. replace the specified PodTemplate

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

3.2.90.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.112, “v1.PodTemplate”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the PodTemplate	true	string

3.2.90.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.112, “v1.PodTemplate”

3.2.90.3. Consumes

3.2.90.4. Produces

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

3.2.90.5. Tags

apiv1

3.2.91. read the specified PodTemplate

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

3.2.91.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	export	Should this value be exported. Export strips fields that a user can not specify.	false	boolean
QueryParameter	exact	Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'	false	boolean
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the PodTemplate	true	string

3.2.91.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.112, “v1.PodTemplate”

3.2.91.3. Consumes

3.2.91.4. Produces

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

3.2.91.5. Tags

apiv1

3.2.92. partially update the specified PodTemplate

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

3.2.92.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the PodTemplate	true	string

3.2.92.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.112, “v1.PodTemplate”

3.2.92.3. Consumes

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

3.2.92.4. Produces

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

3.2.92.5. Tags

apiv1

3.2.93. delete collection of ReplicationController

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

3.2.93.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.93.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.93.3. Consumes

3.2.93.4. Produces

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

3.2.93.5. Tags

apiv1

3.2.94. list or watch objects of kind ReplicationController

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

3.2.94.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.94.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.121, “v1.ReplicationControllerList”

3.2.94.3. Consumes

3.2.94.4. Produces

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

3.2.94.5. Tags

apiv1

3.2.95. create a ReplicationController

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

3.2.95.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.119, “v1.ReplicationController”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.95.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.119, “v1.ReplicationController”

3.2.95.3. Consumes

3.2.95.4. Produces

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

3.2.95.5. Tags

apiv1

3.2.96. delete a ReplicationController

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

3.2.96.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ReplicationController	true	string

3.2.96.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.96.3. Consumes

3.2.96.4. Produces

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

3.2.96.5. Tags

apiv1

3.2.97. replace the specified ReplicationController

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

3.2.97.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.119, “v1.ReplicationController”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ReplicationController	true	string

3.2.97.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.119, “v1.ReplicationController”

3.2.97.3. Consumes

3.2.97.4. Produces

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

3.2.97.5. Tags

apiv1

3.2.98. read the specified ReplicationController

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

3.2.98.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	export	Should this value be exported. Export strips fields that a user can not specify.	false	boolean
QueryParameter	exact	Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'	false	boolean
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ReplicationController	true	string

3.2.98.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.119, “v1.ReplicationController”

3.2.98.3. Consumes

3.2.98.4. Produces

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

3.2.98.5. Tags

apiv1

3.2.99. partially update the specified ReplicationController

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

3.2.99.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ReplicationController	true	string

3.2.99.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.119, “v1.ReplicationController”

3.2.99.3. Consumes

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

3.2.99.4. Produces

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

3.2.99.5. Tags

apiv1

3.2.100. replace scale of the specified Scale

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

3.2.100.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.134, “v1.Scale”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Scale	true	string

3.2.100.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.134, “v1.Scale”

3.2.100.3. Consumes

3.2.100.4. Produces

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

3.2.100.5. Tags

apiv1

3.2.101. read scale of the specified Scale

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

3.2.101.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Scale	true	string

3.2.101.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.134, “v1.Scale”

3.2.101.3. Consumes

3.2.101.4. Produces

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

3.2.101.5. Tags

apiv1

3.2.102. partially update scale of the specified Scale

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

3.2.102.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “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

3.2.102.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.134, “v1.Scale”

3.2.102.3. Consumes

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

3.2.102.4. Produces

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

3.2.102.5. Tags

apiv1

3.2.103. replace status of the specified ReplicationController

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

3.2.103.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.119, “v1.ReplicationController”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ReplicationController	true	string

3.2.103.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.119, “v1.ReplicationController”

3.2.103.3. Consumes

3.2.103.4. Produces

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

3.2.103.5. Tags

apiv1

3.2.104. read status of the specified ReplicationController

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

3.2.104.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ReplicationController	true	string

3.2.104.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.119, “v1.ReplicationController”

3.2.104.3. Consumes

3.2.104.4. Produces

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

3.2.104.5. Tags

apiv1

3.2.105. partially update status of the specified ReplicationController

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

3.2.105.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ReplicationController	true	string

3.2.105.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.119, “v1.ReplicationController”

3.2.105.3. Consumes

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

3.2.105.4. Produces

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

3.2.105.5. Tags

apiv1

3.2.106. delete collection of ResourceQuota

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

3.2.106.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.106.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.106.3. Consumes

3.2.106.4. Produces

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

3.2.106.5. Tags

apiv1

3.2.107. list or watch objects of kind ResourceQuota

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

3.2.107.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.107.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.126, “v1.ResourceQuotaList”

3.2.107.3. Consumes

3.2.107.4. Produces

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

3.2.107.5. Tags

apiv1

3.2.108. create a ResourceQuota

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

3.2.108.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.125, “v1.ResourceQuota”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.108.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.125, “v1.ResourceQuota”

3.2.108.3. Consumes

3.2.108.4. Produces

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

3.2.108.5. Tags

apiv1

3.2.109. delete a ResourceQuota

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

3.2.109.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ResourceQuota	true	string

3.2.109.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.109.3. Consumes

3.2.109.4. Produces

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

3.2.109.5. Tags

apiv1

3.2.110. replace the specified ResourceQuota

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

3.2.110.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.125, “v1.ResourceQuota”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ResourceQuota	true	string

3.2.110.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.125, “v1.ResourceQuota”

3.2.110.3. Consumes

3.2.110.4. Produces

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

3.2.110.5. Tags

apiv1

3.2.111. read the specified ResourceQuota

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

3.2.111.1. Parameters

Type	Name	Description	Required	Schema
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 ResourceQuota	true	string

3.2.111.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.125, “v1.ResourceQuota”

3.2.111.3. Consumes

3.2.111.4. Produces

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

3.2.111.5. Tags

apiv1

3.2.112. partially update the specified ResourceQuota

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

3.2.112.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ResourceQuota	true	string

3.2.112.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.125, “v1.ResourceQuota”

3.2.112.3. Consumes

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

3.2.112.4. Produces

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

3.2.112.5. Tags

apiv1

3.2.113. replace status of the specified ResourceQuota

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

3.2.113.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.125, “v1.ResourceQuota”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ResourceQuota	true	string

3.2.113.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.125, “v1.ResourceQuota”

3.2.113.3. Consumes

3.2.113.4. Produces

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

3.2.113.5. Tags

apiv1

3.2.114. read status of the specified ResourceQuota

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

3.2.114.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ResourceQuota	true	string

3.2.114.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.125, “v1.ResourceQuota”

3.2.114.3. Consumes

3.2.114.4. Produces

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

3.2.114.5. Tags

apiv1

3.2.115. partially update status of the specified ResourceQuota

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

3.2.115.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ResourceQuota	true	string

3.2.115.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.125, “v1.ResourceQuota”

3.2.115.3. Consumes

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

3.2.115.4. Produces

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

3.2.115.5. Tags

apiv1

3.2.116. delete collection of Secret

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

3.2.116.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.116.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.116.3. Consumes

3.2.116.4. Produces

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

3.2.116.5. Tags

apiv1

3.2.117. list or watch objects of kind Secret

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

3.2.117.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.117.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.226, “v1.SecretList”

3.2.117.3. Consumes

3.2.117.4. Produces

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

3.2.117.5. Tags

apiv1

3.2.118. create a Secret

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

3.2.118.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.223, “v1.Secret”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.118.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.223, “v1.Secret”

3.2.118.3. Consumes

3.2.118.4. Produces

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

3.2.118.5. Tags

apiv1

3.2.119. delete a Secret

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

3.2.119.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Secret	true	string

3.2.119.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.119.3. Consumes

3.2.119.4. Produces

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

3.2.119.5. Tags

apiv1

3.2.120. replace the specified Secret

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

3.2.120.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.223, “v1.Secret”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Secret	true	string

3.2.120.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.223, “v1.Secret”

3.2.120.3. Consumes

3.2.120.4. Produces

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

3.2.120.5. Tags

apiv1

3.2.121. read the specified Secret

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

3.2.121.1. Parameters

Type	Name	Description	Required	Schema
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 Secret	true	string

3.2.121.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.223, “v1.Secret”

3.2.121.3. Consumes

3.2.121.4. Produces

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

3.2.121.5. Tags

apiv1

3.2.122. partially update the specified Secret

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

3.2.122.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Secret	true	string

3.2.122.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.223, “v1.Secret”

3.2.122.3. Consumes

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

3.2.122.4. Produces

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

3.2.122.5. Tags

apiv1

3.2.123. delete collection of ServiceAccount

DELETE /api/v1/namespaces/{namespace}/serviceaccounts

3.2.123.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.123.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.123.3. Consumes

3.2.123.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.123.5. Tags

apiv1

3.2.124. list or watch objects of kind ServiceAccount

GET /api/v1/namespaces/{namespace}/serviceaccounts

3.2.124.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.124.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.146, “v1.ServiceAccountList”

3.2.124.3. Consumes

3.2.124.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.124.5. Tags

apiv1

3.2.125. create a ServiceAccount

POST /api/v1/namespaces/{namespace}/serviceaccounts

3.2.125.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.145, “v1.ServiceAccount”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.125.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.145, “v1.ServiceAccount”

3.2.125.3. Consumes

3.2.125.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.125.5. Tags

apiv1

3.2.126. delete a ServiceAccount

DELETE /api/v1/namespaces/{namespace}/serviceaccounts/{name}

3.2.126.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ServiceAccount	true	string

3.2.126.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.126.3. Consumes

3.2.126.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.126.5. Tags

apiv1

3.2.127. replace the specified ServiceAccount

PUT /api/v1/namespaces/{namespace}/serviceaccounts/{name}

3.2.127.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.145, “v1.ServiceAccount”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ServiceAccount	true	string

3.2.127.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.145, “v1.ServiceAccount”

3.2.127.3. Consumes

3.2.127.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.127.5. Tags

apiv1

3.2.128. read the specified ServiceAccount

GET /api/v1/namespaces/{namespace}/serviceaccounts/{name}

3.2.128.1. Parameters

Type	Name	Description	Required	Schema
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 ServiceAccount	true	string

3.2.128.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.145, “v1.ServiceAccount”

3.2.128.3. Consumes

3.2.128.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.128.5. Tags

apiv1

3.2.129. partially update the specified ServiceAccount

PATCH /api/v1/namespaces/{namespace}/serviceaccounts/{name}

3.2.129.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the ServiceAccount	true	string

3.2.129.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.145, “v1.ServiceAccount”

3.2.129.3. Consumes

application/json-patch+json
application/merge-patch+json
application/strategic-merge-patch+json

3.2.129.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.129.5. Tags

apiv1

3.2.130. list or watch objects of kind Service

GET /api/v1/namespaces/{namespace}/services

3.2.130.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.130.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.147, “v1.ServiceList”

3.2.130.3. Consumes

3.2.130.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.130.5. Tags

apiv1

3.2.131. create a Service

POST /api/v1/namespaces/{namespace}/services

3.2.131.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.144, “v1.Service”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string

3.2.131.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.144, “v1.Service”

3.2.131.3. Consumes

3.2.131.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.131.5. Tags

apiv1

3.2.132. delete a Service

DELETE /api/v1/namespaces/{namespace}/services/{name}

3.2.132.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string

3.2.132.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.132.3. Consumes

3.2.132.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.132.5. Tags

apiv1

3.2.133. replace the specified Service

PUT /api/v1/namespaces/{namespace}/services/{name}

3.2.133.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.144, “v1.Service”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string

3.2.133.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.144, “v1.Service”

3.2.133.3. Consumes

3.2.133.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.133.5. Tags

apiv1

3.2.134. read the specified Service

GET /api/v1/namespaces/{namespace}/services/{name}

3.2.134.1. Parameters

Type	Name	Description	Required	Schema
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 Service	true	string

3.2.134.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.144, “v1.Service”

3.2.134.3. Consumes

3.2.134.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.134.5. Tags

apiv1

3.2.135. partially update the specified Service

PATCH /api/v1/namespaces/{namespace}/services/{name}

3.2.135.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string

3.2.135.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.144, “v1.Service”

3.2.135.3. Consumes

application/json-patch+json
application/merge-patch+json
application/strategic-merge-patch+json

3.2.135.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.135.5. Tags

apiv1

3.2.136. connect DELETE requests to proxy of Service

DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy

3.2.136.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string

3.2.136.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.136.3. Consumes

3.2.136.4. Produces

3.2.136.5. Tags

apiv1

3.2.137. connect PUT requests to proxy of Service

PUT /api/v1/namespaces/{namespace}/services/{name}/proxy

3.2.137.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string

3.2.137.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.137.3. Consumes

3.2.137.4. Produces

3.2.137.5. Tags

apiv1

3.2.138. connect GET requests to proxy of Service

GET /api/v1/namespaces/{namespace}/services/{name}/proxy

3.2.138.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string

3.2.138.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.138.3. Consumes

3.2.138.4. Produces

3.2.138.5. Tags

apiv1

3.2.139. connect POST requests to proxy of Service

POST /api/v1/namespaces/{namespace}/services/{name}/proxy

3.2.139.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string

3.2.139.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.139.3. Consumes

3.2.139.4. Produces

3.2.139.5. Tags

apiv1

3.2.140. connect HEAD requests to proxy of Service

HEAD /api/v1/namespaces/{namespace}/services/{name}/proxy

3.2.140.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string

3.2.140.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.140.3. Consumes

3.2.140.4. Produces

3.2.140.5. Tags

apiv1

3.2.141. connect OPTIONS requests to proxy of Service

OPTIONS /api/v1/namespaces/{namespace}/services/{name}/proxy

3.2.141.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string

3.2.141.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.141.3. Consumes

3.2.141.4. Produces

3.2.141.5. Tags

apiv1

3.2.142. connect DELETE requests to proxy of Service

DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}

3.2.142.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string
PathParameter	path	path to the resource	true	string

3.2.142.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.142.3. Consumes

3.2.142.4. Produces

3.2.142.5. Tags

apiv1

3.2.143. connect PUT requests to proxy of Service

PUT /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}

3.2.143.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string
PathParameter	path	path to the resource	true	string

3.2.143.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.143.3. Consumes

3.2.143.4. Produces

3.2.143.5. Tags

apiv1

3.2.144. connect GET requests to proxy of Service

GET /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}

3.2.144.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string
PathParameter	path	path to the resource	true	string

3.2.144.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.144.3. Consumes

3.2.144.4. Produces

3.2.144.5. Tags

apiv1

3.2.145. connect POST requests to proxy of Service

POST /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}

3.2.145.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string
PathParameter	path	path to the resource	true	string

3.2.145.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.145.3. Consumes

3.2.145.4. Produces

3.2.145.5. Tags

apiv1

3.2.146. connect HEAD requests to proxy of Service

HEAD /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}

3.2.146.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string
PathParameter	path	path to the resource	true	string

3.2.146.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.146.3. Consumes

3.2.146.4. Produces

3.2.146.5. Tags

apiv1

3.2.147. connect OPTIONS requests to proxy of Service

OPTIONS /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}

3.2.147.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string
PathParameter	path	path to the resource	true	string

3.2.147.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.147.3. Consumes

3.2.147.4. Produces

3.2.147.5. Tags

apiv1

3.2.148. replace status of the specified Service

PUT /api/v1/namespaces/{namespace}/services/{name}/status

3.2.148.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.144, “v1.Service”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string

3.2.148.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.144, “v1.Service”

3.2.148.3. Consumes

3.2.148.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.148.5. Tags

apiv1

3.2.149. read status of the specified Service

GET /api/v1/namespaces/{namespace}/services/{name}/status

3.2.149.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string

3.2.149.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.144, “v1.Service”

3.2.149.3. Consumes

3.2.149.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.149.5. Tags

apiv1

3.2.150. partially update status of the specified Service

PATCH /api/v1/namespaces/{namespace}/services/{name}/status

3.2.150.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string

3.2.150.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.144, “v1.Service”

3.2.150.3. Consumes

application/json-patch+json
application/merge-patch+json
application/strategic-merge-patch+json

3.2.150.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.150.5. Tags

apiv1

3.2.151. delete a Namespace

DELETE /api/v1/namespaces/{name}

3.2.151.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	name	name of the Namespace	true	string

3.2.151.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.151.3. Consumes

3.2.151.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.151.5. Tags

apiv1

3.2.152. replace the specified Namespace

PUT /api/v1/namespaces/{name}

3.2.152.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.79, “v1.Namespace”
PathParameter	name	name of the Namespace	true	string

3.2.152.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.79, “v1.Namespace”

3.2.152.3. Consumes

3.2.152.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.152.5. Tags

apiv1

3.2.153. read the specified Namespace

GET /api/v1/namespaces/{name}

3.2.153.1. Parameters

Type	Name	Description	Required	Schema
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 Namespace	true	string

3.2.153.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.79, “v1.Namespace”

3.2.153.3. Consumes

3.2.153.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.153.5. Tags

apiv1

3.2.154. partially update the specified Namespace

PATCH /api/v1/namespaces/{name}

3.2.154.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	name	name of the Namespace	true	string

3.2.154.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.79, “v1.Namespace”

3.2.154.3. Consumes

application/json-patch+json
application/merge-patch+json
application/strategic-merge-patch+json

3.2.154.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.154.5. Tags

apiv1

3.2.155. replace finalize of the specified Namespace

PUT /api/v1/namespaces/{name}/finalize

3.2.155.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.79, “v1.Namespace”
PathParameter	name	name of the Namespace	true	string

3.2.155.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.79, “v1.Namespace”

3.2.155.3. Consumes

3.2.155.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.155.5. Tags

apiv1

3.2.156. replace status of the specified Namespace

PUT /api/v1/namespaces/{name}/status

3.2.156.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.79, “v1.Namespace”
PathParameter	name	name of the Namespace	true	string

3.2.156.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.79, “v1.Namespace”

3.2.156.3. Consumes

3.2.156.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.156.5. Tags

apiv1

3.2.157. read status of the specified Namespace

GET /api/v1/namespaces/{name}/status

3.2.157.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	name	name of the Namespace	true	string

3.2.157.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.79, “v1.Namespace”

3.2.157.3. Consumes

3.2.157.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.157.5. Tags

apiv1

3.2.158. partially update status of the specified Namespace

PATCH /api/v1/namespaces/{name}/status

3.2.158.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	name	name of the Namespace	true	string

3.2.158.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.79, “v1.Namespace”

3.2.158.3. Consumes

application/json-patch+json
application/merge-patch+json
application/strategic-merge-patch+json

3.2.158.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.158.5. Tags

apiv1

3.2.159. delete collection of Node

DELETE /api/v1/nodes

3.2.159.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.159.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.159.3. Consumes

3.2.159.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.159.5. Tags

apiv1

3.2.160. list or watch objects of kind Node

GET /api/v1/nodes

3.2.160.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.160.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.87, “v1.NodeList”

3.2.160.3. Consumes

3.2.160.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.160.5. Tags

apiv1

3.2.161. create a Node

POST /api/v1/nodes

3.2.161.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.83, “v1.Node”

3.2.161.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.83, “v1.Node”

3.2.161.3. Consumes

3.2.161.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.161.5. Tags

apiv1

3.2.162. delete a Node

DELETE /api/v1/nodes/{name}

3.2.162.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	name	name of the Node	true	string

3.2.162.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.162.3. Consumes

3.2.162.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.162.5. Tags

apiv1

3.2.163. replace the specified Node

PUT /api/v1/nodes/{name}

3.2.163.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.83, “v1.Node”
PathParameter	name	name of the Node	true	string

3.2.163.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.83, “v1.Node”

3.2.163.3. Consumes

3.2.163.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.163.5. Tags

apiv1

3.2.164. read the specified Node

GET /api/v1/nodes/{name}

3.2.164.1. Parameters

Type	Name	Description	Required	Schema
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 Node	true	string

3.2.164.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.83, “v1.Node”

3.2.164.3. Consumes

3.2.164.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.164.5. Tags

apiv1

3.2.165. partially update the specified Node

PATCH /api/v1/nodes/{name}

3.2.165.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	name	name of the Node	true	string

3.2.165.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.83, “v1.Node”

3.2.165.3. Consumes

application/json-patch+json
application/merge-patch+json
application/strategic-merge-patch+json

3.2.165.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.165.5. Tags

apiv1

3.2.166. connect DELETE requests to proxy of Node

DELETE /api/v1/nodes/{name}/proxy

3.2.166.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	path	Path is the URL path to use for the current proxy request to node.	false	string
PathParameter	name	name of the Node	true	string

3.2.166.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.166.3. Consumes

3.2.166.4. Produces

3.2.166.5. Tags

apiv1

3.2.167. connect PUT requests to proxy of Node

PUT /api/v1/nodes/{name}/proxy

3.2.167.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	path	Path is the URL path to use for the current proxy request to node.	false	string
PathParameter	name	name of the Node	true	string

3.2.167.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.167.3. Consumes

3.2.167.4. Produces

3.2.167.5. Tags

apiv1

3.2.168. connect GET requests to proxy of Node

GET /api/v1/nodes/{name}/proxy

3.2.168.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	path	Path is the URL path to use for the current proxy request to node.	false	string
PathParameter	name	name of the Node	true	string

3.2.168.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.168.3. Consumes

3.2.168.4. Produces

3.2.168.5. Tags

apiv1

3.2.169. connect POST requests to proxy of Node

POST /api/v1/nodes/{name}/proxy

3.2.169.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	path	Path is the URL path to use for the current proxy request to node.	false	string
PathParameter	name	name of the Node	true	string

3.2.169.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.169.3. Consumes

3.2.169.4. Produces

3.2.169.5. Tags

apiv1

3.2.170. connect HEAD requests to proxy of Node

HEAD /api/v1/nodes/{name}/proxy

3.2.170.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	path	Path is the URL path to use for the current proxy request to node.	false	string
PathParameter	name	name of the Node	true	string

3.2.170.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.170.3. Consumes

3.2.170.4. Produces

3.2.170.5. Tags

apiv1

3.2.171. connect OPTIONS requests to proxy of Node

OPTIONS /api/v1/nodes/{name}/proxy

3.2.171.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	path	Path is the URL path to use for the current proxy request to node.	false	string
PathParameter	name	name of the Node	true	string

3.2.171.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.171.3. Consumes

3.2.171.4. Produces

3.2.171.5. Tags

apiv1

3.2.172. connect DELETE requests to proxy of Node

DELETE /api/v1/nodes/{name}/proxy/{path}

3.2.172.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the URL path to use for the current proxy request to node.	false	string
PathParameter	name	name of the Node	true	string
PathParameter	path	path to the resource	true	string

3.2.172.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.172.3. Consumes

3.2.172.4. Produces

3.2.172.5. Tags

apiv1

3.2.173. connect PUT requests to proxy of Node

PUT /api/v1/nodes/{name}/proxy/{path}

3.2.173.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the URL path to use for the current proxy request to node.	false	string
PathParameter	name	name of the Node	true	string
PathParameter	path	path to the resource	true	string

3.2.173.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.173.3. Consumes

3.2.173.4. Produces

3.2.173.5. Tags

apiv1

3.2.174. connect GET requests to proxy of Node

GET /api/v1/nodes/{name}/proxy/{path}

3.2.174.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the URL path to use for the current proxy request to node.	false	string
PathParameter	name	name of the Node	true	string
PathParameter	path	path to the resource	true	string

3.2.174.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.174.3. Consumes

3.2.174.4. Produces

3.2.174.5. Tags

apiv1

3.2.175. connect POST requests to proxy of Node

POST /api/v1/nodes/{name}/proxy/{path}

3.2.175.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the URL path to use for the current proxy request to node.	false	string
PathParameter	name	name of the Node	true	string
PathParameter	path	path to the resource	true	string

3.2.175.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.175.3. Consumes

3.2.175.4. Produces

3.2.175.5. Tags

apiv1

3.2.176. connect HEAD requests to proxy of Node

HEAD /api/v1/nodes/{name}/proxy/{path}

3.2.176.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the URL path to use for the current proxy request to node.	false	string
PathParameter	name	name of the Node	true	string
PathParameter	path	path to the resource	true	string

3.2.176.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.176.3. Consumes

3.2.176.4. Produces

3.2.176.5. Tags

apiv1

3.2.177. connect OPTIONS requests to proxy of Node

OPTIONS /api/v1/nodes/{name}/proxy/{path}

3.2.177.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	path	Path is the URL path to use for the current proxy request to node.	false	string
PathParameter	name	name of the Node	true	string
PathParameter	path	path to the resource	true	string

3.2.177.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.177.3. Consumes

3.2.177.4. Produces

3.2.177.5. Tags

apiv1

3.2.178. replace status of the specified Node

PUT /api/v1/nodes/{name}/status

3.2.178.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.83, “v1.Node”
PathParameter	name	name of the Node	true	string

3.2.178.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.83, “v1.Node”

3.2.178.3. Consumes

3.2.178.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.178.5. Tags

apiv1

3.2.179. read status of the specified Node

GET /api/v1/nodes/{name}/status

3.2.179.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	name	name of the Node	true	string

3.2.179.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.83, “v1.Node”

3.2.179.3. Consumes

3.2.179.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.179.5. Tags

apiv1

3.2.180. partially update status of the specified Node

PATCH /api/v1/nodes/{name}/status

3.2.180.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	name	name of the Node	true	string

3.2.180.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.83, “v1.Node”

3.2.180.3. Consumes

application/json-patch+json
application/merge-patch+json
application/strategic-merge-patch+json

3.2.180.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.180.5. Tags

apiv1

3.2.181. list or watch objects of kind PersistentVolumeClaim

GET /api/v1/persistentvolumeclaims

3.2.181.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.181.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.98, “v1.PersistentVolumeClaimList”

3.2.181.3. Consumes

3.2.181.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.181.5. Tags

apiv1

3.2.182. create a PersistentVolumeClaim

POST /api/v1/persistentvolumeclaims

3.2.182.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.97, “v1.PersistentVolumeClaim”

3.2.182.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.97, “v1.PersistentVolumeClaim”

3.2.182.3. Consumes

3.2.182.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.182.5. Tags

apiv1

3.2.183. delete collection of PersistentVolume

DELETE /api/v1/persistentvolumes

3.2.183.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.183.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.183.3. Consumes

3.2.183.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.183.5. Tags

apiv1

3.2.184. list or watch objects of kind PersistentVolume

GET /api/v1/persistentvolumes

3.2.184.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.184.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.102, “v1.PersistentVolumeList”

3.2.184.3. Consumes

3.2.184.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.184.5. Tags

apiv1

3.2.185. create a PersistentVolume

POST /api/v1/persistentvolumes

3.2.185.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.95, “v1.PersistentVolume”

3.2.185.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.95, “v1.PersistentVolume”

3.2.185.3. Consumes

3.2.185.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.185.5. Tags

apiv1

3.2.186. delete a PersistentVolume

DELETE /api/v1/persistentvolumes/{name}

3.2.186.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	name	name of the PersistentVolume	true	string

3.2.186.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.186.3. Consumes

3.2.186.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.186.5. Tags

apiv1

3.2.187. replace the specified PersistentVolume

PUT /api/v1/persistentvolumes/{name}

3.2.187.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.95, “v1.PersistentVolume”
PathParameter	name	name of the PersistentVolume	true	string

3.2.187.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.95, “v1.PersistentVolume”

3.2.187.3. Consumes

3.2.187.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.187.5. Tags

apiv1

3.2.188. read the specified PersistentVolume

GET /api/v1/persistentvolumes/{name}

3.2.188.1. Parameters

Type	Name	Description	Required	Schema
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 PersistentVolume	true	string

3.2.188.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.95, “v1.PersistentVolume”

3.2.188.3. Consumes

3.2.188.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.188.5. Tags

apiv1

3.2.189. partially update the specified PersistentVolume

PATCH /api/v1/persistentvolumes/{name}

3.2.189.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	name	name of the PersistentVolume	true	string

3.2.189.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.95, “v1.PersistentVolume”

3.2.189.3. Consumes

application/json-patch+json
application/merge-patch+json
application/strategic-merge-patch+json

3.2.189.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.189.5. Tags

apiv1

3.2.190. replace status of the specified PersistentVolume

PUT /api/v1/persistentvolumes/{name}/status

3.2.190.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.95, “v1.PersistentVolume”
PathParameter	name	name of the PersistentVolume	true	string

3.2.190.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.95, “v1.PersistentVolume”

3.2.190.3. Consumes

3.2.190.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.190.5. Tags

apiv1

3.2.191. read status of the specified PersistentVolume

GET /api/v1/persistentvolumes/{name}/status

3.2.191.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
PathParameter	name	name of the PersistentVolume	true	string

3.2.191.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.95, “v1.PersistentVolume”

3.2.191.3. Consumes

3.2.191.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.191.5. Tags

apiv1

3.2.192. partially update status of the specified PersistentVolume

PATCH /api/v1/persistentvolumes/{name}/status

3.2.192.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	name	name of the PersistentVolume	true	string

3.2.192.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.95, “v1.PersistentVolume”

3.2.192.3. Consumes

application/json-patch+json
application/merge-patch+json
application/strategic-merge-patch+json

3.2.192.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.192.5. Tags

apiv1

3.2.193. list or watch objects of kind Pod

GET /api/v1/pods

3.2.193.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.193.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.108, “v1.PodList”

3.2.193.3. Consumes

3.2.193.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.193.5. Tags

apiv1

3.2.194. create a Pod

POST /api/v1/pods

3.2.194.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.106, “v1.Pod”

3.2.194.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.106, “v1.Pod”

3.2.194.3. Consumes

3.2.194.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.194.5. Tags

apiv1

3.2.195. list or watch objects of kind PodTemplate

GET /api/v1/podtemplates

3.2.195.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.195.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.113, “v1.PodTemplateList”

3.2.195.3. Consumes

3.2.195.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.195.5. Tags

apiv1

3.2.196. create a PodTemplate

POST /api/v1/podtemplates

3.2.196.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.112, “v1.PodTemplate”

3.2.196.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.112, “v1.PodTemplate”

3.2.196.3. Consumes

3.2.196.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.196.5. Tags

apiv1

3.2.197. proxy DELETE requests to Pod

DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}

3.2.197.1. Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.197.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.197.3. Consumes

3.2.197.4. Produces

3.2.197.5. Tags

apiv1

3.2.198. proxy PUT requests to Pod

PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}

3.2.198.1. Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.198.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.198.3. Consumes

3.2.198.4. Produces

3.2.198.5. Tags

apiv1

3.2.199. proxy GET requests to Pod

GET /api/v1/proxy/namespaces/{namespace}/pods/{name}

3.2.199.1. Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.199.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.199.3. Consumes

3.2.199.4. Produces

3.2.199.5. Tags

apiv1

3.2.200. proxy POST requests to Pod

POST /api/v1/proxy/namespaces/{namespace}/pods/{name}

3.2.200.1. Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.200.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.200.3. Consumes

3.2.200.4. Produces

3.2.200.5. Tags

apiv1

3.2.201. proxy HEAD requests to Pod

HEAD /api/v1/proxy/namespaces/{namespace}/pods/{name}

3.2.201.1. Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.201.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.201.3. Consumes

3.2.201.4. Produces

3.2.201.5. Tags

apiv1

3.2.202. proxy OPTIONS requests to Pod

OPTIONS /api/v1/proxy/namespaces/{namespace}/pods/{name}

3.2.202.1. Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string

3.2.202.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.202.3. Consumes

3.2.202.4. Produces

3.2.202.5. Tags

apiv1

3.2.203. proxy DELETE requests to Pod

DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}

3.2.203.1. Parameters

Type	Name	Description	Required	Schema
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string
PathParameter	path	path to the resource	true	string

3.2.203.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.203.3. Consumes

3.2.203.4. Produces

3.2.203.5. Tags

apiv1

3.2.204. proxy PUT requests to Pod

PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}

3.2.204.1. Parameters

Type	Name	Description	Required	Schema
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string
PathParameter	path	path to the resource	true	string

3.2.204.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.204.3. Consumes

3.2.204.4. Produces

3.2.204.5. Tags

apiv1

3.2.205. proxy GET requests to Pod

GET /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}

3.2.205.1. Parameters

Type	Name	Description	Required	Schema
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string
PathParameter	path	path to the resource	true	string

3.2.205.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.205.3. Consumes

3.2.205.4. Produces

3.2.205.5. Tags

apiv1

3.2.206. proxy POST requests to Pod

POST /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}

3.2.206.1. Parameters

Type	Name	Description	Required	Schema
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string
PathParameter	path	path to the resource	true	string

3.2.206.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.206.3. Consumes

3.2.206.4. Produces

3.2.206.5. Tags

apiv1

3.2.207. proxy HEAD requests to Pod

HEAD /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}

3.2.207.1. Parameters

Type	Name	Description	Required	Schema
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string
PathParameter	path	path to the resource	true	string

3.2.207.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.207.3. Consumes

3.2.207.4. Produces

3.2.207.5. Tags

apiv1

3.2.208. proxy OPTIONS requests to Pod

OPTIONS /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}

3.2.208.1. Parameters

Type	Name	Description	Required	Schema
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Pod	true	string
PathParameter	path	path to the resource	true	string

3.2.208.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.208.3. Consumes

3.2.208.4. Produces

3.2.208.5. Tags

apiv1

3.2.209. proxy DELETE requests to Service

DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}

3.2.209.1. Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string

3.2.209.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.209.3. Consumes

3.2.209.4. Produces

3.2.209.5. Tags

apiv1

3.2.210. proxy PUT requests to Service

PUT /api/v1/proxy/namespaces/{namespace}/services/{name}

3.2.210.1. Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string

3.2.210.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.210.3. Consumes

3.2.210.4. Produces

3.2.210.5. Tags

apiv1

3.2.211. proxy GET requests to Service

GET /api/v1/proxy/namespaces/{namespace}/services/{name}

3.2.211.1. Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string

3.2.211.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.211.3. Consumes

3.2.211.4. Produces

3.2.211.5. Tags

apiv1

3.2.212. proxy POST requests to Service

POST /api/v1/proxy/namespaces/{namespace}/services/{name}

3.2.212.1. Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string

3.2.212.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.212.3. Consumes

3.2.212.4. Produces

3.2.212.5. Tags

apiv1

3.2.213. proxy HEAD requests to Service

HEAD /api/v1/proxy/namespaces/{namespace}/services/{name}

3.2.213.1. Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string

3.2.213.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.213.3. Consumes

3.2.213.4. Produces

3.2.213.5. Tags

apiv1

3.2.214. proxy OPTIONS requests to Service

OPTIONS /api/v1/proxy/namespaces/{namespace}/services/{name}

3.2.214.1. Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string

3.2.214.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.214.3. Consumes

3.2.214.4. Produces

3.2.214.5. Tags

apiv1

3.2.215. proxy DELETE requests to Service

DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}

3.2.215.1. Parameters

Type	Name	Description	Required	Schema
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string
PathParameter	path	path to the resource	true	string

3.2.215.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.215.3. Consumes

3.2.215.4. Produces

3.2.215.5. Tags

apiv1

3.2.216. proxy PUT requests to Service

PUT /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}

3.2.216.1. Parameters

Type	Name	Description	Required	Schema
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string
PathParameter	path	path to the resource	true	string

3.2.216.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.216.3. Consumes

3.2.216.4. Produces

3.2.216.5. Tags

apiv1

3.2.217. proxy GET requests to Service

GET /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}

3.2.217.1. Parameters

Type	Name	Description	Required	Schema
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string
PathParameter	path	path to the resource	true	string

3.2.217.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.217.3. Consumes

3.2.217.4. Produces

3.2.217.5. Tags

apiv1

3.2.218. proxy POST requests to Service

POST /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}

3.2.218.1. Parameters

Type	Name	Description	Required	Schema
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string
PathParameter	path	path to the resource	true	string

3.2.218.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.218.3. Consumes

3.2.218.4. Produces

3.2.218.5. Tags

apiv1

3.2.219. proxy HEAD requests to Service

HEAD /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}

3.2.219.1. Parameters

Type	Name	Description	Required	Schema
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string
PathParameter	path	path to the resource	true	string

3.2.219.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.219.3. Consumes

3.2.219.4. Produces

3.2.219.5. Tags

apiv1

3.2.220. proxy OPTIONS requests to Service

OPTIONS /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}

3.2.220.1. Parameters

Type	Name	Description	Required	Schema
PathParameter	namespace	object name and auth scope, such as for teams and projects	true	string
PathParameter	name	name of the Service	true	string
PathParameter	path	path to the resource	true	string

3.2.220.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.220.3. Consumes

3.2.220.4. Produces

3.2.220.5. Tags

apiv1

3.2.221. proxy DELETE requests to Node

DELETE /api/v1/proxy/nodes/{name}

3.2.221.1. Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	name	name of the Node	true	string

3.2.221.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.221.3. Consumes

3.2.221.4. Produces

3.2.221.5. Tags

apiv1

3.2.222. proxy PUT requests to Node

PUT /api/v1/proxy/nodes/{name}

3.2.222.1. Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	name	name of the Node	true	string

3.2.222.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.222.3. Consumes

3.2.222.4. Produces

3.2.222.5. Tags

apiv1

3.2.223. proxy GET requests to Node

GET /api/v1/proxy/nodes/{name}

3.2.223.1. Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	name	name of the Node	true	string

3.2.223.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.223.3. Consumes

3.2.223.4. Produces

3.2.223.5. Tags

apiv1

3.2.224. proxy POST requests to Node

POST /api/v1/proxy/nodes/{name}

3.2.224.1. Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	name	name of the Node	true	string

3.2.224.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.224.3. Consumes

3.2.224.4. Produces

3.2.224.5. Tags

apiv1

3.2.225. proxy HEAD requests to Node

HEAD /api/v1/proxy/nodes/{name}

3.2.225.1. Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	name	name of the Node	true	string

3.2.225.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.225.3. Consumes

3.2.225.4. Produces

3.2.225.5. Tags

apiv1

3.2.226. proxy OPTIONS requests to Node

OPTIONS /api/v1/proxy/nodes/{name}

3.2.226.1. Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	name	name of the Node	true	string

3.2.226.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.226.3. Consumes

3.2.226.4. Produces

3.2.226.5. Tags

apiv1

3.2.227. proxy DELETE requests to Node

DELETE /api/v1/proxy/nodes/{name}/{path}

3.2.227.1. Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	name	name of the Node	true	string
PathParameter	path	path to the resource	true	string

3.2.227.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.227.3. Consumes

3.2.227.4. Produces

3.2.227.5. Tags

apiv1

3.2.228. proxy PUT requests to Node

PUT /api/v1/proxy/nodes/{name}/{path}

3.2.228.1. Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	name	name of the Node	true	string
PathParameter	path	path to the resource	true	string

3.2.228.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.228.3. Consumes

3.2.228.4. Produces

3.2.228.5. Tags

apiv1

3.2.229. proxy GET requests to Node

GET /api/v1/proxy/nodes/{name}/{path}

3.2.229.1. Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	name	name of the Node	true	string
PathParameter	path	path to the resource	true	string

3.2.229.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.229.3. Consumes

3.2.229.4. Produces

3.2.229.5. Tags

apiv1

3.2.230. proxy POST requests to Node

POST /api/v1/proxy/nodes/{name}/{path}

3.2.230.1. Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	name	name of the Node	true	string
PathParameter	path	path to the resource	true	string

3.2.230.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.230.3. Consumes

3.2.230.4. Produces

3.2.230.5. Tags

apiv1

3.2.231. proxy HEAD requests to Node

HEAD /api/v1/proxy/nodes/{name}/{path}

3.2.231.1. Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	name	name of the Node	true	string
PathParameter	path	path to the resource	true	string

3.2.231.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.231.3. Consumes

3.2.231.4. Produces

3.2.231.5. Tags

apiv1

3.2.232. proxy OPTIONS requests to Node

OPTIONS /api/v1/proxy/nodes/{name}/{path}

3.2.232.1. Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	name	name of the Node	true	string
PathParameter	path	path to the resource	true	string

3.2.232.2. Responses

HTTP Code	Description	Schema
default	success	string

3.2.232.3. Consumes

3.2.232.4. Produces

3.2.232.5. Tags

apiv1

3.2.233. list or watch objects of kind ReplicationController

GET /api/v1/replicationcontrollers

3.2.233.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.233.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.121, “v1.ReplicationControllerList”

3.2.233.3. Consumes

3.2.233.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.233.5. Tags

apiv1

3.2.234. create a ReplicationController

POST /api/v1/replicationcontrollers

3.2.234.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.119, “v1.ReplicationController”

3.2.234.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.119, “v1.ReplicationController”

3.2.234.3. Consumes

3.2.234.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.234.5. Tags

apiv1

3.2.235. list or watch objects of kind ResourceQuota

GET /api/v1/resourcequotas

3.2.235.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.235.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.126, “v1.ResourceQuotaList”

3.2.235.3. Consumes

3.2.235.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.235.5. Tags

apiv1

3.2.236. create a ResourceQuota

POST /api/v1/resourcequotas

3.2.236.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.125, “v1.ResourceQuota”

3.2.236.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.125, “v1.ResourceQuota”

3.2.236.3. Consumes

3.2.236.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.236.5. Tags

apiv1

3.2.237. list or watch objects of kind Secret

GET /api/v1/secrets

3.2.237.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.237.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.226, “v1.SecretList”

3.2.237.3. Consumes

3.2.237.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.237.5. Tags

apiv1

3.2.238. create a Secret

POST /api/v1/secrets

3.2.238.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.223, “v1.Secret”

3.2.238.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.223, “v1.Secret”

3.2.238.3. Consumes

3.2.238.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.238.5. Tags

apiv1

3.2.239. delete collection of SecurityContextConstraints

DELETE /api/v1/securitycontextconstraints

3.2.239.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.239.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.239.3. Consumes

3.2.239.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.239.5. Tags

apiv1

3.2.240. list or watch objects of kind SecurityContextConstraints

GET /api/v1/securitycontextconstraints

3.2.240.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.240.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.143, “v1.SecurityContextConstraintsList”

3.2.240.3. Consumes

3.2.240.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.240.5. Tags

apiv1

3.2.241. create SecurityContextConstraints

POST /api/v1/securitycontextconstraints

3.2.241.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.142, “v1.SecurityContextConstraints”

3.2.241.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.142, “v1.SecurityContextConstraints”

3.2.241.3. Consumes

3.2.241.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.241.5. Tags

apiv1

3.2.242. delete SecurityContextConstraints

DELETE /api/v1/securitycontextconstraints/{name}

3.2.242.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.64, “v1.DeleteOptions”
QueryParameter	gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer
QueryParameter	orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean
PathParameter	name	name of the SecurityContextConstraints	true	string

3.2.242.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.10, “unversioned.Status”

3.2.242.3. Consumes

3.2.242.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.242.5. Tags

apiv1

3.2.243. replace the specified SecurityContextConstraints

PUT /api/v1/securitycontextconstraints/{name}

3.2.243.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.142, “v1.SecurityContextConstraints”
PathParameter	name	name of the SecurityContextConstraints	true	string

3.2.243.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.142, “v1.SecurityContextConstraints”

3.2.243.3. Consumes

3.2.243.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.243.5. Tags

apiv1

3.2.244. read the specified SecurityContextConstraints

GET /api/v1/securitycontextconstraints/{name}

3.2.244.1. Parameters

Type	Name	Description	Required	Schema
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 SecurityContextConstraints	true	string

3.2.244.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.142, “v1.SecurityContextConstraints”

3.2.244.3. Consumes

3.2.244.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.244.5. Tags

apiv1

3.2.245. partially update the specified SecurityContextConstraints

PATCH /api/v1/securitycontextconstraints/{name}

3.2.245.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 2.3.9, “unversioned.Patch”
PathParameter	name	name of the SecurityContextConstraints	true	string

3.2.245.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.142, “v1.SecurityContextConstraints”

3.2.245.3. Consumes

application/json-patch+json
application/merge-patch+json
application/strategic-merge-patch+json

3.2.245.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.245.5. Tags

apiv1

3.2.246. list or watch objects of kind ServiceAccount

GET /api/v1/serviceaccounts

3.2.246.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.246.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.146, “v1.ServiceAccountList”

3.2.246.3. Consumes

3.2.246.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.246.5. Tags

apiv1

3.2.247. create a ServiceAccount

POST /api/v1/serviceaccounts

3.2.247.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.145, “v1.ServiceAccount”

3.2.247.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.145, “v1.ServiceAccount”

3.2.247.3. Consumes

3.2.247.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.247.5. Tags

apiv1

3.2.248. list or watch objects of kind Service

GET /api/v1/services

3.2.248.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.248.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.147, “v1.ServiceList”

3.2.248.3. Consumes

3.2.248.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.248.5. Tags

apiv1

3.2.249. create a Service

POST /api/v1/services

3.2.249.1. Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
BodyParameter	body		true	Section 3.3.144, “v1.Service”

3.2.249.2. Responses

HTTP Code	Description	Schema
200	success	Section 3.3.144, “v1.Service”

3.2.249.3. Consumes

3.2.249.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

3.2.249.5. Tags

apiv1

3.2.250. watch individual changes to a list of ConfigMap

GET /api/v1/watch/configmaps

3.2.250.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.250.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.250.3. Consumes

3.2.250.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.250.5. Tags

apiv1

3.2.251. watch individual changes to a list of Endpoints

GET /api/v1/watch/endpoints

3.2.251.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.251.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.251.3. Consumes

3.2.251.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.251.5. Tags

apiv1

3.2.252. watch individual changes to a list of Event

GET /api/v1/watch/events

3.2.252.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.252.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.252.3. Consumes

3.2.252.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.252.5. Tags

apiv1

3.2.253. watch individual changes to a list of LimitRange

GET /api/v1/watch/limitranges

3.2.253.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.253.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.253.3. Consumes

3.2.253.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.253.5. Tags

apiv1

3.2.254. watch individual changes to a list of Namespace

GET /api/v1/watch/namespaces

3.2.254.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.254.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.254.3. Consumes

3.2.254.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.254.5. Tags

apiv1

3.2.255. watch individual changes to a list of ConfigMap

GET /api/v1/watch/namespaces/{namespace}/configmaps

3.2.255.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.255.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.255.3. Consumes

3.2.255.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.255.5. Tags

apiv1

3.2.256. watch changes to an object of kind ConfigMap

GET /api/v1/watch/namespaces/{namespace}/configmaps/{name}

3.2.256.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 ConfigMap	true	string

3.2.256.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.256.3. Consumes

3.2.256.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.256.5. Tags

apiv1

3.2.257. watch individual changes to a list of Endpoints

GET /api/v1/watch/namespaces/{namespace}/endpoints

3.2.257.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.257.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.257.3. Consumes

3.2.257.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.257.5. Tags

apiv1

3.2.258. watch changes to an object of kind Endpoints

GET /api/v1/watch/namespaces/{namespace}/endpoints/{name}

3.2.258.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 Endpoints	true	string

3.2.258.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.258.3. Consumes

3.2.258.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.258.5. Tags

apiv1

3.2.259. watch individual changes to a list of Event

GET /api/v1/watch/namespaces/{namespace}/events

3.2.259.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.259.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.259.3. Consumes

3.2.259.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.259.5. Tags

apiv1

3.2.260. watch changes to an object of kind Event

GET /api/v1/watch/namespaces/{namespace}/events/{name}

3.2.260.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 Event	true	string

3.2.260.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.260.3. Consumes

3.2.260.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.260.5. Tags

apiv1

3.2.261. watch individual changes to a list of LimitRange

GET /api/v1/watch/namespaces/{namespace}/limitranges

3.2.261.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.261.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.261.3. Consumes

3.2.261.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.261.5. Tags

apiv1

3.2.262. watch changes to an object of kind LimitRange

GET /api/v1/watch/namespaces/{namespace}/limitranges/{name}

3.2.262.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 LimitRange	true	string

3.2.262.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.262.3. Consumes

3.2.262.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.262.5. Tags

apiv1

3.2.263. watch individual changes to a list of PersistentVolumeClaim

GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims

3.2.263.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.263.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.263.3. Consumes

3.2.263.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.263.5. Tags

apiv1

3.2.264. watch changes to an object of kind PersistentVolumeClaim

GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}

3.2.264.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 PersistentVolumeClaim	true	string

3.2.264.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.264.3. Consumes

3.2.264.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.264.5. Tags

apiv1

3.2.265. watch individual changes to a list of Pod

GET /api/v1/watch/namespaces/{namespace}/pods

3.2.265.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.265.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.265.3. Consumes

3.2.265.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.265.5. Tags

apiv1

3.2.266. watch changes to an object of kind Pod

GET /api/v1/watch/namespaces/{namespace}/pods/{name}

3.2.266.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 Pod	true	string

3.2.266.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.266.3. Consumes

3.2.266.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.266.5. Tags

apiv1

3.2.267. watch individual changes to a list of PodTemplate

GET /api/v1/watch/namespaces/{namespace}/podtemplates

3.2.267.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.267.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.267.3. Consumes

3.2.267.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.267.5. Tags

apiv1

3.2.268. watch changes to an object of kind PodTemplate

GET /api/v1/watch/namespaces/{namespace}/podtemplates/{name}

3.2.268.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 PodTemplate	true	string

3.2.268.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.268.3. Consumes

3.2.268.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.268.5. Tags

apiv1

3.2.269. watch individual changes to a list of ReplicationController

GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers

3.2.269.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.269.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.269.3. Consumes

3.2.269.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.269.5. Tags

apiv1

3.2.270. watch changes to an object of kind ReplicationController

GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers/{name}

3.2.270.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 ReplicationController	true	string

3.2.270.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.270.3. Consumes

3.2.270.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.270.5. Tags

apiv1

3.2.271. watch individual changes to a list of ResourceQuota

GET /api/v1/watch/namespaces/{namespace}/resourcequotas

3.2.271.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.271.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.271.3. Consumes

3.2.271.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.271.5. Tags

apiv1

3.2.272. watch changes to an object of kind ResourceQuota

GET /api/v1/watch/namespaces/{namespace}/resourcequotas/{name}

3.2.272.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 ResourceQuota	true	string

3.2.272.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.272.3. Consumes

3.2.272.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.272.5. Tags

apiv1

3.2.273. watch individual changes to a list of Secret

GET /api/v1/watch/namespaces/{namespace}/secrets

3.2.273.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.273.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.273.3. Consumes

3.2.273.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.273.5. Tags

apiv1

3.2.274. watch changes to an object of kind Secret

GET /api/v1/watch/namespaces/{namespace}/secrets/{name}

3.2.274.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 Secret	true	string

3.2.274.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.274.3. Consumes

3.2.274.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.274.5. Tags

apiv1

3.2.275. watch individual changes to a list of ServiceAccount

GET /api/v1/watch/namespaces/{namespace}/serviceaccounts

3.2.275.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.275.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.275.3. Consumes

3.2.275.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.275.5. Tags

apiv1

3.2.276. watch changes to an object of kind ServiceAccount

GET /api/v1/watch/namespaces/{namespace}/serviceaccounts/{name}

3.2.276.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 ServiceAccount	true	string

3.2.276.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.276.3. Consumes

3.2.276.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.276.5. Tags

apiv1

3.2.277. watch individual changes to a list of Service

GET /api/v1/watch/namespaces/{namespace}/services

3.2.277.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.277.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.277.3. Consumes

3.2.277.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.277.5. Tags

apiv1

3.2.278. watch changes to an object of kind Service

GET /api/v1/watch/namespaces/{namespace}/services/{name}

3.2.278.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 Service	true	string

3.2.278.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.278.3. Consumes

3.2.278.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.278.5. Tags

apiv1

3.2.279. watch changes to an object of kind Namespace

GET /api/v1/watch/namespaces/{name}

3.2.279.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 Namespace	true	string

3.2.279.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.279.3. Consumes

3.2.279.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.279.5. Tags

apiv1

3.2.280. watch individual changes to a list of Node

GET /api/v1/watch/nodes

3.2.280.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.280.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.280.3. Consumes

3.2.280.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.280.5. Tags

apiv1

3.2.281. watch changes to an object of kind Node

GET /api/v1/watch/nodes/{name}

3.2.281.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 Node	true	string

3.2.281.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.281.3. Consumes

3.2.281.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.281.5. Tags

apiv1

3.2.282. watch individual changes to a list of PersistentVolumeClaim

GET /api/v1/watch/persistentvolumeclaims

3.2.282.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.282.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.282.3. Consumes

3.2.282.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.282.5. Tags

apiv1

3.2.283. watch individual changes to a list of PersistentVolume

GET /api/v1/watch/persistentvolumes

3.2.283.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.283.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.283.3. Consumes

3.2.283.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.283.5. Tags

apiv1

3.2.284. watch changes to an object of kind PersistentVolume

GET /api/v1/watch/persistentvolumes/{name}

3.2.284.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 PersistentVolume	true	string

3.2.284.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.284.3. Consumes

3.2.284.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.284.5. Tags

apiv1

3.2.285. watch individual changes to a list of Pod

GET /api/v1/watch/pods

3.2.285.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.285.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.285.3. Consumes

3.2.285.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.285.5. Tags

apiv1

3.2.286. watch individual changes to a list of PodTemplate

GET /api/v1/watch/podtemplates

3.2.286.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.286.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.286.3. Consumes

3.2.286.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.286.5. Tags

apiv1

3.2.287. watch individual changes to a list of ReplicationController

GET /api/v1/watch/replicationcontrollers

3.2.287.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.287.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.287.3. Consumes

3.2.287.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.287.5. Tags

apiv1

3.2.288. watch individual changes to a list of ResourceQuota

GET /api/v1/watch/resourcequotas

3.2.288.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.288.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.288.3. Consumes

3.2.288.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.288.5. Tags

apiv1

3.2.289. watch individual changes to a list of Secret

GET /api/v1/watch/secrets

3.2.289.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.289.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.289.3. Consumes

3.2.289.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.289.5. Tags

apiv1

3.2.290. watch individual changes to a list of SecurityContextConstraints

GET /api/v1/watch/securitycontextconstraints

3.2.290.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.290.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.290.3. Consumes

3.2.290.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.290.5. Tags

apiv1

3.2.291. watch changes to an object of kind SecurityContextConstraints

GET /api/v1/watch/securitycontextconstraints/{name}

3.2.291.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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 SecurityContextConstraints	true	string

3.2.291.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.291.3. Consumes

3.2.291.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.291.5. Tags

apiv1

3.2.292. watch individual changes to a list of ServiceAccount

GET /api/v1/watch/serviceaccounts

3.2.292.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.292.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.292.3. Consumes

3.2.292.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.292.5. Tags

apiv1

3.2.293. watch individual changes to a list of Service

GET /api/v1/watch/services

3.2.293.1. Parameters

Type	Name	Description	Required	Schema
QueryParameter	pretty	If 'true', then the output is pretty printed.	false	string
QueryParameter	labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.	false	string
QueryParameter	fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.	false	string
QueryParameter	watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	false	boolean
QueryParameter	resourceVersion	When specified with 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

3.2.293.2. Responses

HTTP Code	Description	Schema
200	success	Section 2.3.266, “versioned.Event”

3.2.293.3. Consumes

3.2.293.4. Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

3.2.293.5. Tags

apiv1

3.3. Definitions

3.3.1. types.UID

3.3.2. unversioned.APIResource

APIResource specifies the name of a resource and whether it is namespaced.

Name	Description	Required	Schema
name	name is the name of the resource.	true	string
namespaced	namespaced indicates if a resource is namespaced or not.	true	boolean
kind	kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')	true	string

3.3.3. unversioned.APIResourceList

APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
groupVersion	groupVersion is the group and version this APIResourceList is for.	true	string
resources	resources contains the name of the resources and if they are namespaced.	true	Section 2.3.4, “unversioned.APIResource” array

3.3.4. unversioned.LabelSelector

Name	Description	Required	Schema	Default
matchLabels	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false	object
matchExpressions	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false	Section 2.3.7, “unversioned.LabelSelectorRequirement” array

3.3.5. unversioned.LabelSelectorRequirement

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Description	Required	Schema
key	key is the label key that the selector applies to.	true	string
operator	operator represents a key’s relationship to a set of values. Valid operators ard In, NotIn, Exists and DoesNotExist.	true	string
values	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false	string array

3.3.6. 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}.

Name	Description	Required	Schema	Default
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/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency	false	string

3.3.7. unversioned.Patch

Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.

3.3.8. unversioned.Status

Status is a return value for calls that don’t return other objects.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	Section 2.3.8, “unversioned.ListMeta”
status	Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/HEAD/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.12, “unversioned.StatusDetails”
code	Suggested HTTP return code for this status, 0 if not set.	false	integer (int32)

3.3.9. unversioned.StatusCause

StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.

Name	Description	Required	Schema
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

3.3.10. unversioned.StatusDetails

Name	Description	Required	Schema
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/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
causes	The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.	false	Section 2.3.11, “unversioned.StatusCause” array
retryAfterSeconds	If specified, the time in seconds before the operation should be retried.	false	integer (int32)

3.3.11. v1.AWSElasticBlockStoreVolumeSource

Represents a Persistent Disk resource in AWS.

Name	Description	Required	Schema
volumeID	Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: http://kubernetes.io/docs/user-guide/volumes#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://kubernetes.io/docs/user-guide/volumes#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://kubernetes.io/docs/user-guide/volumes#awselasticblockstore	false	boolean

3.3.12. v1.AttachedVolume

AttachedVolume describes a volume attached to a node

Name	Description	Required	Schema	Default
name	Name of the attached volume	true	string
devicePath	DevicePath represents the device path where the volume should be available	true	string

3.3.13. v1.AzureDataDiskCachingMode

3.3.14. v1.AzureDiskVolumeSource

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

Name	Description	Required	Schema
diskName	The Name of the data disk in the blob storage	true	string
diskURI	The URI the data disk in the blob storage	true	string
cachingMode	Host Caching mode: None, Read Only, Read Write.	false	Section 2.3.16, “v1.AzureDataDiskCachingMode”
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	Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false	boolean

3.3.15. v1.AzureFileVolumeSource

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

Name	Description	Required	Schema
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

3.3.16. v1.Binding

Binding ties one object to another. For example, a pod is bound to a node by a scheduler.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.164, “v1.ObjectMeta”
target	The target object that you want to bind to the standard object.	true	Section 2.3.165, “v1.ObjectReference”

3.3.17. v1.Capabilities

Adds and removes POSIX capabilities from running containers.

Name	Description	Required	Schema	Default
add	Added capabilities	false	Section 2.3.39, “v1.Capability” array
drop	Removed capabilities	false	Section 2.3.39, “v1.Capability” array

3.3.18. v1.Capability

3.3.19. v1.CephFSVolumeSource

Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.

Name	Description	Required	Schema
monitors	Required: Monitors is a collection of Ceph monitors More info: http://releases.k8s.io/HEAD/examples/volumes/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/HEAD/examples/volumes/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/HEAD/examples/volumes/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/HEAD/examples/volumes/cephfs/README.md#how-to-use-it	false	Section 2.3.144, “v1.LocalObjectReference”
readOnly	Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it	false	boolean

3.3.20. v1.CinderVolumeSource

Name	Description	Required	Schema
volumeID	volume id used to identify the volume in cinder More info: http://releases.k8s.io/HEAD/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/HEAD/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/HEAD/examples/mysql-cinder-pd/README.md	false	boolean

3.3.21. v1.ComponentCondition

Information about the condition of a component.

Name	Description	Required	Schema
type	Type of condition for a component. Valid value: "Healthy"	true	string
status	Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown".	true	string
message	Message about the condition for a component. For example, information about a health check.	false	string
error	Condition error code for a component. For example, a health check error code.	false	string

3.3.22. v1.ComponentStatus

ComponentStatus (and ComponentStatusList) holds the cluster validation info.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.164, “v1.ObjectMeta”
conditions	List of component conditions observed	false	Section 3.3.21, “v1.ComponentCondition” array

3.3.23. v1.ComponentStatusList

Status of all the conditions for the component as a list of ComponentStatus objects.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	Section 2.3.8, “unversioned.ListMeta”
items	List of ComponentStatus objects.	true	Section 3.3.22, “v1.ComponentStatus” array

3.3.24. v1.ConfigMap

ConfigMap holds configuration data for pods to consume.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.164, “v1.ObjectMeta”
data	Data contains the configuration data. Each key must be a valid DNS_SUBDOMAIN with an optional leading dot.	false	object

3.3.25. v1.ConfigMapKeySelector

Selects a key from a ConfigMap.

Name	Description	Required	Schema	Default
name	Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names	false	string
key	The key to select.	true	string

3.3.26. v1.ConfigMapList

ConfigMapList is a resource containing a list of ConfigMap objects.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is the list of ConfigMaps.	true	Section 3.3.24, “v1.ConfigMap” array

3.3.27. v1.ConfigMapVolumeSource

Adapts a ConfigMap into a volume.

Name	Description	Required	Schema
name	Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#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.141, “v1.KeyToPath” array
defaultMode	Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.	false	integer (int32)

3.3.28. v1.Container

A single application container that you want to run within a pod.

Name	Description	Required	Schema
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://kubernetes.io/docs/user-guide/images	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://kubernetes.io/docs/user-guide/containers#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://kubernetes.io/docs/user-guide/containers#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.61, “v1.ContainerPort” array
env	List of environment variables to set in the container. Cannot be updated.	false	Section 2.3.91, “v1.EnvVar” array
resources	Compute Resources required by this container. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#resources	false	Section 2.3.204, “v1.ResourceRequirements”
volumeMounts	Pod volumes to mount into the container’s filesystem. Cannot be updated.	false	Section 2.3.260, “v1.VolumeMount” array
livenessProbe	Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes	false	Section 2.3.187, “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://kubernetes.io/docs/user-guide/pod-states#container-probes	false	Section 2.3.187, “v1.Probe”
lifecycle	Actions that the management system should take in response to container lifecycle events. Cannot be updated.	false	Section 2.3.142, “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://kubernetes.io/docs/user-guide/images#updating-images	false	string
securityContext	Security options the pod should run with. More info: http://releases.k8s.io/HEAD/docs/design/security_context.md	false	Section 2.3.229, “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

3.3.29. v1.ContainerImage

Describe a container image

Name	Description	Required	Schema	Default
names	Names by which this image is known. e.g. ["gcr.io/google_containers/hyperkube:v1.0.7", "dockerhub.io/google_containers/hyperkube:v1.0.7"]	true	string array
sizeBytes	The size of the image in bytes.	false	integer (int64)

3.3.30. v1.ContainerPort

ContainerPort represents a network port in a single container.

Name	Description	Required	Schema
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

3.3.31. v1.ContainerState

ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.

Name	Description	Required	Schema
waiting	Details about a waiting container	false	Section 3.3.34, “v1.ContainerStateWaiting”
running	Details about a running container	false	Section 3.3.32, “v1.ContainerStateRunning”
terminated	Details about a terminated container	false	Section 3.3.33, “v1.ContainerStateTerminated”

3.3.32. v1.ContainerStateRunning

ContainerStateRunning is a running state of a container.

Name	Description	Required	Schema	Default
startedAt	Time at which the container was last (re-)started	false	string

3.3.33. v1.ContainerStateTerminated

ContainerStateTerminated is a terminated state of a container.

Name	Description	Required	Schema
exitCode	Exit status from the last termination of the container	true	integer (int32)
signal	Signal from the last termination of the container	false	integer (int32)
reason	(brief) reason from the last termination of the container	false	string
message	Message regarding the last termination of the container	false	string
startedAt	Time at which previous execution of the container started	false	string
finishedAt	Time at which the container last terminated	false	string
containerID	Container’s ID in the format 'docker://<container_id>'	false	string

3.3.34. v1.ContainerStateWaiting

ContainerStateWaiting is a waiting state of a container.

Name	Description	Required	Schema	Default
reason	(brief) reason the container is not yet running.	false	string
message	Message regarding why the container is not yet running.	false	string

3.3.35. v1.ContainerStatus

ContainerStatus contains details for the current status of this container.

Name	Description	Required	Schema
name	This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.	true	string
state	Details about the container’s current condition.	false	Section 3.3.31, “v1.ContainerState”
lastState	Details about the container’s last termination condition.	false	Section 3.3.31, “v1.ContainerState”
ready	Specifies whether the container has passed its readiness probe.	true	boolean
restartCount	The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC.	true	integer (int32)
image	The image the container is running. More info: http://kubernetes.io/docs/user-guide/images	true	string
imageID	ImageID of the container’s image.	true	string
containerID	Container’s ID in the format 'docker://<container_id>'. More info: http://kubernetes.io/docs/user-guide/container-environment#container-information	false	string

3.3.36. v1.DaemonEndpoint

DaemonEndpoint contains information about a single Daemon endpoint.

Name	Description	Required	Schema	Default
Port	Port number of the given endpoint.	true	integer (int32)

3.3.37. v1.DeleteOptions

DeleteOptions may be provided when deleting an API object

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
gracePeriodSeconds	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	false	integer (int64)
preconditions	Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.	false	Section 2.3.186, “v1.Preconditions”
orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.	false	boolean

3.3.38. v1.DeprecatedDownwardAPIVolumeFile

DeprecatedDownwardAPIVolumeFile represents information to create the file containing the pod field This type is deprecated and should be replaced by use of the downwardAPI volume source.

Name	Description	Required	Schema
name	Required: Name 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.	false	Section 2.3.163, “v1.ObjectFieldSelector”
resourceFieldRef	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false	Section 2.3.199, “v1.ResourceFieldSelector”
mode	Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.	false	integer (int32)

3.3.39. v1.DeprecatedDownwardAPIVolumeSource

DeprecatedDownwardAPIVolumeSource represents a volume containing downward API info. This type is deprecated and should be replaced by use of the downwardAPI volume source.

Name	Description	Required	Schema	Default
items	Items is a list of downward API volume file	false	Section 2.3.80, “v1.DeprecatedDownwardAPIVolumeFile” array
defaultMode	Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.	false	integer (int32)

3.3.40. v1.DownwardAPIVolumeFile

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Description	Required	Schema
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.	false	Section 2.3.163, “v1.ObjectFieldSelector”
resourceFieldRef	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false	Section 2.3.199, “v1.ResourceFieldSelector”
mode	Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.	false	integer (int32)

3.3.41. v1.DownwardAPIVolumeSource

DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.

Name	Description	Required	Schema	Default
items	Items is a list of downward API volume file	false	Section 2.3.83, “v1.DownwardAPIVolumeFile” array
defaultMode	Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.	false	integer (int32)

3.3.42. v1.EmptyDirVolumeSource

Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.

Name	Description	Required	Schema	Default
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://kubernetes.io/docs/user-guide/volumes#emptydir	false	string

3.3.43. v1.EndpointAddress

EndpointAddress is a tuple that describes single IP address.

Name	Description	Required	Schema
ip	The IP of this endpoint. May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24). IPv6 is also accepted but not fully supported on all platforms. Also, certain kubernetes components, like kube-proxy, are not IPv6 ready.	true	string
hostname	The Hostname of this endpoint	false	string
nodeName	Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.	false	string
targetRef	Reference to object providing the endpoint.	false	Section 2.3.165, “v1.ObjectReference”

3.3.44. v1.EndpointPort

EndpointPort is a tuple that describes a single port.

Name	Description	Required	Schema
name	The name of this port (corresponds to ServicePort.Name). Must be a DNS_LABEL. Optional only if one port is defined.	false	string
port	The port number of the endpoint.	true	integer (int32)
protocol	The IP protocol for this port. Must be UDP or TCP. Default is TCP.	false	string

3.3.45. v1.EndpointSubset

EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given:
{
Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
}
The resulting set of endpoints can be viewed as:
a: [ 10.10.1.1:8675, 10.10.2.2:8675 ],
b: [ 10.10.1.1:309, 10.10.2.2:309 ]

Name	Description	Required	Schema
addresses	IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize.	false	Section 3.3.43, “v1.EndpointAddress” array
notReadyAddresses	IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check.	false	Section 3.3.43, “v1.EndpointAddress” array
ports	Port numbers available on the related IP addresses.	false	Section 3.3.44, “v1.EndpointPort” array

3.3.46. v1.Endpoints

Endpoints is a collection of endpoints that implement the actual service. Example:
Name: "mysvc",
Subsets: [
{
Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
},
{
Addresses: [{"ip": "10.10.3.3"}],
Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}]
},
]

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.164, “v1.ObjectMeta”
subsets	The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service.	true	Section 3.3.45, “v1.EndpointSubset” array

3.3.47. v1.EndpointsList

EndpointsList is a list of endpoints.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	Section 2.3.8, “unversioned.ListMeta”
items	List of endpoints.	true	Section 3.3.46, “v1.Endpoints” array

3.3.48. v1.EnvVar

EnvVar represents an environment variable present in a Container.

Name	Description	Required	Schema
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.92, “v1.EnvVarSource”

3.3.49. v1.EnvVarSource

EnvVarSource represents a source for the value of an EnvVar.

Name	Description	Required	Schema
fieldRef	Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP.	false	Section 2.3.163, “v1.ObjectFieldSelector”
resourceFieldRef	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false	Section 2.3.199, “v1.ResourceFieldSelector”
configMapKeyRef	Selects a key of a ConfigMap.	false	Section 2.3.58, “v1.ConfigMapKeySelector”
secretKeyRef	Selects a key of a secret in the pod’s namespace	false	Section 2.3.225, “v1.SecretKeySelector”

3.3.50. v1.Event

Event is a report of an event somewhere in the cluster.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	true	Section 2.3.164, “v1.ObjectMeta”
involvedObject	The object that this event is about.	true	Section 2.3.165, “v1.ObjectReference”
reason	This should be a short, machine understandable string that gives the reason for the transition into the object’s current status.	false	string
message	A human-readable description of the status of this operation.	false	string
source	The component reporting this event. Should be a short machine understandable string.	false	Section 3.3.52, “v1.EventSource”
firstTimestamp	The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)	false	string
lastTimestamp	The time at which the most recent occurrence of this event was recorded.	false	string
count	The number of times this event has occurred.	false	integer (int32)
type	Type of this event (Normal, Warning), new types could be added in the future	false	string

3.3.51. v1.EventList

EventList is a list of events.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	Section 2.3.8, “unversioned.ListMeta”
items	List of events	true	Section 3.3.50, “v1.Event” array

3.3.52. v1.EventSource

EventSource contains information for an event.

Name	Description	Required	Schema	Default
component	Component from which the event is generated.	false	string
host	Node name on which the event is generated.	false	string

3.3.53. v1.ExecAction

ExecAction describes a "run in container" action.

Name	Description	Required	Schema	Default
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

3.3.54. 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.

Name	Description	Required	Schema
targetWWNs	Required: FC target worldwide 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

3.3.55. v1.FSGroupStrategyOptions

FSGroupStrategyOptions defines the strategy type and options used to create the strategy.

Name	Description	Required	Schema	Default
type	Type is the strategy that will dictate what FSGroup is used in the SecurityContext.	false	string
ranges	Ranges are the allowed ranges of fs groups. If you would like to force a single fs group then supply a single range with the same start and end.	false	Section 3.3.67, “v1.IDRange” array

3.3.56. v1.FSType

3.3.57. v1.FinalizerName

3.3.58. v1.FlexVolumeSource

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.

Name	Description	Required	Schema
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 secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.	false	Section 2.3.144, “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	object

3.3.59. v1.FlockerVolumeSource

Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.

Name	Description	Required	Schema	Default
datasetName	Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated	false	string
datasetUUID	UUID of the dataset. This is unique identifier of a Flocker dataset	false	string

3.3.60. v1.GCEPersistentDiskVolumeSource

Represents a Persistent Disk resource in Google Compute Engine.

Name	Description	Required	Schema
pdName	Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: http://kubernetes.io/docs/user-guide/volumes#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://kubernetes.io/docs/user-guide/volumes#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://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk	false	integer (int32)
readOnly	ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk	false	boolean

3.3.61. 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.

Name	Description	Required	Schema
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

3.3.62. v1.GlusterfsVolumeSource

Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.

Name	Description	Required	Schema
endpoints	EndpointsName is the endpoint name that details Glusterfs topology. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod	true	string
path	Path is the Glusterfs volume path. More info: http://releases.k8s.io/HEAD/examples/volumes/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/HEAD/examples/volumes/glusterfs/README.md#create-a-pod	false	boolean

3.3.63. v1.HTTPGetAction

HTTPGetAction describes an action based on HTTP Get requests.

Name	Description	Required	Schema
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.110, “v1.HTTPHeader” array

3.3.64. v1.HTTPHeader

HTTPHeader describes a custom header to be used in HTTP probes

Name	Description	Required	Schema	Default
name	The header field name	true	string
value	The header field value	true	string

3.3.65. v1.Handler

Handler defines a specific action that should be taken

Name	Description	Required	Schema
exec	One and only one of the following should be specified. Exec specifies the action to take.	false	Section 2.3.93, “v1.ExecAction”
httpGet	HTTPGet specifies the http request to perform.	false	Section 2.3.109, “v1.HTTPGetAction”
tcpSocket	TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported	false	Section 2.3.245, “v1.TCPSocketAction”

3.3.66. v1.HostPathVolumeSource

Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.

Name	Description	Required	Schema	Default
path	Path of the directory on the host. More info: http://kubernetes.io/docs/user-guide/volumes#hostpath	true	string

3.3.67. v1.IDRange

IDRange provides a min/max of an allowed range of IDs.

Name	Description	Required	Schema	Default
min	Min is the start of the range, inclusive.	false	integer (int64)
max	Max is the end of the range, inclusive.	false	integer (int64)

3.3.68. v1.ISCSIVolumeSource

Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.

Name	Description	Required	Schema
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://kubernetes.io/docs/user-guide/volumes#iscsi	false	string
readOnly	ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.	false	boolean

3.3.69. v1.KeyToPath

Maps a string key to a path within a volume.

Name	Description	Required	Schema
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
mode	Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.	false	integer (int32)

3.3.70. v1.Lifecycle

Name	Description	Required	Schema	Default
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://kubernetes.io/docs/user-guide/container-environment#hook-details	false	Section 2.3.111, “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://kubernetes.io/docs/user-guide/container-environment#hook-details	false	Section 2.3.111, “v1.Handler”

3.3.71. v1.LimitRange

LimitRange sets resource usage limits for each kind of resource in a Namespace.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.164, “v1.ObjectMeta”
spec	Spec defines the limits enforced. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 3.3.74, “v1.LimitRangeSpec”

3.3.72. v1.LimitRangeItem

LimitRangeItem defines a min/max usage limit for any resource that matches on kind.

Name	Description	Required	Schema
type	Type of resource that this limit applies to.	false	string
max	Max usage constraints on this kind by resource name.	false	object
min	Min usage constraints on this kind by resource name.	false	object
default	Default resource requirement limit value by resource name if resource limit is omitted.	false	object
defaultRequest	DefaultRequest is the default resource requirement request value by resource name if resource request is omitted.	false	object
maxLimitRequestRatio	MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource.	false	object

3.3.73. v1.LimitRangeList

LimitRangeList is a list of LimitRange items.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is a list of LimitRange objects. More info: http://releases.k8s.io/HEAD/docs/design/admission_control_limit_range.md	true	Section 3.3.71, “v1.LimitRange” array

3.3.74. v1.LimitRangeSpec

LimitRangeSpec defines a min/max usage limit for resources that match on kind.

Name	Description	Required	Schema	Default
limits	Limits is the list of LimitRangeItem objects that are enforced.	true	Section 3.3.72, “v1.LimitRangeItem” array

3.3.75. v1.LoadBalancerIngress

LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point.

Name	Description	Required	Schema	Default
ip	IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)	false	string
hostname	Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)	false	string

3.3.76. v1.LoadBalancerStatus

LoadBalancerStatus represents the status of a load-balancer.

Name	Description	Required	Schema	Default
ingress	Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points.	false	Section 3.3.75, “v1.LoadBalancerIngress” array

3.3.77. v1.LocalObjectReference

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

Name	Description	Required	Schema	Default
name	Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names	false	string

3.3.78. v1.NFSVolumeSource

Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.

Name	Description	Required	Schema
server	Server is the hostname or IP address of the NFS server. More info: http://kubernetes.io/docs/user-guide/volumes#nfs	true	string
path	Path that is exported by the NFS server. More info: http://kubernetes.io/docs/user-guide/volumes#nfs	true	string
readOnly	ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: http://kubernetes.io/docs/user-guide/volumes#nfs	false	boolean

3.3.79. v1.Namespace

Namespace provides a scope for Names. Use of multiple namespaces is optional.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.164, “v1.ObjectMeta”
spec	Spec defines the behavior of the Namespace. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 3.3.81, “v1.NamespaceSpec”
status	Status describes the current status of a Namespace. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 3.3.82, “v1.NamespaceStatus”

3.3.80. v1.NamespaceList

NamespaceList is a list of Namespaces.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is the list of Namespace objects in the list. More info: http://kubernetes.io/docs/user-guide/namespaces	true	Section 3.3.79, “v1.Namespace” array

3.3.81. v1.NamespaceSpec

NamespaceSpec describes the attributes on a Namespace.

Name	Description	Required	Schema	Default
finalizers	Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: http://releases.k8s.io/HEAD/docs/design/namespaces.md#finalizers	false	Section 2.3.96, “v1.FinalizerName” array

3.3.82. v1.NamespaceStatus

NamespaceStatus is information about the current status of a Namespace.

Name	Description	Required	Schema	Default
phase	Phase is the current lifecycle phase of the namespace. More info: http://releases.k8s.io/HEAD/docs/design/namespaces.md#phases	false	string

3.3.83. v1.Node

Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd).

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.164, “v1.ObjectMeta”
spec	Spec defines the behavior of a node. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 3.3.88, “v1.NodeSpec”
status	Most recently observed status of the node. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 3.3.89, “v1.NodeStatus”

3.3.84. v1.NodeAddress

NodeAddress contains information for the node’s address.

Name	Description	Required	Schema	Default
type	Node address type, one of Hostname, ExternalIP or InternalIP.	true	string
address	The node address.	true	string

3.3.85. v1.NodeCondition

NodeCondition contains condition information for a node.

Name	Description	Required	Schema
type	Type of node condition.	true	string
status	Status of the condition, one of True, False, Unknown.	true	string
lastHeartbeatTime	Last time we got an update on a given condition.	false	string
lastTransitionTime	Last time the condition transit from one status to another.	false	string
reason	(brief) reason for the condition’s last transition.	false	string
message	Human readable message indicating details about last transition.	false	string

3.3.86. v1.NodeDaemonEndpoints

NodeDaemonEndpoints lists ports opened by daemons running on the Node.

Name	Description	Required	Schema	Default
kubeletEndpoint	Endpoint on which Kubelet is listening.	false	Section 3.3.36, “v1.DaemonEndpoint”

3.3.87. v1.NodeList

NodeList is the whole list of all Nodes which have been registered with master.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	Section 2.3.8, “unversioned.ListMeta”
items	List of nodes	true	Section 3.3.83, “v1.Node” array

3.3.88. v1.NodeSpec

NodeSpec describes the attributes that a node is created with.

Name	Description	Required	Schema
podCIDR	PodCIDR represents the pod IP range assigned to the node.	false	string
externalID	External ID of the node assigned by some machine database (e.g. a cloud provider). Deprecated.	false	string
providerID	ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID>	false	string
unschedulable	Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: http://releases.k8s.io/HEAD/docs/admin/node.md#manual-node-administration	false	boolean

3.3.89. v1.NodeStatus

NodeStatus is information about the current status of a node.

Name	Description	Required	Schema
capacity	Capacity represents the total resources of a node. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#capacity for more details.	false	object
allocatable	Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity.	false	object
phase	NodePhase is the recently observed lifecycle phase of the node. More info: http://releases.k8s.io/HEAD/docs/admin/node.md#node-phase The field is never populated, and now is deprecated.	false	string
conditions	Conditions is an array of current observed node conditions. More info: http://releases.k8s.io/HEAD/docs/admin/node.md#node-condition	false	Section 3.3.85, “v1.NodeCondition” array
addresses	List of addresses reachable to the node. Queried from cloud provider, if available. More info: http://releases.k8s.io/HEAD/docs/admin/node.md#node-addresses	false	Section 3.3.84, “v1.NodeAddress” array
daemonEndpoints	Endpoints of daemons running on the Node.	false	Section 3.3.86, “v1.NodeDaemonEndpoints”
nodeInfo	Set of ids/uuids to uniquely identify the node. More info: http://releases.k8s.io/HEAD/docs/admin/node.md#node-info	false	Section 3.3.90, “v1.NodeSystemInfo”
images	List of container images on this node	false	Section 3.3.29, “v1.ContainerImage” array
volumesInUse	List of attachable volumes in use (mounted) by the node.	false	Section 3.3.153, “v1.UniqueVolumeName” array
volumesAttached	List of volumes that are attached to the node.	false	Section 3.3.12, “v1.AttachedVolume” array

3.3.90. v1.NodeSystemInfo

NodeSystemInfo is a set of ids/uuids to uniquely identify the node.

Name	Description	Required	Schema
machineID	MachineID reported by the node. For unique machine identification in the cluster this field is prefered. Learn more from man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html	true	string
systemUUID	SystemUUID reported by the node. For unique machine identification MachineID is prefered. This field is specific to Red Hat hosts https://access.redhat.com/documentation/en-US/Red_Hat_Subscription_Management/1/html/RHSM/getting-system-uuid.html	true	string
bootID	Boot ID reported by the node.	true	string
kernelVersion	Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).	true	string
osImage	OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).	true	string
containerRuntimeVersion	ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0).	true	string
kubeletVersion	Kubelet Version reported by the node.	true	string
kubeProxyVersion	KubeProxy Version reported by the node.	true	string
operatingSystem	The Operating System reported by the node	true	string
architecture	The Architecture reported by the node	true	string

3.3.91. v1.ObjectFieldSelector

ObjectFieldSelector selects an APIVersioned field of an object.

Name	Description	Required	Schema	Default
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

3.3.92. v1.ObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

Name	Description	Required	Schema
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://kubernetes.io/docs/user-guide/identifiers#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/HEAD/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://kubernetes.io/docs/user-guide/namespaces	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://kubernetes.io/docs/user-guide/identifiers#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/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency	false	string
generation	A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.	false	integer (int64)
creationTimestamp	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/HEAD/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 is expected to 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. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. 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/HEAD/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://kubernetes.io/docs/user-guide/labels	false	object
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://kubernetes.io/docs/user-guide/annotations	false	object
ownerReferences	List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.	false	Section 2.3.166, “v1.OwnerReference” array
finalizers	Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.	false	string array
clusterName	The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.	false	string

3.3.93. v1.ObjectReference

ObjectReference contains enough information to let you inspect or modify the referred object.

Name	Description	Required	Schema
kind	Kind of the referent. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
namespace	Namespace of the referent. More info: http://kubernetes.io/docs/user-guide/namespaces	false	string
name	Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names	false	string
uid	UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#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/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency	false	string
fieldPath	If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. 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

3.3.94. v1.OwnerReference

OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

Name	Description	Required	Schema
apiVersion	API version of the referent.	true	string
kind	Kind of the referent. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	true	string
name	Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names	true	string
uid	UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids	true	string
controller	If true, this reference points to the managing controller.	false	boolean

3.3.95. v1.PersistentVolume

PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: http://kubernetes.io/docs/user-guide/persistent-volumes

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.164, “v1.ObjectMeta”
spec	Spec defines a specification of a persistent volume owned by the cluster. Provisioned by an administrator. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistent-volumes	false	Section 3.3.103, “v1.PersistentVolumeSpec”
status	Status represents the current information/status for the persistent volume. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistent-volumes	false	Section 3.3.104, “v1.PersistentVolumeStatus”

3.3.96. v1.PersistentVolumeAccessMode

3.3.97. v1.PersistentVolumeClaim

PersistentVolumeClaim is a user’s request for and claim to a persistent volume

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.164, “v1.ObjectMeta”
spec	Spec defines the desired characteristics of a volume requested by a pod author. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims	false	Section 3.3.99, “v1.PersistentVolumeClaimSpec”
status	Status represents the current information/status of a persistent volume claim. Read-only. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims	false	Section 3.3.100, “v1.PersistentVolumeClaimStatus”

3.3.98. v1.PersistentVolumeClaimList

PersistentVolumeClaimList is a list of PersistentVolumeClaim items.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	Section 2.3.8, “unversioned.ListMeta”
items	A list of persistent volume claims. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims	true	Section 3.3.97, “v1.PersistentVolumeClaim” array

3.3.99. v1.PersistentVolumeClaimSpec

PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes

Name	Description	Required	Schema
accessModes	AccessModes contains the desired access modes the volume should have. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#access-modes-1	false	Section 3.3.96, “v1.PersistentVolumeAccessMode” array
selector	A label query over volumes to consider for binding.	false	Section 2.3.6, “unversioned.LabelSelector”
resources	Resources represents the minimum resources the volume should have. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#resources	false	Section 2.3.204, “v1.ResourceRequirements”
volumeName	VolumeName is the binding reference to the PersistentVolume backing this claim.	false	string

3.3.100. v1.PersistentVolumeClaimStatus

PersistentVolumeClaimStatus is the current status of a persistent volume claim.

Name	Description	Required	Schema
phase	Phase represents the current phase of PersistentVolumeClaim.	false	string
accessModes	AccessModes contains the actual access modes the volume backing the PVC has. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#access-modes-1	false	Section 3.3.96, “v1.PersistentVolumeAccessMode” array
capacity	Represents the actual resources of the underlying volume.	false	object

3.3.101. v1.PersistentVolumeClaimVolumeSource

Name	Description	Required	Schema	Default
claimName	ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims	true	string
readOnly	Will force the ReadOnly setting in VolumeMounts. Default false.	false	boolean

3.3.102. v1.PersistentVolumeList

PersistentVolumeList is a list of PersistentVolume items.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	Section 2.3.8, “unversioned.ListMeta”
items	List of persistent volumes. More info: http://kubernetes.io/docs/user-guide/persistent-volumes	true	Section 3.3.95, “v1.PersistentVolume” array

3.3.103. v1.PersistentVolumeSpec

PersistentVolumeSpec is the specification of a persistent volume.

Name	Description	Required	Schema
capacity	A description of the persistent volume’s resources and capacity. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#capacity	false	object
gcePersistentDisk	GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. Provisioned by an admin. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk	false	Section 2.3.99, “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://kubernetes.io/docs/user-guide/volumes#awselasticblockstore	false	Section 2.3.13, “v1.AWSElasticBlockStoreVolumeSource”
hostPath	HostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: http://kubernetes.io/docs/user-guide/volumes#hostpath	false	Section 2.3.112, “v1.HostPathVolumeSource”
glusterfs	Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md	false	Section 2.3.105, “v1.GlusterfsVolumeSource”
nfs	NFS represents an NFS mount on the host. Provisioned by an admin. More info: http://kubernetes.io/docs/user-guide/volumes#nfs	false	Section 2.3.147, “v1.NFSVolumeSource”
rbd	RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md	false	Section 2.3.194, “v1.RBDVolumeSource”
iscsi	ISCSI represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. Provisioned by an admin.	false	Section 2.3.115, “v1.ISCSIVolumeSource”
cinder	Cinder represents a cinder volume attached and mounted on kubelets host machine More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md	false	Section 2.3.41, “v1.CinderVolumeSource”
cephfs	CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime	false	Section 2.3.40, “v1.CephFSVolumeSource”
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.95, “v1.FCVolumeSource”
flocker	Flocker represents a Flocker volume attached to a kubelet’s host machine and exposed to the pod for its usage. This depends on the Flocker control service being running	false	Section 2.3.98, “v1.FlockerVolumeSource”
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.97, “v1.FlexVolumeSource”
azureFile	AzureFile represents an Azure File Service mount on the host and bind mount to the pod.	false	Section 2.3.18, “v1.AzureFileVolumeSource”
vsphereVolume	VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine	false	Section 2.3.261, “v1.VsphereVirtualDiskVolumeSource”
quobyte	Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime	false	Section 2.3.193, “v1.QuobyteVolumeSource”
azureDisk	AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.	false	Section 2.3.17, “v1.AzureDiskVolumeSource”
photonPersistentDisk	PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine	false	Section 2.3.169, “v1.PhotonPersistentDiskVolumeSource”
accessModes	AccessModes contains all ways the volume can be mounted. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#access-modes	false	Section 3.3.96, “v1.PersistentVolumeAccessMode” array
claimRef	ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#binding	false	Section 2.3.165, “v1.ObjectReference”
persistentVolumeReclaimPolicy	What happens to a persistent volume when released from its claim. Valid options are Retain (default) and Recycle. Recycling must be supported by the volume plugin underlying this persistent volume. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#recycling-policy	false	string

3.3.104. v1.PersistentVolumeStatus

PersistentVolumeStatus is the current status of a persistent volume.

Name	Description	Required	Schema
phase	Phase indicates if a volume is available, bound to a claim, or released by a claim. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#phase	false	string
message	A human-readable message indicating details about why the volume is in this state.	false	string
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

3.3.105. v1.PhotonPersistentDiskVolumeSource

Represents a Photon Controller persistent disk resource.

Name	Description	Required	Schema	Default
pdID	ID that identifies Photon Controller persistent disk	true	string
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

3.3.106. v1.Pod

Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.164, “v1.ObjectMeta”
spec	Specification of the desired behavior of the pod. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 2.3.179, “v1.PodSpec”
status	Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 3.3.111, “v1.PodStatus”

3.3.107. v1.PodCondition

PodCondition contains details for the current condition of this pod.

Name	Description	Required	Schema
type	Type is the type of the condition. Currently only Ready. More info: http://kubernetes.io/docs/user-guide/pod-states#pod-conditions	true	string
status	Status is the status of the condition. Can be True, False, Unknown. More info: http://kubernetes.io/docs/user-guide/pod-states#pod-conditions	true	string
lastProbeTime	Last time we probed the condition.	false	string
lastTransitionTime	Last time the condition transitioned from one status to another.	false	string
reason	Unique, one-word, CamelCase reason for the condition’s last transition.	false	string
message	Human-readable message indicating details about last transition.	false	string

3.3.108. v1.PodList

PodList is a list of Pods.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	Section 2.3.8, “unversioned.ListMeta”
items	List of pods. More info: http://kubernetes.io/docs/user-guide/pods	true	Section 3.3.106, “v1.Pod” array

3.3.109. v1.PodSecurityContext

Name	Description	Required	Schema
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.221, “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	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)

3.3.110. v1.PodSpec

PodSpec is a description of a pod.

Name	Description	Required	Schema
volumes	List of volumes that can be mounted by containers belonging to the pod. More info: http://kubernetes.io/docs/user-guide/volumes	false	Section 2.3.259, “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://kubernetes.io/docs/user-guide/containers	true	Section 2.3.60, “v1.Container” array
restartPolicy	Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://kubernetes.io/docs/user-guide/pod-states#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://kubernetes.io/docs/user-guide/node-selection/README	false	object
serviceAccountName	ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: http://releases.k8s.io/HEAD/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.170, “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://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod	false	Section 2.3.144, “v1.LocalObjectReference” array
hostname	Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value.	false	string
subdomain	If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all.	false	string

3.3.111. v1.PodStatus

PodStatus represents information about the status of a pod. Status may trail the actual state of a system.

Name	Description	Required	Schema
phase	Current condition of the pod. More info: http://kubernetes.io/docs/user-guide/pod-states#pod-phase	false	string
conditions	Current service state of pod. More info: http://kubernetes.io/docs/user-guide/pod-states#pod-conditions	false	Section 3.3.107, “v1.PodCondition” array
message	A human readable message indicating details about why the pod is in this condition.	false	string
reason	A brief CamelCase message indicating details about why the pod is in this state. e.g. 'OutOfDisk'	false	string
hostIP	IP address of the host to which the pod is assigned. Empty if not yet scheduled.	false	string
podIP	IP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated.	false	string
startTime	RFC 3339 date and time at which the object was acknowledged by the Kubelet. This is before the Kubelet pulled the container image(s) for the pod.	false	string
containerStatuses	The list has one entry per container in the manifest. Each entry is currently the output of `docker inspect`. More info: http://kubernetes.io/docs/user-guide/pod-states#container-statuses	false	Section 3.3.35, “v1.ContainerStatus” array

3.3.112. v1.PodTemplate

PodTemplate describes a template for creating copies of a predefined pod.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.164, “v1.ObjectMeta”
template	Template defines the pods that will be created from this pod template. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 2.3.180, “v1.PodTemplateSpec”

3.3.113. v1.PodTemplateList

PodTemplateList is a list of PodTemplates.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	Section 2.3.8, “unversioned.ListMeta”
items	List of pod templates	true	Section 3.3.112, “v1.PodTemplate” array

3.3.114. v1.PodTemplateSpec

PodTemplateSpec describes the data a pod should have when created from a template

Name	Description	Required	Schema	Default
metadata	Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.164, “v1.ObjectMeta”
spec	Specification of the desired behavior of the pod. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 2.3.179, “v1.PodSpec”

3.3.115. v1.Preconditions

Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

Name	Description	Required	Schema	Default
uid	Specifies the target UID.	false	Section 2.3.3, “types.UID”

3.3.116. v1.Probe

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

Name	Description	Required	Schema
exec	One and only one of the following should be specified. Exec specifies the action to take.	false	Section 2.3.93, “v1.ExecAction”
httpGet	HTTPGet specifies the http request to perform.	false	Section 2.3.109, “v1.HTTPGetAction”
tcpSocket	TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported	false	Section 2.3.245, “v1.TCPSocketAction”
initialDelaySeconds	Number of seconds after the container has started before liveness probes are initiated. More info: http://kubernetes.io/docs/user-guide/pod-states#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://kubernetes.io/docs/user-guide/pod-states#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)

3.3.117. v1.QuobyteVolumeSource

Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.

Name	Description	Required	Schema
registry	Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes	true	string
volume	Volume is a string that references an already created Quobyte volume by name.	true	string
readOnly	ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.	false	boolean
user	User to map volume access to Defaults to serivceaccount user	false	string
group	Group to map volume access to Default is no group	false	string

3.3.118. v1.RBDVolumeSource

Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.

Name	Description	Required	Schema
monitors	A collection of Ceph monitors. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it	true	string array
image	The rados image name. More info: http://releases.k8s.io/HEAD/examples/volumes/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://kubernetes.io/docs/user-guide/volumes#rbd	false	string
pool	The rados pool name. Default is rbd. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it.	false	string
user	The rados user name. Default is admin. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it	false	string
keyring	Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it	false	string
secretRef	SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it	false	Section 2.3.144, “v1.LocalObjectReference”
readOnly	ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it	false	boolean

3.3.119. v1.ReplicationController

ReplicationController represents the configuration of a replication controller.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.164, “v1.ObjectMeta”
spec	Spec defines the specification of the desired behavior of the replication controller. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 3.3.122, “v1.ReplicationControllerSpec”
status	Status is the most recently observed status of the replication controller. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 3.3.123, “v1.ReplicationControllerStatus”

3.3.120. v1.ReplicationControllerCondition

ReplicationControllerCondition describes the state of a replication controller at a certain point.

Name	Description	Required	Schema
type	Type of replication controller condition.	true	string
status	Status of the condition, one of True, False, Unknown.	true	string
lastTransitionTime	The last time the condition transitioned from one status to another.	false	string
reason	The reason for the condition’s last transition.	false	string
message	A human readable message indicating details about the transition.	false	string

3.3.121. v1.ReplicationControllerList

ReplicationControllerList is a collection of replication controllers.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	Section 2.3.8, “unversioned.ListMeta”
items	List of replication controllers. More info: http://kubernetes.io/docs/user-guide/replication-controller	true	Section 3.3.119, “v1.ReplicationController” array

3.3.122. v1.ReplicationControllerSpec

ReplicationControllerSpec is the specification of a replication controller.

Name	Description	Required	Schema
replicas	Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: http://kubernetes.io/docs/user-guide/replication-controller#what-is-a-replication-controller	false	integer (int32)
minReadySeconds	Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)	false	integer (int32)
selector	Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors	false	object
template	Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. More info: http://kubernetes.io/docs/user-guide/replication-controller#pod-template	false	Section 2.3.180, “v1.PodTemplateSpec”

3.3.123. v1.ReplicationControllerStatus

ReplicationControllerStatus represents the current status of a replication controller.

Name	Description	Required	Schema
replicas	Replicas is the most recently oberved number of replicas. More info: http://kubernetes.io/docs/user-guide/replication-controller#what-is-a-replication-controller	true	integer (int32)
fullyLabeledReplicas	The number of pods that have labels matching the labels of the pod template of the replication controller.	false	integer (int32)
readyReplicas	The number of ready replicas for this replication controller.	false	integer (int32)
availableReplicas	The number of available replicas (ready for at least minReadySeconds) for this replication controller.	false	integer (int32)
observedGeneration	ObservedGeneration reflects the generation of the most recently observed replication controller.	false	integer (int64)
conditions	Represents the latest available observations of a replication controller’s current state.	false	Section 3.3.120, “v1.ReplicationControllerCondition” array

3.3.124. v1.ResourceFieldSelector

ResourceFieldSelector represents container resources (cpu, memory) and their output format

Name	Description	Required	Schema
containerName	Container name: required for volumes, optional for env vars	false	string
resource	Required: resource to select	true	string
divisor	Specifies the output format of the exposed resources, defaults to "1"	false	string

3.3.125. v1.ResourceQuota

ResourceQuota sets aggregate quota restrictions enforced per namespace

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.164, “v1.ObjectMeta”
spec	Spec defines the desired quota. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 2.3.201, “v1.ResourceQuotaSpec”
status	Status defines the actual enforced quota and its current usage. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 2.3.202, “v1.ResourceQuotaStatus”

3.3.126. v1.ResourceQuotaList

ResourceQuotaList is a list of ResourceQuota items.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is a list of ResourceQuota objects. More info: http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota	true	Section 3.3.125, “v1.ResourceQuota” array

3.3.127. v1.ResourceQuotaScope

3.3.128. v1.ResourceQuotaSpec

ResourceQuotaSpec defines the desired hard limits to enforce for Quota.

Name	Description	Required	Schema	Default
hard	Hard is the set of desired hard limits for each named resource. More info: http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota	false	object
scopes	A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects.	false	Section 2.3.200, “v1.ResourceQuotaScope” array

3.3.129. v1.ResourceQuotaStatus

ResourceQuotaStatus defines the enforced hard limits and observed use.

Name	Description	Required	Schema	Default
hard	Hard is the set of enforced hard limits for each named resource. More info: http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota	false	object
used	Used is the current observed total usage of the resource in the namespace.	false	object

3.3.130. v1.ResourceRequirements

ResourceRequirements describes the compute resource requirements.

Name	Description	Required	Schema	Default
limits	Limits describes the maximum amount of compute resources allowed. More info: http://kubernetes.io/docs/user-guide/compute-resources/	false	object
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://kubernetes.io/docs/user-guide/compute-resources/	false	object

3.3.131. v1.RunAsUserStrategyOptions

RunAsUserStrategyOptions defines the strategy type and any options used to create the strategy.

Name	Description	Required	Schema
type	Type is the strategy that will dictate what RunAsUser is used in the SecurityContext.	false	string
uid	UID is the user id that containers must run as. Required for the MustRunAs strategy if not using namespace/service account allocated uids.	false	integer (int64)
uidRangeMin	UIDRangeMin defines the min value for a strategy that allocates by range.	false	integer (int64)
uidRangeMax	UIDRangeMax defines the max value for a strategy that allocates by range.	false	integer (int64)

3.3.132. v1.SELinuxContextStrategyOptions

SELinuxContextStrategyOptions defines the strategy type and any options used to create the strategy.

Name	Description	Required	Schema	Default
type	Type is the strategy that will dictate what SELinux context is used in the SecurityContext.	false	string
seLinuxOptions	seLinuxOptions required to run as; required for MustRunAs	false	Section 2.3.221, “v1.SELinuxOptions”

3.3.133. v1.SELinuxOptions

SELinuxOptions are the labels to be applied to the container

Name	Description	Required	Schema
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

3.3.134. v1.Scale

Scale represents a scaling request for a resource.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object metadata; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata.	false	Section 2.3.164, “v1.ObjectMeta”
spec	defines the behavior of the scale. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status.	false	Section 3.3.135, “v1.ScaleSpec”
status	current status of the scale. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status. Read-only.	false	Section 3.3.136, “v1.ScaleStatus”

3.3.135. v1.ScaleSpec

ScaleSpec describes the attributes of a scale subresource.

Name	Description	Required	Schema	Default
replicas	desired number of instances for the scaled object.	false	integer (int32)

3.3.136. v1.ScaleStatus

ScaleStatus represents the current status of a scale subresource.

Name	Description	Required	Schema	Default
replicas	actual number of observed instances of the scaled object.	true	integer (int32)
selector	label query over pods that should match the replicas count. This is same as the label selector but in the string format to avoid introspection by clients. The string will be in the same format as the query-param syntax. More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors	false	string

3.3.137. 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.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.164, “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	object
stringData	stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API.	false	object
type	Used to facilitate programmatic handling of secret data.	false	string

3.3.138. v1.SecretKeySelector

SecretKeySelector selects a key of a Secret.

Name	Description	Required	Schema	Default
name	Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names	false	string
key	The key of the secret to select from. Must be a valid secret key.	true	string

3.3.139. v1.SecretList

SecretList is a list of Secret.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	Section 2.3.8, “unversioned.ListMeta”
items	Items is a list of secret objects. More info: http://kubernetes.io/docs/user-guide/secrets	true	Section 2.3.223, “v1.Secret” array

3.3.140. v1.SecretVolumeSource

Adapts a Secret into a volume.

Name	Description	Required	Schema
secretName	Name of the secret in the pod’s namespace to use. More info: http://kubernetes.io/docs/user-guide/volumes#secrets	false	string
items	If unspecified, each key-value pair in the Data field of the referenced Secret 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 Secret, the volume setup will error. Paths must be relative and may not contain the '..' path or start with '..'.	false	Section 2.3.141, “v1.KeyToPath” array
defaultMode	Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.	false	integer (int32)

3.3.141. v1.SecurityContext

Name	Description	Required	Schema
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.38, “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.221, “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

3.3.142. v1.SecurityContextConstraints

SecurityContextConstraints governs the ability to make requests that affect the SecurityContext that will be applied to a container.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.164, “v1.ObjectMeta”
priority	Priority influences the sort order of SCCs when evaluating which SCCs to try first for a given pod request based on access in the Users and Groups fields. The higher the int, the higher priority. If scores for multiple SCCs are equal they will be sorted by name.	true	integer (int32)
allowPrivilegedContainer	AllowPrivilegedContainer determines if a container can request to be run as privileged.	true	boolean
defaultAddCapabilities	DefaultAddCapabilities is the default set of capabilities that will be added to the container unless the pod spec specifically drops the capability. You may not list a capabiility in both DefaultAddCapabilities and RequiredDropCapabilities.	true	Section 2.3.39, “v1.Capability” array
requiredDropCapabilities	RequiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added.	true	Section 2.3.39, “v1.Capability” array
allowedCapabilities	AllowedCapabilities is a list of capabilities that can be requested to add to the container. Capabilities in this field maybe added at the pod author’s discretion. You must not list a capability in both AllowedCapabilities and RequiredDropCapabilities.	true	Section 2.3.39, “v1.Capability” array
allowHostDirVolumePlugin	AllowHostDirVolumePlugin determines if the policy allow containers to use the HostDir volume plugin	true	boolean
volumes	Volumes is a white list of allowed volume plugins. FSType corresponds directly with the field names of a VolumeSource (azureFile, configMap, emptyDir). To allow all volumes you may use '*'.	true	Section 3.3.56, “v1.FSType” array
allowHostNetwork	AllowHostNetwork determines if the policy allows the use of HostNetwork in the pod spec.	true	boolean
allowHostPorts	AllowHostPorts determines if the policy allows host ports in the containers.	true	boolean
allowHostPID	AllowHostPID determines if the policy allows host pid in the containers.	true	boolean
allowHostIPC	AllowHostIPC determines if the policy allows host ipc in the containers.	true	boolean
seLinuxContext	SELinuxContext is the strategy that will dictate what labels will be set in the SecurityContext.	false	Section 3.3.132, “v1.SELinuxContextStrategyOptions”
runAsUser	RunAsUser is the strategy that will dictate what RunAsUser is used in the SecurityContext.	false	Section 3.3.131, “v1.RunAsUserStrategyOptions”
supplementalGroups	SupplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext.	false	Section 3.3.151, “v1.SupplementalGroupsStrategyOptions”
fsGroup	FSGroup is the strategy that will dictate what fs group is used by the SecurityContext.	false	Section 3.3.55, “v1.FSGroupStrategyOptions”
readOnlyRootFilesystem	ReadOnlyRootFilesystem when set to true will force containers to run with a read only root file system. If the container specifically requests to run with a non-read only root file system the SCC should deny the pod. If set to false the container may run with a read only root file system if it wishes but it will not be forced to.	true	boolean
users	The users who have permissions to use this security context constraints	false	string array
groups	The groups that have permission to use this security context constraints	false	string array
seccompProfiles	SeccompProfiles lists the allowed profiles that may be set for the pod or container’s seccomp annotations. An unset (nil) or empty value means that no profiles may be specifid by the pod or container. The wildcard '*' may be used to allow all profiles. When used to generate a value for a pod the first non-wildcard profile will be used as the default.	false	string array

3.3.143. v1.SecurityContextConstraintsList

SecurityContextConstraintsList is a list of SecurityContextConstraints objects

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.8, “unversioned.ListMeta”
items	List of security context constraints.	true	Section 3.3.142, “v1.SecurityContextConstraints” array

3.3.144. v1.Service

Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.164, “v1.ObjectMeta”
spec	Spec defines the behavior of a service. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 3.3.149, “v1.ServiceSpec”
status	Most recently observed status of the service. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status	false	Section 3.3.150, “v1.ServiceStatus”

3.3.145. v1.ServiceAccount

ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata	false	Section 2.3.164, “v1.ObjectMeta”
secrets	Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount. More info: http://kubernetes.io/docs/user-guide/secrets	false	Section 2.3.165, “v1.ObjectReference” array
imagePullSecrets	ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: http://kubernetes.io/docs/user-guide/secrets#manually-specifying-an-imagepullsecret	false	Section 2.3.144, “v1.LocalObjectReference” array

3.3.146. v1.ServiceAccountList

ServiceAccountList is a list of ServiceAccount objects

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	Section 2.3.8, “unversioned.ListMeta”
items	List of ServiceAccounts. More info: http://releases.k8s.io/HEAD/docs/design/service_accounts.md#service-accounts	true	Section 3.3.145, “v1.ServiceAccount” array

3.3.147. v1.ServiceList

ServiceList holds a list of services.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	Section 2.3.8, “unversioned.ListMeta”
items	List of services	true	Section 3.3.144, “v1.Service” array

3.3.148. v1.ServicePort

ServicePort contains information on service’s port.

Name	Description	Required	Schema
name	The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. This maps to the 'Name' field in EndpointPort objects. Optional if only one ServicePort is defined on this service.	false	string
protocol	The IP protocol for this port. Supports "TCP" and "UDP". Default is TCP.	false	string
port	The port that will be exposed by this service.	true	integer (int32)
targetPort	Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod’s container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: http://kubernetes.io/docs/user-guide/services#defining-a-service	false	string
nodePort	The port on each node on which this service is exposed when type=NodePort or LoadBalancer. Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one. More info: http://kubernetes.io/docs/user-guide/services#type—nodeport	false	integer (int32)

3.3.149. v1.ServiceSpec

ServiceSpec describes the attributes that a user creates on a service.

Name	Description	Required	Schema
ports	The list of ports that are exposed by this service. More info: http://kubernetes.io/docs/user-guide/services#virtual-ips-and-service-proxies	true	Section 3.3.148, “v1.ServicePort” array
selector	Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: http://kubernetes.io/docs/user-guide/services#overview	false	object
clusterIP	clusterIP is the IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are "None", empty string (""), or a valid IP address. "None" can be specified for headless services when proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: http://kubernetes.io/docs/user-guide/services#virtual-ips-and-service-proxies	false	string
type	type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ExternalName" maps to the specified externalName. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a stable IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the clusterIP. More info: http://kubernetes.io/docs/user-guide/services#overview	false	string
externalIPs	externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system. A previous form of this functionality exists as the deprecatedPublicIPs field. When using this field, callers should also clear the deprecatedPublicIPs field.	false	string array
deprecatedPublicIPs	deprecatedPublicIPs is deprecated and replaced by the externalIPs field with almost the exact same semantics. This field is retained in the v1 API for compatibility until at least 8/20/2016. It will be removed from any new API revisions. If both deprecatedPublicIPs and externalIPs are set, deprecatedPublicIPs is used.	false	string array
sessionAffinity	Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: http://kubernetes.io/docs/user-guide/services#virtual-ips-and-service-proxies	false	string
loadBalancerIP	Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature.	false	string
loadBalancerSourceRanges	If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: http://kubernetes.io/docs/user-guide/services-firewalls	false	string array
externalName	externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid DNS name and requires Type to be ExternalName.	false	string

3.3.150. v1.ServiceStatus

ServiceStatus represents the current status of a service.

Name	Description	Required	Schema	Default
loadBalancer	LoadBalancer contains the current status of the load-balancer, if one is present.	false	Section 3.3.76, “v1.LoadBalancerStatus”

3.3.151. v1.SupplementalGroupsStrategyOptions

SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy.

Name	Description	Required	Schema	Default
type	Type is the strategy that will dictate what supplemental groups is used in the SecurityContext.	false	string
ranges	Ranges are the allowed ranges of supplemental groups. If you would like to force a single supplemental group then supply a single range with the same start and end.	false	Section 3.3.67, “v1.IDRange” array

3.3.152. v1.TCPSocketAction

TCPSocketAction describes an action based on opening a socket

Name	Description	Required	Schema	Default
port	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true	string

3.3.153. v1.UniqueVolumeName

3.3.154. v1.Volume

Volume represents a named volume in a pod that may be accessed by any container in the pod.

Name	Description	Required	Schema
name	Volume’s name. Must be a DNS_LABEL and unique within the pod. More info: http://kubernetes.io/docs/user-guide/identifiers#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://kubernetes.io/docs/user-guide/volumes#hostpath	false	Section 2.3.112, “v1.HostPathVolumeSource”
emptyDir	EmptyDir represents a temporary directory that shares a pod’s lifetime. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir	false	Section 2.3.90, “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://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk	false	Section 2.3.99, “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://kubernetes.io/docs/user-guide/volumes#awselasticblockstore	false	Section 2.3.13, “v1.AWSElasticBlockStoreVolumeSource”
gitRepo	GitRepo represents a git repository at a particular revision.	false	Section 2.3.103, “v1.GitRepoVolumeSource”
secret	Secret represents a secret that should populate this volume. More info: http://kubernetes.io/docs/user-guide/volumes#secrets	false	Section 2.3.228, “v1.SecretVolumeSource”
nfs	NFS represents an NFS mount on the host that shares a pod’s lifetime More info: http://kubernetes.io/docs/user-guide/volumes#nfs	false	Section 2.3.147, “v1.NFSVolumeSource”
iscsi	ISCSI represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/HEAD/examples/volumes/iscsi/README.md	false	Section 2.3.115, “v1.ISCSIVolumeSource”
glusterfs	Glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md	false	Section 2.3.105, “v1.GlusterfsVolumeSource”
persistentVolumeClaim	PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims	false	Section 2.3.168, “v1.PersistentVolumeClaimVolumeSource”
rbd	RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md	false	Section 2.3.194, “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.97, “v1.FlexVolumeSource”
cinder	Cinder represents a cinder volume attached and mounted on kubelets host machine More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md	false	Section 2.3.41, “v1.CinderVolumeSource”
cephfs	CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime	false	Section 2.3.40, “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.98, “v1.FlockerVolumeSource”
downwardAPI	DownwardAPI represents downward API about the pod that should populate this volume	false	Section 2.3.84, “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.95, “v1.FCVolumeSource”
azureFile	AzureFile represents an Azure File Service mount on the host and bind mount to the pod.	false	Section 2.3.18, “v1.AzureFileVolumeSource”
configMap	ConfigMap represents a configMap that should populate this volume	false	Section 2.3.59, “v1.ConfigMapVolumeSource”
vsphereVolume	VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine	false	Section 2.3.261, “v1.VsphereVirtualDiskVolumeSource”
quobyte	Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime	false	Section 2.3.193, “v1.QuobyteVolumeSource”
azureDisk	AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.	false	Section 2.3.17, “v1.AzureDiskVolumeSource”
photonPersistentDisk	PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine	false	Section 2.3.169, “v1.PhotonPersistentDiskVolumeSource”
metadata	Metadata represents metadata about the pod that should populate this volume Deprecated: Use downwardAPI instead.	false	Section 2.3.81, “v1.DeprecatedDownwardAPIVolumeSource”

3.3.155. v1.VolumeMount

VolumeMount describes a mounting of a Volume within a container.

Name	Description	Required	Schema
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
subPath	Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root).	false	string

3.3.156. v1.VsphereVirtualDiskVolumeSource

Represents a vSphere volume resource.

Name	Description	Required	Schema	Default
volumePath	Path that identifies vSphere volume vmdk	true	string
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

3.3.157. v1beta1.Eviction

Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to …/pods/<pod name>/evictions.

Name	Description	Required	Schema
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
metadata	ObjectMeta describes the pod that is being evicted.	false	Section 2.3.164, “v1.ObjectMeta”
deleteOptions	DeleteOptions may be provided	false	Section 2.3.64, “v1.DeleteOptions”

3.3.158. versioned.Event

Name	Description	Required	Schema	Default
type		true	string
object		true	string

Chapter 4. Revision History: REST API Reference

4.1. Wed Jan 18 2017

OpenShift Container Platform 3.4 initial release.

Legal Notice

OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).

Modified versions must remove all Red Hat trademarks.

Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.

Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.