此内容没有您所选择的语言版本。
REST API Reference
OpenShift Enterprise 3.1 REST API for Developers
Abstract
The OpenShift Enterprise 3.1 distribution of Kubernetes includes the Kubernetes v1 REST API and the OpenShift v1 REST API. These are RESTful APIs accessible via HTTP(s) on the OpenShift Enterprise master servers.
These REST APIs can be used to manage end-user applications, the cluster, and the users of the cluster.
Chapter 1. Overview
The OpenShift Enterprise distribution of Kubernetes includes the Kubernetes v1 REST API and the OpenShift v1 REST API. These are RESTful APIs accessible via HTTP(s) on the OpenShift Enterprise master servers.
These REST APIs can be used to manage end-user applications, the cluster, and the users of the cluster.
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 -t 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
Describe the service account to discover the secret token name:
$ oc describe serviceaccount robot Name: robot Namespace: test Labels: <none> Image pull secrets: robot-dockercfg-rdrpg Mountable secrets: robot-token-2dsne robot-dockercfg-rdrpg Tokens: robot-token-2dsne robot-token-9efwm
Describe the secret token to get the token value:
$ oc describe secret robot-token-2dsne Name: robot-token-2dsne Namespace: test Labels: <none> Annotations: kubernetes.io/service-account.name=robot,kubernetes.io/service-account.uid=ea70e4c7-0663-11e6-b279-fa163e610e01 Type: kubernetes.io/service-account-token Data === token: fyJhbGciOiJSUzI1NiIyInR5cCI2IkpXVCJ9... ca.crt: 1070 bytes namespace: 8 bytes
The token value may be used as an 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 are provided as a reference to provide quick success making 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 Enterprise 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. 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 Enterprise v1 REST API
2.1. Overview
The OpenShift Enterprise API exposes operations for managing an enterprise Kubernetes cluster, including security and user management, application deployments, image and source builds, HTTP(s) routing, and project management.
2.1.1. Version information
Version: v1
2.1.2. URI scheme
Host: 127.0.0.1:8443 BasePath: / Schemes: HTTPS
2.2. Paths
2.2.1. get available resources
GET /oapi/v1
2.2.1.1. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
2.2.1.2. Consumes
- application/json
2.2.1.3. Produces
- application/json
2.2.1.4. Tags
- oapiv1
2.2.2. list or watch objects of kind BuildConfig
GET /oapi/v1/buildconfigs
2.2.2.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.2.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.2.3. Consumes
- /
2.2.2.4. Produces
- application/json
2.2.2.5. Tags
- oapiv1
2.2.3. create a BuildConfig
POST /oapi/v1/buildconfigs
2.2.3.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.3.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.3.3. Consumes
- /
2.2.3.4. Produces
- application/json
2.2.3.5. Tags
- oapiv1
2.2.4. list or watch objects of kind Build
GET /oapi/v1/builds
2.2.4.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.4.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.4.3. Consumes
- /
2.2.4.4. Produces
- application/json
2.2.4.5. Tags
- oapiv1
2.2.5. create a Build
POST /oapi/v1/builds
2.2.5.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.5.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.5.3. Consumes
- /
2.2.5.4. Produces
- application/json
2.2.5.5. Tags
- oapiv1
2.2.6. list or watch objects of kind ClusterNetwork
GET /oapi/v1/clusternetworks
2.2.6.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.6.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.6.3. Consumes
- /
2.2.6.4. Produces
- application/json
2.2.6.5. Tags
- oapiv1
2.2.7. create a ClusterNetwork
POST /oapi/v1/clusternetworks
2.2.7.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.7.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.7.3. Consumes
- /
2.2.7.4. Produces
- application/json
2.2.7.5. Tags
- oapiv1
2.2.8. read the specified ClusterNetwork
GET /oapi/v1/clusternetworks/{name}
2.2.8.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 ClusterNetwork | true | string |
2.2.8.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.8.3. Consumes
- /
2.2.8.4. Produces
- application/json
2.2.8.5. Tags
- oapiv1
2.2.9. replace the specified ClusterNetwork
PUT /oapi/v1/clusternetworks/{name}
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 | |||
PathParameter | name | name of the ClusterNetwork | true | string |
2.2.9.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.9.3. Consumes
- /
2.2.9.4. Produces
- application/json
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 | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the ClusterNetwork | true | string |
2.2.10.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.10.3. Consumes
- /
2.2.10.4. Produces
- application/json
2.2.10.5. Tags
- oapiv1
2.2.11. partially update the specified ClusterNetwork
PATCH /oapi/v1/clusternetworks/{name}
2.2.11.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the ClusterNetwork | true | string |
2.2.11.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.11.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.11.4. Produces
- application/json
2.2.11.5. Tags
- oapiv1
2.2.12. list or watch objects of kind ClusterPolicy
GET /oapi/v1/clusterpolicies
2.2.12.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.12.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.12.3. Consumes
- /
2.2.12.4. Produces
- application/json
2.2.12.5. Tags
- oapiv1
2.2.13. create a ClusterPolicy
POST /oapi/v1/clusterpolicies
2.2.13.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.13.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.13.3. Consumes
- /
2.2.13.4. Produces
- application/json
2.2.13.5. Tags
- oapiv1
2.2.14. read the specified ClusterPolicy
GET /oapi/v1/clusterpolicies/{name}
2.2.14.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 ClusterPolicy | true | string |
2.2.14.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.14.3. Consumes
- /
2.2.14.4. Produces
- application/json
2.2.14.5. Tags
- oapiv1
2.2.15. replace the specified ClusterPolicy
PUT /oapi/v1/clusterpolicies/{name}
2.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 | |||
PathParameter | name | name of the ClusterPolicy | true | string |
2.2.15.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.15.3. Consumes
- /
2.2.15.4. Produces
- application/json
2.2.15.5. Tags
- oapiv1
2.2.16. delete a ClusterPolicy
DELETE /oapi/v1/clusterpolicies/{name}
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 | |||
PathParameter | name | name of the ClusterPolicy | true | string |
2.2.16.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.16.3. Consumes
- /
2.2.16.4. Produces
- application/json
2.2.16.5. Tags
- oapiv1
2.2.17. partially update the specified ClusterPolicy
PATCH /oapi/v1/clusterpolicies/{name}
2.2.17.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the ClusterPolicy | true | string |
2.2.17.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.17.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.17.4. Produces
- application/json
2.2.17.5. Tags
- oapiv1
2.2.18. list or watch objects of kind ClusterPolicyBinding
GET /oapi/v1/clusterpolicybindings
2.2.18.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.18.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.18.3. Consumes
- /
2.2.18.4. Produces
- application/json
2.2.18.5. Tags
- oapiv1
2.2.19. create a ClusterPolicyBinding
POST /oapi/v1/clusterpolicybindings
2.2.19.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.19.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.19.3. Consumes
- /
2.2.19.4. Produces
- application/json
2.2.19.5. Tags
- oapiv1
2.2.20. read the specified ClusterPolicyBinding
GET /oapi/v1/clusterpolicybindings/{name}
2.2.20.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 ClusterPolicyBinding | true | string |
2.2.20.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.20.3. Consumes
- /
2.2.20.4. Produces
- application/json
2.2.20.5. Tags
- oapiv1
2.2.21. replace the specified ClusterPolicyBinding
PUT /oapi/v1/clusterpolicybindings/{name}
2.2.21.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the ClusterPolicyBinding | true | string |
2.2.21.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.21.3. Consumes
- /
2.2.21.4. Produces
- application/json
2.2.21.5. Tags
- oapiv1
2.2.22. delete a ClusterPolicyBinding
DELETE /oapi/v1/clusterpolicybindings/{name}
2.2.22.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the ClusterPolicyBinding | true | string |
2.2.22.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.22.3. Consumes
- /
2.2.22.4. Produces
- application/json
2.2.22.5. Tags
- oapiv1
2.2.23. partially update the specified ClusterPolicyBinding
PATCH /oapi/v1/clusterpolicybindings/{name}
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 | |||
PathParameter | name | name of the ClusterPolicyBinding | true | string |
2.2.23.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.23.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.23.4. Produces
- application/json
2.2.23.5. Tags
- oapiv1
2.2.24. list objects of kind ClusterRoleBinding
GET /oapi/v1/clusterrolebindings
2.2.24.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.24.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.24.3. Consumes
- /
2.2.24.4. Produces
- application/json
2.2.24.5. Tags
- oapiv1
2.2.25. create a ClusterRoleBinding
POST /oapi/v1/clusterrolebindings
2.2.25.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.25.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.25.3. Consumes
- /
2.2.25.4. Produces
- application/json
2.2.25.5. Tags
- oapiv1
2.2.26. read the specified ClusterRoleBinding
GET /oapi/v1/clusterrolebindings/{name}
2.2.26.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.26.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.26.3. Consumes
- /
2.2.26.4. Produces
- application/json
2.2.26.5. Tags
- oapiv1
2.2.27. replace the specified ClusterRoleBinding
PUT /oapi/v1/clusterrolebindings/{name}
2.2.27.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the ClusterRoleBinding | true | string |
2.2.27.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.27.3. Consumes
- /
2.2.27.4. Produces
- application/json
2.2.27.5. Tags
- oapiv1
2.2.28. delete a ClusterRoleBinding
DELETE /oapi/v1/clusterrolebindings/{name}
2.2.28.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the ClusterRoleBinding | true | string |
2.2.28.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.28.3. Consumes
- /
2.2.28.4. Produces
- application/json
2.2.28.5. Tags
- oapiv1
2.2.29. partially update the specified ClusterRoleBinding
PATCH /oapi/v1/clusterrolebindings/{name}
2.2.29.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the ClusterRoleBinding | true | string |
2.2.29.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.29.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.29.4. Produces
- application/json
2.2.29.5. Tags
- oapiv1
2.2.30. list objects of kind ClusterRole
GET /oapi/v1/clusterroles
2.2.30.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.30.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.30.3. Consumes
- /
2.2.30.4. Produces
- application/json
2.2.30.5. Tags
- oapiv1
2.2.31. create a ClusterRole
POST /oapi/v1/clusterroles
2.2.31.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.31.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.31.3. Consumes
- /
2.2.31.4. Produces
- application/json
2.2.31.5. Tags
- oapiv1
2.2.32. read the specified ClusterRole
GET /oapi/v1/clusterroles/{name}
2.2.32.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.32.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.32.3. Consumes
- /
2.2.32.4. Produces
- application/json
2.2.32.5. Tags
- oapiv1
2.2.33. replace the specified ClusterRole
PUT /oapi/v1/clusterroles/{name}
2.2.33.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the ClusterRole | true | string |
2.2.33.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.33.3. Consumes
- /
2.2.33.4. Produces
- application/json
2.2.33.5. Tags
- oapiv1
2.2.34. delete a ClusterRole
DELETE /oapi/v1/clusterroles/{name}
2.2.34.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the ClusterRole | true | string |
2.2.34.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.34.3. Consumes
- /
2.2.34.4. Produces
- application/json
2.2.34.5. Tags
- oapiv1
2.2.35. partially update the specified ClusterRole
PATCH /oapi/v1/clusterroles/{name}
2.2.35.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the ClusterRole | true | string |
2.2.35.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.35.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.35.4. Produces
- application/json
2.2.35.5. Tags
- oapiv1
2.2.36. create a DeploymentConfigRollback
POST /oapi/v1/deploymentconfigrollbacks
2.2.36.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.36.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.36.3. Consumes
- /
2.2.36.4. Produces
- application/json
2.2.36.5. Tags
- oapiv1
2.2.37. list or watch objects of kind DeploymentConfig
GET /oapi/v1/deploymentconfigs
2.2.37.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.37.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.37.3. Consumes
- /
2.2.37.4. Produces
- application/json
2.2.37.5. Tags
- oapiv1
2.2.38. create a DeploymentConfig
POST /oapi/v1/deploymentconfigs
2.2.38.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.38.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.38.3. Consumes
- /
2.2.38.4. Produces
- application/json
2.2.38.5. Tags
- oapiv1
2.2.39. list or watch objects of kind Group
GET /oapi/v1/groups
2.2.39.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.39.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.39.3. Consumes
- /
2.2.39.4. Produces
- application/json
2.2.39.5. Tags
- oapiv1
2.2.40. create a Group
POST /oapi/v1/groups
2.2.40.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.40.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.40.3. Consumes
- /
2.2.40.4. Produces
- application/json
2.2.40.5. Tags
- oapiv1
2.2.41. read the specified Group
GET /oapi/v1/groups/{name}
2.2.41.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 Group | true | string |
2.2.41.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.41.3. Consumes
- /
2.2.41.4. Produces
- application/json
2.2.41.5. Tags
- oapiv1
2.2.42. replace the specified Group
PUT /oapi/v1/groups/{name}
2.2.42.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the Group | true | string |
2.2.42.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.42.3. Consumes
- /
2.2.42.4. Produces
- application/json
2.2.42.5. Tags
- oapiv1
2.2.43. delete a Group
DELETE /oapi/v1/groups/{name}
2.2.43.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the Group | true | string |
2.2.43.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.43.3. Consumes
- /
2.2.43.4. Produces
- application/json
2.2.43.5. Tags
- oapiv1
2.2.44. partially update the specified Group
PATCH /oapi/v1/groups/{name}
2.2.44.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the Group | true | string |
2.2.44.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.44.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.44.4. Produces
- application/json
2.2.44.5. Tags
- oapiv1
2.2.45. list or watch objects of kind HostSubnet
GET /oapi/v1/hostsubnets
2.2.45.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.45.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.45.3. Consumes
- /
2.2.45.4. Produces
- application/json
2.2.45.5. Tags
- oapiv1
2.2.46. create a HostSubnet
POST /oapi/v1/hostsubnets
2.2.46.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.46.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.46.3. Consumes
- /
2.2.46.4. Produces
- application/json
2.2.46.5. Tags
- oapiv1
2.2.47. read the specified HostSubnet
GET /oapi/v1/hostsubnets/{name}
2.2.47.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 HostSubnet | true | string |
2.2.47.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.47.3. Consumes
- /
2.2.47.4. Produces
- application/json
2.2.47.5. Tags
- oapiv1
2.2.48. replace the specified HostSubnet
PUT /oapi/v1/hostsubnets/{name}
2.2.48.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the HostSubnet | true | string |
2.2.48.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.48.3. Consumes
- /
2.2.48.4. Produces
- application/json
2.2.48.5. Tags
- oapiv1
2.2.49. delete a HostSubnet
DELETE /oapi/v1/hostsubnets/{name}
2.2.49.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the HostSubnet | true | string |
2.2.49.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.49.3. Consumes
- /
2.2.49.4. Produces
- application/json
2.2.49.5. Tags
- oapiv1
2.2.50. partially update the specified HostSubnet
PATCH /oapi/v1/hostsubnets/{name}
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 | |||
PathParameter | name | name of the HostSubnet | true | string |
2.2.50.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.50.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.50.4. Produces
- application/json
2.2.50.5. Tags
- oapiv1
2.2.51. list or watch objects of kind Identity
GET /oapi/v1/identities
2.2.51.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.51.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.51.3. Consumes
- /
2.2.51.4. Produces
- application/json
2.2.51.5. Tags
- oapiv1
2.2.52. create a Identity
POST /oapi/v1/identities
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 |
2.2.52.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.52.3. Consumes
- /
2.2.52.4. Produces
- application/json
2.2.52.5. Tags
- oapiv1
2.2.53. read the specified Identity
GET /oapi/v1/identities/{name}
2.2.53.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 Identity | true | string |
2.2.53.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.53.3. Consumes
- /
2.2.53.4. Produces
- application/json
2.2.53.5. Tags
- oapiv1
2.2.54. replace the specified Identity
PUT /oapi/v1/identities/{name}
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 | |||
PathParameter | name | name of the Identity | true | string |
2.2.54.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.54.3. Consumes
- /
2.2.54.4. Produces
- application/json
2.2.54.5. Tags
- oapiv1
2.2.55. delete a Identity
DELETE /oapi/v1/identities/{name}
2.2.55.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the Identity | true | string |
2.2.55.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.55.3. Consumes
- /
2.2.55.4. Produces
- application/json
2.2.55.5. Tags
- oapiv1
2.2.56. partially update the specified Identity
PATCH /oapi/v1/identities/{name}
2.2.56.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the Identity | true | string |
2.2.56.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.56.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.56.4. Produces
- application/json
2.2.56.5. Tags
- oapiv1
2.2.57. list or watch objects of kind Image
GET /oapi/v1/images
2.2.57.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.57.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.57.3. Consumes
- /
2.2.57.4. Produces
- application/json
2.2.57.5. Tags
- oapiv1
2.2.58. create a Image
POST /oapi/v1/images
2.2.58.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.58.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.58.3. Consumes
- /
2.2.58.4. Produces
- application/json
2.2.58.5. Tags
- oapiv1
2.2.59. read the specified Image
GET /oapi/v1/images/{name}
2.2.59.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 Image | true | string |
2.2.59.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.59.3. Consumes
- /
2.2.59.4. Produces
- application/json
2.2.59.5. Tags
- oapiv1
2.2.60. replace the specified Image
PUT /oapi/v1/images/{name}
2.2.60.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the Image | true | string |
2.2.60.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.60.3. Consumes
- /
2.2.60.4. Produces
- application/json
2.2.60.5. Tags
- oapiv1
2.2.61. delete a Image
DELETE /oapi/v1/images/{name}
2.2.61.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the Image | true | string |
2.2.61.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.61.3. Consumes
- /
2.2.61.4. Produces
- application/json
2.2.61.5. Tags
- oapiv1
2.2.62. partially update the specified Image
PATCH /oapi/v1/images/{name}
2.2.62.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the Image | true | string |
2.2.62.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.62.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.62.4. Produces
- application/json
2.2.62.5. Tags
- oapiv1
2.2.63. create a ImageStreamMapping
POST /oapi/v1/imagestreammappings
2.2.63.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.63.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.63.3. Consumes
- /
2.2.63.4. Produces
- application/json
2.2.63.5. Tags
- oapiv1
2.2.64. list or watch objects of kind ImageStream
GET /oapi/v1/imagestreams
2.2.64.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.64.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.64.3. Consumes
- /
2.2.64.4. Produces
- application/json
2.2.64.5. Tags
- oapiv1
2.2.65. create a ImageStream
POST /oapi/v1/imagestreams
2.2.65.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.65.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.65.3. Consumes
- /
2.2.65.4. Produces
- application/json
2.2.65.5. Tags
- oapiv1
2.2.66. list objects of kind ImageStreamTag
GET /oapi/v1/imagestreamtags
2.2.66.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.66.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.66.3. Consumes
- /
2.2.66.4. Produces
- application/json
2.2.66.5. Tags
- oapiv1
2.2.67. create a LocalResourceAccessReview
POST /oapi/v1/localresourceaccessreviews
2.2.67.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.67.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.67.3. Consumes
- /
2.2.67.4. Produces
- application/json
2.2.67.5. Tags
- oapiv1
2.2.68. create a LocalSubjectAccessReview
POST /oapi/v1/localsubjectaccessreviews
2.2.68.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.68.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.68.3. Consumes
- /
2.2.68.4. Produces
- application/json
2.2.68.5. Tags
- oapiv1
2.2.69. list or watch objects of kind BuildConfig
GET /oapi/v1/namespaces/{namespace}/buildconfigs
2.2.69.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.69.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.69.3. Consumes
- /
2.2.69.4. Produces
- application/json
2.2.69.5. Tags
- oapiv1
2.2.70. create a BuildConfig
POST /oapi/v1/namespaces/{namespace}/buildconfigs
2.2.70.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.70.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.70.3. Consumes
- /
2.2.70.4. Produces
- application/json
2.2.70.5. Tags
- oapiv1
2.2.71. read the specified BuildConfig
GET /oapi/v1/namespaces/{namespace}/buildconfigs/{name}
2.2.71.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the BuildConfig | true | string |
2.2.71.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.71.3. Consumes
- /
2.2.71.4. Produces
- application/json
2.2.71.5. Tags
- oapiv1
2.2.72. replace the specified BuildConfig
PUT /oapi/v1/namespaces/{namespace}/buildconfigs/{name}
2.2.72.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.72.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.72.3. Consumes
- /
2.2.72.4. Produces
- application/json
2.2.72.5. Tags
- oapiv1
2.2.73. delete a BuildConfig
DELETE /oapi/v1/namespaces/{namespace}/buildconfigs/{name}
2.2.73.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.73.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.73.3. Consumes
- /
2.2.73.4. Produces
- application/json
2.2.73.5. Tags
- oapiv1
2.2.74. partially update the specified BuildConfig
PATCH /oapi/v1/namespaces/{namespace}/buildconfigs/{name}
2.2.74.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.74.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.74.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.74.4. Produces
- application/json
2.2.74.5. Tags
- oapiv1
2.2.75. create instantiate of a BuildRequest
POST /oapi/v1/namespaces/{namespace}/buildconfigs/{name}/instantiate
2.2.75.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.75.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.75.3. Consumes
- /
2.2.75.4. Produces
- application/json
2.2.75.5. Tags
- oapiv1
2.2.76. connect POST requests to instantiatebinary of BinaryBuildRequestOptions
POST /oapi/v1/namespaces/{namespace}/buildconfigs/{name}/instantiatebinary
2.2.76.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | asFile | false | string | ||
QueryParameter | revision.commit | false | string | ||
QueryParameter | revision.message | false | string | ||
QueryParameter | revision.authorName | false | string | ||
QueryParameter | revision.authorEmail | false | string | ||
QueryParameter | revision.committerName | false | string | ||
QueryParameter | revision.committerEmail | 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.76.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
2.2.76.3. Consumes
- /
2.2.76.4. Produces
- /
2.2.76.5. Tags
- oapiv1
2.2.77. connect POST requests to webhooks of Status
POST /oapi/v1/namespaces/{namespace}/buildconfigs/{name}/webhooks
2.2.77.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | path | Path is the URL path to use for the current proxy request to pod. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Status | true | string |
2.2.77.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
2.2.77.3. Consumes
- /
2.2.77.4. Produces
- /
2.2.77.5. Tags
- oapiv1
2.2.78. connect POST requests to webhooks of Status
POST /oapi/v1/namespaces/{namespace}/buildconfigs/{name}/webhooks/{path:*}
2.2.78.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | path | Path is the URL path to use for the current proxy request to pod. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Status | true | string | |
PathParameter | path | path to the resource | true | string |
2.2.78.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
2.2.78.3. Consumes
- /
2.2.78.4. Produces
- /
2.2.78.5. Tags
- oapiv1
2.2.79. list or watch objects of kind Build
GET /oapi/v1/namespaces/{namespace}/builds
2.2.79.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.79.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.79.3. Consumes
- /
2.2.79.4. Produces
- application/json
2.2.79.5. Tags
- oapiv1
2.2.80. create a Build
POST /oapi/v1/namespaces/{namespace}/builds
2.2.80.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.80.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.80.3. Consumes
- /
2.2.80.4. Produces
- application/json
2.2.80.5. Tags
- oapiv1
2.2.81. read the specified Build
GET /oapi/v1/namespaces/{namespace}/builds/{name}
2.2.81.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Build | true | string |
2.2.81.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.81.3. Consumes
- /
2.2.81.4. Produces
- application/json
2.2.81.5. Tags
- oapiv1
2.2.82. replace the specified Build
PUT /oapi/v1/namespaces/{namespace}/builds/{name}
2.2.82.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.82.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.82.3. Consumes
- /
2.2.82.4. Produces
- application/json
2.2.82.5. Tags
- oapiv1
2.2.83. delete a Build
DELETE /oapi/v1/namespaces/{namespace}/builds/{name}
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 | |||
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.83.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.83.3. Consumes
- /
2.2.83.4. Produces
- application/json
2.2.83.5. Tags
- oapiv1
2.2.84. partially update the specified Build
PATCH /oapi/v1/namespaces/{namespace}/builds/{name}
2.2.84.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.84.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.84.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.84.4. Produces
- application/json
2.2.84.5. Tags
- oapiv1
2.2.85. create clone of a BuildRequest
POST /oapi/v1/namespaces/{namespace}/builds/{name}/clone
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 | |||
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.85.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.85.3. Consumes
- /
2.2.85.4. Produces
- application/json
2.2.85.5. Tags
- oapiv1
2.2.86. read log of the specified BuildLog
GET /oapi/v1/namespaces/{namespace}/builds/{name}/log
2.2.86.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | container | false | string | ||
QueryParameter | follow | false | boolean | ||
QueryParameter | previous | false | boolean | ||
QueryParameter | sinceSeconds | false | ref | ||
QueryParameter | sinceTime | false | string | ||
QueryParameter | timestamps | false | boolean | ||
QueryParameter | tailLines | false | ref | ||
QueryParameter | limitBytes | false | ref | ||
QueryParameter | nowait | false | boolean | ||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the BuildLog | true | string |
2.2.86.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.86.3. Consumes
- /
2.2.86.4. Produces
- application/json
2.2.86.5. Tags
- oapiv1
2.2.87. create a DeploymentConfigRollback
POST /oapi/v1/namespaces/{namespace}/deploymentconfigrollbacks
2.2.87.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.87.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.87.3. Consumes
- /
2.2.87.4. Produces
- application/json
2.2.87.5. Tags
- oapiv1
2.2.88. list or watch objects of kind DeploymentConfig
GET /oapi/v1/namespaces/{namespace}/deploymentconfigs
2.2.88.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.88.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.88.3. Consumes
- /
2.2.88.4. Produces
- application/json
2.2.88.5. Tags
- oapiv1
2.2.89. create a DeploymentConfig
POST /oapi/v1/namespaces/{namespace}/deploymentconfigs
2.2.89.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.89.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.89.3. Consumes
- /
2.2.89.4. Produces
- application/json
2.2.89.5. Tags
- oapiv1
2.2.90. read the specified DeploymentConfig
GET /oapi/v1/namespaces/{namespace}/deploymentconfigs/{name}
2.2.90.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the DeploymentConfig | true | string |
2.2.90.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.90.3. Consumes
- /
2.2.90.4. Produces
- application/json
2.2.90.5. Tags
- oapiv1
2.2.91. replace the specified DeploymentConfig
PUT /oapi/v1/namespaces/{namespace}/deploymentconfigs/{name}
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 | |||
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.91.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.91.3. Consumes
- /
2.2.91.4. Produces
- application/json
2.2.91.5. Tags
- oapiv1
2.2.92. delete a DeploymentConfig
DELETE /oapi/v1/namespaces/{namespace}/deploymentconfigs/{name}
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 | |||
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.92.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.92.3. Consumes
- /
2.2.92.4. Produces
- application/json
2.2.92.5. Tags
- oapiv1
2.2.93. partially update the specified DeploymentConfig
PATCH /oapi/v1/namespaces/{namespace}/deploymentconfigs/{name}
2.2.93.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.93.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.93.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.93.4. Produces
- application/json
2.2.93.5. Tags
- oapiv1
2.2.94. read log of the specified DeploymentLog
GET /oapi/v1/namespaces/{namespace}/deploymentconfigs/{name}/log
2.2.94.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | container | false | string | ||
QueryParameter | follow | false | boolean | ||
QueryParameter | previous | false | boolean | ||
QueryParameter | sinceSeconds | false | ref | ||
QueryParameter | sinceTime | false | string | ||
QueryParameter | timestamps | false | boolean | ||
QueryParameter | tailLines | false | ref | ||
QueryParameter | limitBytes | false | ref | ||
QueryParameter | nowait | false | boolean | ||
QueryParameter | version | false | ref | ||
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.94.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.94.3. Consumes
- /
2.2.94.4. Produces
- application/json
2.2.94.5. Tags
- oapiv1
2.2.95. read the specified DeploymentConfig
GET /oapi/v1/namespaces/{namespace}/generatedeploymentconfigs/{name}
2.2.95.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the DeploymentConfig | true | string |
2.2.95.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.95.3. Consumes
- /
2.2.95.4. Produces
- application/json
2.2.95.5. Tags
- oapiv1
2.2.96. read the specified ImageStreamImage
GET /oapi/v1/namespaces/{namespace}/imagestreamimages/{name}
2.2.96.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the ImageStreamImage | true | string |
2.2.96.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.96.3. Consumes
- /
2.2.96.4. Produces
- application/json
2.2.96.5. Tags
- oapiv1
2.2.97. create a ImageStreamMapping
POST /oapi/v1/namespaces/{namespace}/imagestreammappings
2.2.97.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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 |
2.2.97.3. Consumes
- /
2.2.97.4. Produces
- application/json
2.2.97.5. Tags
- oapiv1
2.2.98. list or watch objects of kind ImageStream
GET /oapi/v1/namespaces/{namespace}/imagestreams
2.2.98.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.98.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.98.3. Consumes
- /
2.2.98.4. Produces
- application/json
2.2.98.5. Tags
- oapiv1
2.2.99. create a ImageStream
POST /oapi/v1/namespaces/{namespace}/imagestreams
2.2.99.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.99.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.99.3. Consumes
- /
2.2.99.4. Produces
- application/json
2.2.99.5. Tags
- oapiv1
2.2.100. read the specified ImageStream
GET /oapi/v1/namespaces/{namespace}/imagestreams/{name}
2.2.100.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the ImageStream | true | string |
2.2.100.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.100.3. Consumes
- /
2.2.100.4. Produces
- application/json
2.2.100.5. Tags
- oapiv1
2.2.101. replace the specified ImageStream
PUT /oapi/v1/namespaces/{namespace}/imagestreams/{name}
2.2.101.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.101.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.101.3. Consumes
- /
2.2.101.4. Produces
- application/json
2.2.101.5. Tags
- oapiv1
2.2.102. delete a ImageStream
DELETE /oapi/v1/namespaces/{namespace}/imagestreams/{name}
2.2.102.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.102.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.102.3. Consumes
- /
2.2.102.4. Produces
- application/json
2.2.102.5. Tags
- oapiv1
2.2.103. partially update the specified ImageStream
PATCH /oapi/v1/namespaces/{namespace}/imagestreams/{name}
2.2.103.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.103.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.103.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.103.4. Produces
- application/json
2.2.103.5. Tags
- oapiv1
2.2.104. replace status of the specified ImageStream
PUT /oapi/v1/namespaces/{namespace}/imagestreams/{name}/status
2.2.104.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.104.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.104.3. Consumes
- /
2.2.104.4. Produces
- application/json
2.2.104.5. Tags
- oapiv1
2.2.105. list objects of kind ImageStreamTag
GET /oapi/v1/namespaces/{namespace}/imagestreamtags
2.2.105.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.105.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.105.3. Consumes
- /
2.2.105.4. Produces
- application/json
2.2.105.5. Tags
- oapiv1
2.2.106. read the specified ImageStreamTag
GET /oapi/v1/namespaces/{namespace}/imagestreamtags/{name}
2.2.106.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the ImageStreamTag | true | string |
2.2.106.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.106.3. Consumes
- /
2.2.106.4. Produces
- application/json
2.2.106.5. Tags
- oapiv1
2.2.107. replace the specified ImageStreamTag
PUT /oapi/v1/namespaces/{namespace}/imagestreamtags/{name}
2.2.107.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.107.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.107.3. Consumes
- /
2.2.107.4. Produces
- application/json
2.2.107.5. Tags
- oapiv1
2.2.108. delete a ImageStreamTag
DELETE /oapi/v1/namespaces/{namespace}/imagestreamtags/{name}
2.2.108.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the ImageStreamTag | true | string |
2.2.108.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.108.3. Consumes
- /
2.2.108.4. Produces
- application/json
2.2.108.5. Tags
- oapiv1
2.2.109. partially update the specified ImageStreamTag
PATCH /oapi/v1/namespaces/{namespace}/imagestreamtags/{name}
2.2.109.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.109.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.109.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.109.4. Produces
- application/json
2.2.109.5. Tags
- oapiv1
2.2.110. create a LocalResourceAccessReview
POST /oapi/v1/namespaces/{namespace}/localresourceaccessreviews
2.2.110.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.110.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.110.3. Consumes
- /
2.2.110.4. Produces
- application/json
2.2.110.5. Tags
- oapiv1
2.2.111. create a LocalSubjectAccessReview
POST /oapi/v1/namespaces/{namespace}/localsubjectaccessreviews
2.2.111.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.111.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.111.3. Consumes
- /
2.2.111.4. Produces
- application/json
2.2.111.5. Tags
- oapiv1
2.2.112. list or watch objects of kind Policy
GET /oapi/v1/namespaces/{namespace}/policies
2.2.112.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.112.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.112.3. Consumes
- /
2.2.112.4. Produces
- application/json
2.2.112.5. Tags
- oapiv1
2.2.113. create a Policy
POST /oapi/v1/namespaces/{namespace}/policies
2.2.113.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.113.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.113.3. Consumes
- /
2.2.113.4. Produces
- application/json
2.2.113.5. Tags
- oapiv1
2.2.114. read the specified Policy
GET /oapi/v1/namespaces/{namespace}/policies/{name}
2.2.114.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Policy | true | string |
2.2.114.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.114.3. Consumes
- /
2.2.114.4. Produces
- application/json
2.2.114.5. Tags
- oapiv1
2.2.115. replace the specified Policy
PUT /oapi/v1/namespaces/{namespace}/policies/{name}
2.2.115.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.115.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.115.3. Consumes
- /
2.2.115.4. Produces
- application/json
2.2.115.5. Tags
- oapiv1
2.2.116. delete a Policy
DELETE /oapi/v1/namespaces/{namespace}/policies/{name}
2.2.116.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.116.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.116.3. Consumes
- /
2.2.116.4. Produces
- application/json
2.2.116.5. Tags
- oapiv1
2.2.117. partially update the specified Policy
PATCH /oapi/v1/namespaces/{namespace}/policies/{name}
2.2.117.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.117.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.117.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.117.4. Produces
- application/json
2.2.117.5. Tags
- oapiv1
2.2.118. list or watch objects of kind PolicyBinding
GET /oapi/v1/namespaces/{namespace}/policybindings
2.2.118.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.118.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.118.3. Consumes
- /
2.2.118.4. Produces
- application/json
2.2.118.5. Tags
- oapiv1
2.2.119. create a PolicyBinding
POST /oapi/v1/namespaces/{namespace}/policybindings
2.2.119.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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 |
2.2.119.3. Consumes
- /
2.2.119.4. Produces
- application/json
2.2.119.5. Tags
- oapiv1
2.2.120. read the specified PolicyBinding
GET /oapi/v1/namespaces/{namespace}/policybindings/{name}
2.2.120.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the PolicyBinding | true | string |
2.2.120.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.120.3. Consumes
- /
2.2.120.4. Produces
- application/json
2.2.120.5. Tags
- oapiv1
2.2.121. replace the specified PolicyBinding
PUT /oapi/v1/namespaces/{namespace}/policybindings/{name}
2.2.121.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.121.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.121.3. Consumes
- /
2.2.121.4. Produces
- application/json
2.2.121.5. Tags
- oapiv1
2.2.122. delete a PolicyBinding
DELETE /oapi/v1/namespaces/{namespace}/policybindings/{name}
2.2.122.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.122.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.122.3. Consumes
- /
2.2.122.4. Produces
- application/json
2.2.122.5. Tags
- oapiv1
2.2.123. partially update the specified PolicyBinding
PATCH /oapi/v1/namespaces/{namespace}/policybindings/{name}
2.2.123.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.123.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
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
2.2.123.5. Tags
- oapiv1
2.2.124. create a Template
POST /oapi/v1/namespaces/{namespace}/processedtemplates
2.2.124.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.124.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.124.3. Consumes
- /
2.2.124.4. Produces
- application/json
2.2.124.5. Tags
- oapiv1
2.2.125. create a ResourceAccessReview
POST /oapi/v1/namespaces/{namespace}/resourceaccessreviews
2.2.125.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.125.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.125.3. Consumes
- /
2.2.125.4. Produces
- application/json
2.2.125.5. Tags
- oapiv1
2.2.126. list objects of kind RoleBinding
GET /oapi/v1/namespaces/{namespace}/rolebindings
2.2.126.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.126.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.126.3. Consumes
- /
2.2.126.4. Produces
- application/json
2.2.126.5. Tags
- oapiv1
2.2.127. create a RoleBinding
POST /oapi/v1/namespaces/{namespace}/rolebindings
2.2.127.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.127.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.127.3. Consumes
- /
2.2.127.4. Produces
- application/json
2.2.127.5. Tags
- oapiv1
2.2.128. read the specified RoleBinding
GET /oapi/v1/namespaces/{namespace}/rolebindings/{name}
2.2.128.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the RoleBinding | true | string |
2.2.128.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.128.3. Consumes
- /
2.2.128.4. Produces
- application/json
2.2.128.5. Tags
- oapiv1
2.2.129. replace the specified RoleBinding
PUT /oapi/v1/namespaces/{namespace}/rolebindings/{name}
2.2.129.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.129.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.129.3. Consumes
- /
2.2.129.4. Produces
- application/json
2.2.129.5. Tags
- oapiv1
2.2.130. delete a RoleBinding
DELETE /oapi/v1/namespaces/{namespace}/rolebindings/{name}
2.2.130.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.130.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.130.3. Consumes
- /
2.2.130.4. Produces
- application/json
2.2.130.5. Tags
- oapiv1
2.2.131. partially update the specified RoleBinding
PATCH /oapi/v1/namespaces/{namespace}/rolebindings/{name}
2.2.131.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.131.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.131.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.131.4. Produces
- application/json
2.2.131.5. Tags
- oapiv1
2.2.132. list objects of kind Role
GET /oapi/v1/namespaces/{namespace}/roles
2.2.132.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.132.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.132.3. Consumes
- /
2.2.132.4. Produces
- application/json
2.2.132.5. Tags
- oapiv1
2.2.133. create a Role
POST /oapi/v1/namespaces/{namespace}/roles
2.2.133.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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 |
2.2.133.3. Consumes
- /
2.2.133.4. Produces
- application/json
2.2.133.5. Tags
- oapiv1
2.2.134. read the specified Role
GET /oapi/v1/namespaces/{namespace}/roles/{name}
2.2.134.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Role | true | string |
2.2.134.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.134.3. Consumes
- /
2.2.134.4. Produces
- application/json
2.2.134.5. Tags
- oapiv1
2.2.135. replace the specified Role
PUT /oapi/v1/namespaces/{namespace}/roles/{name}
2.2.135.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.135.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.135.3. Consumes
- /
2.2.135.4. Produces
- application/json
2.2.135.5. Tags
- oapiv1
2.2.136. delete a Role
DELETE /oapi/v1/namespaces/{namespace}/roles/{name}
2.2.136.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.136.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.136.3. Consumes
- /
2.2.136.4. Produces
- application/json
2.2.136.5. Tags
- oapiv1
2.2.137. partially update the specified Role
PATCH /oapi/v1/namespaces/{namespace}/roles/{name}
2.2.137.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.137.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
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
2.2.137.5. Tags
- oapiv1
2.2.138. list or watch objects of kind Route
GET /oapi/v1/namespaces/{namespace}/routes
2.2.138.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.138.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.138.3. Consumes
- /
2.2.138.4. Produces
- application/json
2.2.138.5. Tags
- oapiv1
2.2.139. create a Route
POST /oapi/v1/namespaces/{namespace}/routes
2.2.139.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.139.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.139.3. Consumes
- /
2.2.139.4. Produces
- application/json
2.2.139.5. Tags
- oapiv1
2.2.140. read the specified Route
GET /oapi/v1/namespaces/{namespace}/routes/{name}
2.2.140.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Route | true | string |
2.2.140.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.140.3. Consumes
- /
2.2.140.4. Produces
- application/json
2.2.140.5. Tags
- oapiv1
2.2.141. replace the specified Route
PUT /oapi/v1/namespaces/{namespace}/routes/{name}
2.2.141.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.141.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.141.3. Consumes
- /
2.2.141.4. Produces
- application/json
2.2.141.5. Tags
- oapiv1
2.2.142. delete a Route
DELETE /oapi/v1/namespaces/{namespace}/routes/{name}
2.2.142.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.142.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.142.3. Consumes
- /
2.2.142.4. Produces
- application/json
2.2.142.5. Tags
- oapiv1
2.2.143. partially update the specified Route
PATCH /oapi/v1/namespaces/{namespace}/routes/{name}
2.2.143.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.143.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.143.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.143.4. Produces
- application/json
2.2.143.5. Tags
- oapiv1
2.2.144. replace status of the specified Route
PUT /oapi/v1/namespaces/{namespace}/routes/{name}/status
2.2.144.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.144.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.144.3. Consumes
- /
2.2.144.4. Produces
- application/json
2.2.144.5. Tags
- oapiv1
2.2.145. create a SubjectAccessReview
POST /oapi/v1/namespaces/{namespace}/subjectaccessreviews
2.2.145.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.145.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.145.3. Consumes
- /
2.2.145.4. Produces
- application/json
2.2.145.5. Tags
- oapiv1
2.2.146. list or watch objects of kind Template
GET /oapi/v1/namespaces/{namespace}/templates
2.2.146.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.146.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.146.3. Consumes
- /
2.2.146.4. Produces
- application/json
2.2.146.5. Tags
- oapiv1
2.2.147. create a Template
POST /oapi/v1/namespaces/{namespace}/templates
2.2.147.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.147.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.147.3. Consumes
- /
2.2.147.4. Produces
- application/json
2.2.147.5. Tags
- oapiv1
2.2.148. read the specified Template
GET /oapi/v1/namespaces/{namespace}/templates/{name}
2.2.148.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Template | true | string |
2.2.148.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.148.3. Consumes
- /
2.2.148.4. Produces
- application/json
2.2.148.5. Tags
- oapiv1
2.2.149. replace the specified Template
PUT /oapi/v1/namespaces/{namespace}/templates/{name}
2.2.149.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.149.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.149.3. Consumes
- /
2.2.149.4. Produces
- application/json
2.2.149.5. Tags
- oapiv1
2.2.150. delete a Template
DELETE /oapi/v1/namespaces/{namespace}/templates/{name}
2.2.150.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.150.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.150.3. Consumes
- /
2.2.150.4. Produces
- application/json
2.2.150.5. Tags
- oapiv1
2.2.151. partially update the specified Template
PATCH /oapi/v1/namespaces/{namespace}/templates/{name}
2.2.151.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.151.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.151.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.151.4. Produces
- application/json
2.2.151.5. Tags
- oapiv1
2.2.152. list or watch objects of kind NetNamespace
GET /oapi/v1/netnamespaces
2.2.152.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.152.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.152.3. Consumes
- /
2.2.152.4. Produces
- application/json
2.2.152.5. Tags
- oapiv1
2.2.153. create a NetNamespace
POST /oapi/v1/netnamespaces
2.2.153.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.153.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.153.3. Consumes
- /
2.2.153.4. Produces
- application/json
2.2.153.5. Tags
- oapiv1
2.2.154. read the specified NetNamespace
GET /oapi/v1/netnamespaces/{name}
2.2.154.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 NetNamespace | true | string |
2.2.154.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.154.3. Consumes
- /
2.2.154.4. Produces
- application/json
2.2.154.5. Tags
- oapiv1
2.2.155. replace the specified NetNamespace
PUT /oapi/v1/netnamespaces/{name}
2.2.155.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the NetNamespace | true | string |
2.2.155.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.155.3. Consumes
- /
2.2.155.4. Produces
- application/json
2.2.155.5. Tags
- oapiv1
2.2.156. delete a NetNamespace
DELETE /oapi/v1/netnamespaces/{name}
2.2.156.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the NetNamespace | true | string |
2.2.156.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.156.3. Consumes
- /
2.2.156.4. Produces
- application/json
2.2.156.5. Tags
- oapiv1
2.2.157. partially update the specified NetNamespace
PATCH /oapi/v1/netnamespaces/{name}
2.2.157.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the NetNamespace | true | string |
2.2.157.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.157.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.157.4. Produces
- application/json
2.2.157.5. Tags
- oapiv1
2.2.158. list objects of kind OAuthAccessToken
GET /oapi/v1/oauthaccesstokens
2.2.158.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.158.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.158.3. Consumes
- /
2.2.158.4. Produces
- application/json
2.2.158.5. Tags
- oapiv1
2.2.159. create a OAuthAccessToken
POST /oapi/v1/oauthaccesstokens
2.2.159.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.159.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.159.3. Consumes
- /
2.2.159.4. Produces
- application/json
2.2.159.5. Tags
- oapiv1
2.2.160. read the specified OAuthAccessToken
GET /oapi/v1/oauthaccesstokens/{name}
2.2.160.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 OAuthAccessToken | true | string |
2.2.160.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.160.3. Consumes
- /
2.2.160.4. Produces
- application/json
2.2.160.5. Tags
- oapiv1
2.2.161. delete a OAuthAccessToken
DELETE /oapi/v1/oauthaccesstokens/{name}
2.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 | |||
PathParameter | name | name of the OAuthAccessToken | true | string |
2.2.161.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.161.3. Consumes
- /
2.2.161.4. Produces
- application/json
2.2.161.5. Tags
- oapiv1
2.2.162. list objects of kind OAuthAuthorizeToken
GET /oapi/v1/oauthauthorizetokens
2.2.162.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.162.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.162.3. Consumes
- /
2.2.162.4. Produces
- application/json
2.2.162.5. Tags
- oapiv1
2.2.163. create a OAuthAuthorizeToken
POST /oapi/v1/oauthauthorizetokens
2.2.163.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.163.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.163.3. Consumes
- /
2.2.163.4. Produces
- application/json
2.2.163.5. Tags
- oapiv1
2.2.164. read the specified OAuthAuthorizeToken
GET /oapi/v1/oauthauthorizetokens/{name}
2.2.164.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 OAuthAuthorizeToken | true | string |
2.2.164.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.164.3. Consumes
- /
2.2.164.4. Produces
- application/json
2.2.164.5. Tags
- oapiv1
2.2.165. delete a OAuthAuthorizeToken
DELETE /oapi/v1/oauthauthorizetokens/{name}
2.2.165.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the OAuthAuthorizeToken | true | string |
2.2.165.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.165.3. Consumes
- /
2.2.165.4. Produces
- application/json
2.2.165.5. Tags
- oapiv1
2.2.166. list or watch objects of kind OAuthClientAuthorization
GET /oapi/v1/oauthclientauthorizations
2.2.166.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.166.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.166.3. Consumes
- /
2.2.166.4. Produces
- application/json
2.2.166.5. Tags
- oapiv1
2.2.167. create a OAuthClientAuthorization
POST /oapi/v1/oauthclientauthorizations
2.2.167.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.167.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.167.3. Consumes
- /
2.2.167.4. Produces
- application/json
2.2.167.5. Tags
- oapiv1
2.2.168. read the specified OAuthClientAuthorization
GET /oapi/v1/oauthclientauthorizations/{name}
2.2.168.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 OAuthClientAuthorization | true | string |
2.2.168.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.168.3. Consumes
- /
2.2.168.4. Produces
- application/json
2.2.168.5. Tags
- oapiv1
2.2.169. replace the specified OAuthClientAuthorization
PUT /oapi/v1/oauthclientauthorizations/{name}
2.2.169.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the OAuthClientAuthorization | true | string |
2.2.169.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.169.3. Consumes
- /
2.2.169.4. Produces
- application/json
2.2.169.5. Tags
- oapiv1
2.2.170. delete a OAuthClientAuthorization
DELETE /oapi/v1/oauthclientauthorizations/{name}
2.2.170.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the OAuthClientAuthorization | true | string |
2.2.170.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.170.3. Consumes
- /
2.2.170.4. Produces
- application/json
2.2.170.5. Tags
- oapiv1
2.2.171. partially update the specified OAuthClientAuthorization
PATCH /oapi/v1/oauthclientauthorizations/{name}
2.2.171.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the OAuthClientAuthorization | true | string |
2.2.171.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.171.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.171.4. Produces
- application/json
2.2.171.5. Tags
- oapiv1
2.2.172. list or watch objects of kind OAuthClient
GET /oapi/v1/oauthclients
2.2.172.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.172.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.172.3. Consumes
- /
2.2.172.4. Produces
- application/json
2.2.172.5. Tags
- oapiv1
2.2.173. create a OAuthClient
POST /oapi/v1/oauthclients
2.2.173.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.173.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.173.3. Consumes
- /
2.2.173.4. Produces
- application/json
2.2.173.5. Tags
- oapiv1
2.2.174. read the specified OAuthClient
GET /oapi/v1/oauthclients/{name}
2.2.174.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 OAuthClient | true | string |
2.2.174.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.174.3. Consumes
- /
2.2.174.4. Produces
- application/json
2.2.174.5. Tags
- oapiv1
2.2.175. replace the specified OAuthClient
PUT /oapi/v1/oauthclients/{name}
2.2.175.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the OAuthClient | true | string |
2.2.175.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.175.3. Consumes
- /
2.2.175.4. Produces
- application/json
2.2.175.5. Tags
- oapiv1
2.2.176. delete a OAuthClient
DELETE /oapi/v1/oauthclients/{name}
2.2.176.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the OAuthClient | true | string |
2.2.176.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.176.3. Consumes
- /
2.2.176.4. Produces
- application/json
2.2.176.5. Tags
- oapiv1
2.2.177. partially update the specified OAuthClient
PATCH /oapi/v1/oauthclients/{name}
2.2.177.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the OAuthClient | true | string |
2.2.177.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.177.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.177.4. Produces
- application/json
2.2.177.5. Tags
- oapiv1
2.2.178. list or watch objects of kind Policy
GET /oapi/v1/policies
2.2.178.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.178.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.178.3. Consumes
- /
2.2.178.4. Produces
- application/json
2.2.178.5. Tags
- oapiv1
2.2.179. create a Policy
POST /oapi/v1/policies
2.2.179.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.179.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.179.3. Consumes
- /
2.2.179.4. Produces
- application/json
2.2.179.5. Tags
- oapiv1
2.2.180. list or watch objects of kind PolicyBinding
GET /oapi/v1/policybindings
2.2.180.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.180.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.180.3. Consumes
- /
2.2.180.4. Produces
- application/json
2.2.180.5. Tags
- oapiv1
2.2.181. create a PolicyBinding
POST /oapi/v1/policybindings
2.2.181.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.181.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.181.3. Consumes
- /
2.2.181.4. Produces
- application/json
2.2.181.5. Tags
- oapiv1
2.2.182. create a Template
POST /oapi/v1/processedtemplates
2.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 |
2.2.182.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.182.3. Consumes
- /
2.2.182.4. Produces
- application/json
2.2.182.5. Tags
- oapiv1
2.2.183. list objects of kind ProjectRequest
GET /oapi/v1/projectrequests
2.2.183.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.183.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.183.3. Consumes
- /
2.2.183.4. Produces
- application/json
2.2.183.5. Tags
- oapiv1
2.2.184. create a ProjectRequest
POST /oapi/v1/projectrequests
2.2.184.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.184.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.184.3. Consumes
- /
2.2.184.4. Produces
- application/json
2.2.184.5. Tags
- oapiv1
2.2.185. list objects of kind Project
GET /oapi/v1/projects
2.2.185.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.185.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.185.3. Consumes
- /
2.2.185.4. Produces
- application/json
2.2.185.5. Tags
- oapiv1
2.2.186. create a Project
POST /oapi/v1/projects
2.2.186.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.186.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.186.3. Consumes
- /
2.2.186.4. Produces
- application/json
2.2.186.5. Tags
- oapiv1
2.2.187. read the specified Project
GET /oapi/v1/projects/{name}
2.2.187.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.187.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.187.3. Consumes
- /
2.2.187.4. Produces
- application/json
2.2.187.5. Tags
- oapiv1
2.2.188. replace the specified Project
PUT /oapi/v1/projects/{name}
2.2.188.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the Project | true | string |
2.2.188.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.188.3. Consumes
- /
2.2.188.4. Produces
- application/json
2.2.188.5. Tags
- oapiv1
2.2.189. delete a Project
DELETE /oapi/v1/projects/{name}
2.2.189.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.189.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.189.3. Consumes
- /
2.2.189.4. Produces
- application/json
2.2.189.5. Tags
- oapiv1
2.2.190. partially update the specified Project
PATCH /oapi/v1/projects/{name}
2.2.190.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the Project | true | string |
2.2.190.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
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
2.2.190.5. Tags
- oapiv1
2.2.191. create a ResourceAccessReview
POST /oapi/v1/resourceaccessreviews
2.2.191.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.191.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.191.3. Consumes
- /
2.2.191.4. Produces
- application/json
2.2.191.5. Tags
- oapiv1
2.2.192. list objects of kind RoleBinding
GET /oapi/v1/rolebindings
2.2.192.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.192.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.192.3. Consumes
- /
2.2.192.4. Produces
- application/json
2.2.192.5. Tags
- oapiv1
2.2.193. create a RoleBinding
POST /oapi/v1/rolebindings
2.2.193.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.193.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.193.3. Consumes
- /
2.2.193.4. Produces
- application/json
2.2.193.5. Tags
- oapiv1
2.2.194. list objects of kind Role
GET /oapi/v1/roles
2.2.194.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.194.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.194.3. Consumes
- /
2.2.194.4. Produces
- application/json
2.2.194.5. Tags
- oapiv1
2.2.195. create a Role
POST /oapi/v1/roles
2.2.195.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.195.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.195.3. Consumes
- /
2.2.195.4. Produces
- application/json
2.2.195.5. Tags
- oapiv1
2.2.196. list or watch objects of kind Route
GET /oapi/v1/routes
2.2.196.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.196.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.196.3. Consumes
- /
2.2.196.4. Produces
- application/json
2.2.196.5. Tags
- oapiv1
2.2.197. create a Route
POST /oapi/v1/routes
2.2.197.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.197.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.197.3. Consumes
- /
2.2.197.4. Produces
- application/json
2.2.197.5. Tags
- oapiv1
2.2.198. create a SubjectAccessReview
POST /oapi/v1/subjectaccessreviews
2.2.198.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.198.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.198.3. Consumes
- /
2.2.198.4. Produces
- application/json
2.2.198.5. Tags
- oapiv1
2.2.199. list or watch objects of kind Template
GET /oapi/v1/templates
2.2.199.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.199.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.199.3. Consumes
- /
2.2.199.4. Produces
- application/json
2.2.199.5. Tags
- oapiv1
2.2.200. create a Template
POST /oapi/v1/templates
2.2.200.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.200.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.200.3. Consumes
- /
2.2.200.4. Produces
- application/json
2.2.200.5. Tags
- oapiv1
2.2.201. create a UserIdentityMapping
POST /oapi/v1/useridentitymappings
2.2.201.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.201.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.201.3. Consumes
- /
2.2.201.4. Produces
- application/json
2.2.201.5. Tags
- oapiv1
2.2.202. read the specified UserIdentityMapping
GET /oapi/v1/useridentitymappings/{name}
2.2.202.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.202.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.202.3. Consumes
- /
2.2.202.4. Produces
- application/json
2.2.202.5. Tags
- oapiv1
2.2.203. replace the specified UserIdentityMapping
PUT /oapi/v1/useridentitymappings/{name}
2.2.203.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the UserIdentityMapping | true | string |
2.2.203.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.203.3. Consumes
- /
2.2.203.4. Produces
- application/json
2.2.203.5. Tags
- oapiv1
2.2.204. delete a UserIdentityMapping
DELETE /oapi/v1/useridentitymappings/{name}
2.2.204.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.204.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.204.3. Consumes
- /
2.2.204.4. Produces
- application/json
2.2.204.5. Tags
- oapiv1
2.2.205. partially update the specified UserIdentityMapping
PATCH /oapi/v1/useridentitymappings/{name}
2.2.205.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the UserIdentityMapping | true | string |
2.2.205.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.205.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.205.4. Produces
- application/json
2.2.205.5. Tags
- oapiv1
2.2.206. list or watch objects of kind User
GET /oapi/v1/users
2.2.206.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.206.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.206.3. Consumes
- /
2.2.206.4. Produces
- application/json
2.2.206.5. Tags
- oapiv1
2.2.207. create a User
POST /oapi/v1/users
2.2.207.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.207.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.207.3. Consumes
- /
2.2.207.4. Produces
- application/json
2.2.207.5. Tags
- oapiv1
2.2.208. read the specified User
GET /oapi/v1/users/{name}
2.2.208.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 User | true | string |
2.2.208.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.208.3. Consumes
- /
2.2.208.4. Produces
- application/json
2.2.208.5. Tags
- oapiv1
2.2.209. replace the specified User
PUT /oapi/v1/users/{name}
2.2.209.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the User | true | string |
2.2.209.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.209.3. Consumes
- /
2.2.209.4. Produces
- application/json
2.2.209.5. Tags
- oapiv1
2.2.210. delete a User
DELETE /oapi/v1/users/{name}
2.2.210.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the User | true | string |
2.2.210.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.210.3. Consumes
- /
2.2.210.4. Produces
- application/json
2.2.210.5. Tags
- oapiv1
2.2.211. partially update the specified User
PATCH /oapi/v1/users/{name}
2.2.211.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the User | true | string |
2.2.211.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.211.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.211.4. Produces
- application/json
2.2.211.5. Tags
- oapiv1
2.2.212. watch individual changes to a list of BuildConfig
GET /oapi/v1/watch/buildconfigs
2.2.212.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.212.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.212.3. Consumes
- /
2.2.212.4. Produces
- application/json
2.2.212.5. Tags
- oapiv1
2.2.213. watch individual changes to a list of Build
GET /oapi/v1/watch/builds
2.2.213.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.213.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.213.3. Consumes
- /
2.2.213.4. Produces
- application/json
2.2.213.5. Tags
- oapiv1
2.2.214. watch individual changes to a list of ClusterNetwork
GET /oapi/v1/watch/clusternetworks
2.2.214.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.214.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.214.3. Consumes
- /
2.2.214.4. Produces
- application/json
2.2.214.5. Tags
- oapiv1
2.2.215. watch changes to an object of kind ClusterNetwork
GET /oapi/v1/watch/clusternetworks/{name}
2.2.215.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | name | name of the ClusterNetwork | true | string |
2.2.215.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.215.3. Consumes
- /
2.2.215.4. Produces
- application/json
2.2.215.5. Tags
- oapiv1
2.2.216. watch individual changes to a list of ClusterPolicy
GET /oapi/v1/watch/clusterpolicies
2.2.216.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.216.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.216.3. Consumes
- /
2.2.216.4. Produces
- application/json
2.2.216.5. Tags
- oapiv1
2.2.217. watch changes to an object of kind ClusterPolicy
GET /oapi/v1/watch/clusterpolicies/{name}
2.2.217.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | name | name of the ClusterPolicy | true | string |
2.2.217.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.217.3. Consumes
- /
2.2.217.4. Produces
- application/json
2.2.217.5. Tags
- oapiv1
2.2.218. watch individual changes to a list of ClusterPolicyBinding
GET /oapi/v1/watch/clusterpolicybindings
2.2.218.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.218.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.218.3. Consumes
- /
2.2.218.4. Produces
- application/json
2.2.218.5. Tags
- oapiv1
2.2.219. watch changes to an object of kind ClusterPolicyBinding
GET /oapi/v1/watch/clusterpolicybindings/{name}
2.2.219.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | name | name of the ClusterPolicyBinding | true | string |
2.2.219.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.219.3. Consumes
- /
2.2.219.4. Produces
- application/json
2.2.219.5. Tags
- oapiv1
2.2.220. watch individual changes to a list of DeploymentConfig
GET /oapi/v1/watch/deploymentconfigs
2.2.220.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.220.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.220.3. Consumes
- /
2.2.220.4. Produces
- application/json
2.2.220.5. Tags
- oapiv1
2.2.221. watch individual changes to a list of Group
GET /oapi/v1/watch/groups
2.2.221.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.221.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.221.3. Consumes
- /
2.2.221.4. Produces
- application/json
2.2.221.5. Tags
- oapiv1
2.2.222. watch changes to an object of kind Group
GET /oapi/v1/watch/groups/{name}
2.2.222.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | name | name of the Group | true | string |
2.2.222.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.222.3. Consumes
- /
2.2.222.4. Produces
- application/json
2.2.222.5. Tags
- oapiv1
2.2.223. watch individual changes to a list of HostSubnet
GET /oapi/v1/watch/hostsubnets
2.2.223.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.223.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.223.3. Consumes
- /
2.2.223.4. Produces
- application/json
2.2.223.5. Tags
- oapiv1
2.2.224. watch changes to an object of kind HostSubnet
GET /oapi/v1/watch/hostsubnets/{name}
2.2.224.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | name | name of the HostSubnet | true | string |
2.2.224.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.224.3. Consumes
- /
2.2.224.4. Produces
- application/json
2.2.224.5. Tags
- oapiv1
2.2.225. watch individual changes to a list of Identity
GET /oapi/v1/watch/identities
2.2.225.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.225.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.225.3. Consumes
- /
2.2.225.4. Produces
- application/json
2.2.225.5. Tags
- oapiv1
2.2.226. watch changes to an object of kind Identity
GET /oapi/v1/watch/identities/{name}
2.2.226.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | name | name of the Identity | true | string |
2.2.226.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.226.3. Consumes
- /
2.2.226.4. Produces
- application/json
2.2.226.5. Tags
- oapiv1
2.2.227. watch individual changes to a list of Image
GET /oapi/v1/watch/images
2.2.227.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.227.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.227.3. Consumes
- /
2.2.227.4. Produces
- application/json
2.2.227.5. Tags
- oapiv1
2.2.228. watch changes to an object of kind Image
GET /oapi/v1/watch/images/{name}
2.2.228.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | name | name of the Image | true | string |
2.2.228.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.228.3. Consumes
- /
2.2.228.4. Produces
- application/json
2.2.228.5. Tags
- oapiv1
2.2.229. watch individual changes to a list of ImageStream
GET /oapi/v1/watch/imagestreams
2.2.229.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.229.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.229.3. Consumes
- /
2.2.229.4. Produces
- application/json
2.2.229.5. Tags
- oapiv1
2.2.230. watch individual changes to a list of BuildConfig
GET /oapi/v1/watch/namespaces/{namespace}/buildconfigs
2.2.230.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.230.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.230.3. Consumes
- /
2.2.230.4. Produces
- application/json
2.2.230.5. Tags
- oapiv1
2.2.231. watch changes to an object of kind BuildConfig
GET /oapi/v1/watch/namespaces/{namespace}/buildconfigs/{name}
2.2.231.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the BuildConfig | true | string |
2.2.231.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.231.3. Consumes
- /
2.2.231.4. Produces
- application/json
2.2.231.5. Tags
- oapiv1
2.2.232. watch individual changes to a list of Build
GET /oapi/v1/watch/namespaces/{namespace}/builds
2.2.232.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.232.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.232.3. Consumes
- /
2.2.232.4. Produces
- application/json
2.2.232.5. Tags
- oapiv1
2.2.233. watch changes to an object of kind Build
GET /oapi/v1/watch/namespaces/{namespace}/builds/{name}
2.2.233.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Build | true | string |
2.2.233.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.233.3. Consumes
- /
2.2.233.4. Produces
- application/json
2.2.233.5. Tags
- oapiv1
2.2.234. watch individual changes to a list of DeploymentConfig
GET /oapi/v1/watch/namespaces/{namespace}/deploymentconfigs
2.2.234.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.234.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.234.3. Consumes
- /
2.2.234.4. Produces
- application/json
2.2.234.5. Tags
- oapiv1
2.2.235. watch changes to an object of kind DeploymentConfig
GET /oapi/v1/watch/namespaces/{namespace}/deploymentconfigs/{name}
2.2.235.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the DeploymentConfig | true | string |
2.2.235.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.235.3. Consumes
- /
2.2.235.4. Produces
- application/json
2.2.235.5. Tags
- oapiv1
2.2.236. watch individual changes to a list of ImageStream
GET /oapi/v1/watch/namespaces/{namespace}/imagestreams
2.2.236.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.236.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.236.3. Consumes
- /
2.2.236.4. Produces
- application/json
2.2.236.5. Tags
- oapiv1
2.2.237. watch changes to an object of kind ImageStream
GET /oapi/v1/watch/namespaces/{namespace}/imagestreams/{name}
2.2.237.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the ImageStream | true | string |
2.2.237.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.237.3. Consumes
- /
2.2.237.4. Produces
- application/json
2.2.237.5. Tags
- oapiv1
2.2.238. watch individual changes to a list of Policy
GET /oapi/v1/watch/namespaces/{namespace}/policies
2.2.238.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.238.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.238.3. Consumes
- /
2.2.238.4. Produces
- application/json
2.2.238.5. Tags
- oapiv1
2.2.239. watch changes to an object of kind Policy
GET /oapi/v1/watch/namespaces/{namespace}/policies/{name}
2.2.239.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Policy | true | string |
2.2.239.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.239.3. Consumes
- /
2.2.239.4. Produces
- application/json
2.2.239.5. Tags
- oapiv1
2.2.240. watch individual changes to a list of PolicyBinding
GET /oapi/v1/watch/namespaces/{namespace}/policybindings
2.2.240.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.240.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.240.3. Consumes
- /
2.2.240.4. Produces
- application/json
2.2.240.5. Tags
- oapiv1
2.2.241. watch changes to an object of kind PolicyBinding
GET /oapi/v1/watch/namespaces/{namespace}/policybindings/{name}
2.2.241.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the PolicyBinding | true | string |
2.2.241.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.241.3. Consumes
- /
2.2.241.4. Produces
- application/json
2.2.241.5. Tags
- oapiv1
2.2.242. watch individual changes to a list of Route
GET /oapi/v1/watch/namespaces/{namespace}/routes
2.2.242.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.242.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.242.3. Consumes
- /
2.2.242.4. Produces
- application/json
2.2.242.5. Tags
- oapiv1
2.2.243. watch changes to an object of kind Route
GET /oapi/v1/watch/namespaces/{namespace}/routes/{name}
2.2.243.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Route | true | string |
2.2.243.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.243.3. Consumes
- /
2.2.243.4. Produces
- application/json
2.2.243.5. Tags
- oapiv1
2.2.244. watch individual changes to a list of Template
GET /oapi/v1/watch/namespaces/{namespace}/templates
2.2.244.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.244.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.244.3. Consumes
- /
2.2.244.4. Produces
- application/json
2.2.244.5. Tags
- oapiv1
2.2.245. watch changes to an object of kind Template
GET /oapi/v1/watch/namespaces/{namespace}/templates/{name}
2.2.245.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Template | true | string |
2.2.245.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.245.3. Consumes
- /
2.2.245.4. Produces
- application/json
2.2.245.5. Tags
- oapiv1
2.2.246. watch individual changes to a list of NetNamespace
GET /oapi/v1/watch/netnamespaces
2.2.246.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.246.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.246.3. Consumes
- /
2.2.246.4. Produces
- application/json
2.2.246.5. Tags
- oapiv1
2.2.247. watch changes to an object of kind NetNamespace
GET /oapi/v1/watch/netnamespaces/{name}
2.2.247.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | name | name of the NetNamespace | true | string |
2.2.247.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.247.3. Consumes
- /
2.2.247.4. Produces
- application/json
2.2.247.5. Tags
- oapiv1
2.2.248. watch individual changes to a list of OAuthClientAuthorization
GET /oapi/v1/watch/oauthclientauthorizations
2.2.248.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.248.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.248.3. Consumes
- /
2.2.248.4. Produces
- application/json
2.2.248.5. Tags
- oapiv1
2.2.249. watch changes to an object of kind OAuthClientAuthorization
GET /oapi/v1/watch/oauthclientauthorizations/{name}
2.2.249.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | name | name of the OAuthClientAuthorization | true | string |
2.2.249.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.249.3. Consumes
- /
2.2.249.4. Produces
- application/json
2.2.249.5. Tags
- oapiv1
2.2.250. watch individual changes to a list of OAuthClient
GET /oapi/v1/watch/oauthclients
2.2.250.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.250.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.250.3. Consumes
- /
2.2.250.4. Produces
- application/json
2.2.250.5. Tags
- oapiv1
2.2.251. watch changes to an object of kind OAuthClient
GET /oapi/v1/watch/oauthclients/{name}
2.2.251.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | name | name of the OAuthClient | true | string |
2.2.251.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.251.3. Consumes
- /
2.2.251.4. Produces
- application/json
2.2.251.5. Tags
- oapiv1
2.2.252. watch individual changes to a list of Policy
GET /oapi/v1/watch/policies
2.2.252.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.252.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.252.3. Consumes
- /
2.2.252.4. Produces
- application/json
2.2.252.5. Tags
- oapiv1
2.2.253. watch individual changes to a list of PolicyBinding
GET /oapi/v1/watch/policybindings
2.2.253.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.253.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.253.3. Consumes
- /
2.2.253.4. Produces
- application/json
2.2.253.5. Tags
- oapiv1
2.2.254. watch individual changes to a list of Route
GET /oapi/v1/watch/routes
2.2.254.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.254.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.254.3. Consumes
- /
2.2.254.4. Produces
- application/json
2.2.254.5. Tags
- oapiv1
2.2.255. watch individual changes to a list of Template
GET /oapi/v1/watch/templates
2.2.255.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.255.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.255.3. Consumes
- /
2.2.255.4. Produces
- application/json
2.2.255.5. Tags
- oapiv1
2.2.256. watch individual changes to a list of User
GET /oapi/v1/watch/users
2.2.256.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
2.2.256.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.256.3. Consumes
- /
2.2.256.4. Produces
- application/json
2.2.256.5. Tags
- oapiv1
2.2.257. watch changes to an object of kind User
GET /oapi/v1/watch/users/{name}
2.2.257.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | name | name of the User | true | string |
2.2.257.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.257.3. Consumes
- /
2.2.257.4. Produces
- application/json
2.2.257.5. Tags
- oapiv1
2.3. Definitions
2.3.1. v1.MetadataVolumeSource
Name | Description | Required | Schema | Default |
---|---|---|---|---|
items | list of metadata files | false |
2.3.2. 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.3. v1.GitBuildSource
Name | Description | Required | Schema | Default |
---|---|---|---|---|
uri | points to the source that will be built, structure of the source will depend on the type of build to run | true | string | |
ref | identifies the branch/tag/ref to build | false | string | |
httpProxy | specifies a http proxy to be used during git clone operations | false | string | |
httpsProxy | specifies a https proxy to be used during git clone operations | false | string |
2.3.4. v1.HostSubnetList
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
items | list of host subnets | true |
2.3.5. v1.GroupList
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
items | list of groups | true |
2.3.6. v1.PolicyBindingList
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
items | list of policy bindings | true |
2.3.7. v1.ClusterRoleList
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
items | list of cluster roles | true |
2.3.8. v1.Capability
2.3.9. v1.SourceRevision
Name | Description | Required | Schema | Default |
---|---|---|---|---|
type | type of the build source | true | string | |
git | information about git-based build source | false |
2.3.10. v1.User
Upon log in, every user of the system receives a User and Identity resource. Administrators may directly manipulate the attributes of the users for their own tracking, or set groups via the API. The user name is unique and is chosen based on the value provided by the identity provider - if a user already exists with the incoming name, the user name may have a number appended to it.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
fullName | full name of user | false | string | |
identities | list of identities | true | string array | |
groups | list of groups | true | string array |
2.3.11. v1.HostSubnet
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
host | Name of the host that is registered at the master. A lease will be sought after this name. | true | string | |
hostIP | IP address to be used as vtep by other hosts in the overlay network | true | string | |
subnet | Actual subnet CIDR lease assigned to the host | true | string |
2.3.12. v1.ClusterPolicyBinding
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
lastModified | last time any part of the object was created, updated, or deleted | true | string | |
policyRef | reference to the cluster policy that this cluster policy binding’s role bindings may reference | true | ||
roleBindings | all the role bindings held by this policy, mapped by role name | true |
2.3.13. v1.BuildStatus
Name | Description | Required | Schema | Default |
---|---|---|---|---|
phase | observed point in the build lifecycle | true | string | |
cancelled | describes if a canceling event was triggered for the build | false | boolean | false |
reason | brief CamelCase string describing a failure, meant for machine parsing and tidy display in the CLI | false | string | |
message | human-readable message indicating details about why the build has this status | false | string | |
startTimestamp | server time when this build started running in a pod | false | string | |
completionTimestamp | server time when the pod running this build stopped running | false | string | |
duration | amount of time the build has been running | false | time.Duration | |
outputDockerImageReference | reference to the Docker image built by this build, computed from build.spec.output.to, and can be used to push and pull the image | false | string | |
config | reference to build config from which this build was derived | false |
2.3.14. v1.BuildRequest
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
revision | information from the source for a specific repo snapshot | false | ||
triggeredByImage | image that triggered this build | false | ||
from | ImageStreamTag that triggered this build | false | ||
binary | the binary will be provided by the builder as an archive or file to be placed within the input directory; allows Dockerfile to be optionally set; may not be set with git source type also set | false | ||
lastVersion | LastVersion of the BuildConfig that triggered this build | false | integer (int32) |
2.3.15. v1.HostPathVolumeSource
HostPathVolumeSource represents bare host directory volume.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
path | Path of the directory on the host. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#hostpath | true | string |
2.3.16. v1.NetNamespaceList
NetNamespaceList represents a list of NetNamespace objects. NetNamespace catpures information about a segregated network namespace for an entire cluster. When a group of pods, or a project, or a group of projects get a NetNamespace assigned then the openshift-sdn’s multitenant plug-in ensures network layer isolation of traffic from other NetNamespaces.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
items | list of net namespaces | true |
2.3.17. v1.ImageStreamTagList
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
items | list of image stream tag objects | true |
2.3.18. v1.Parameter
Name | Description | Required | Schema | Default |
---|---|---|---|---|
name | name of the parameter | true | string | |
displayName | optional: provides human readable name for the parameter | false | string | |
description | optional: describes the parameter | false | string | |
value | optional: holds the parameter data. if specified, the generator is ignored. the value replaces all occurrences of the parameter ${Name} expression during template to config transformation | false | string | |
generate | optional: generate specifies the generator to be used to generate random string from an input value specified by the from field. the result string is stored in the value field. if not specified, the value field is untouched | false | string | |
from | input value for the generator | false | string | |
required | indicates the parameter must have a non-empty value or be generated | false | boolean | false |
2.3.19. v1.Volume
Volume represents a named volume in a pod that may be accessed by any container in the pod.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
name | Volume’s name. Must be a DNS_LABEL and unique within the pod. More info: http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names | true | string | |
hostPath | HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#hostpath | false | ||
emptyDir | EmptyDir represents a temporary directory that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#emptydir | false | ||
gcePersistentDisk | GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk | false | ||
awsElasticBlockStore | AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore | false | ||
gitRepo | GitRepo represents a git repository at a particular revision. | false | ||
secret | Secret represents a secret that should populate this volume. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#secrets | false | ||
nfs | NFS represents an NFS mount on the host that shares a pod’s lifetime More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs | false | ||
iscsi | ISCSI represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/HEAD/examples/iscsi/README.md | false | ||
glusterfs | Glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/glusterfs/README.md | false | ||
persistentVolumeClaim | PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims | false | ||
rbd | RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/rbd/README.md | false | ||
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 | ||
cephfs | CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime | false | ||
flocker | Flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running | false | ||
downwardAPI | DownwardAPI represents downward API about the pod that should populate this volume | false | ||
fc | FC represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod. | false | ||
metadata | false |
2.3.20. v1.RouteStatus
2.3.21. v1.BuildTriggerPolicy
Name | Description | Required | Schema | Default |
---|---|---|---|---|
type | type of build trigger | true | string | |
github | parameters for a GitHub webhook type of trigger | false | ||
generic | parameters for a Generic webhook type of trigger | false | ||
imageChange | parameters for an ImageChange type of trigger | false |
2.3.22. v1.PolicyList
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
items | list of policies | true |
2.3.23. v1.LocalSubjectAccessReview
Local Subject Access Reviews are objects that allow you to determine whether a given user or group can perform a particular action in a given namespace. Leaving user
and groups
empty allows you determine whether the identity making the request can perform the action.
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 | |
namespace | namespace of the action being requested | true | string | |
verb | one of get, list, watch, create, update, delete | true | string | |
resource | one of the existing resource types | true | string | |
resourceName | name of the resource being requested for a get or delete | true | string | |
content | actual content of the request for create and update | false | string | |
user | optional, if both user and groups are empty, the current authenticated user is used | true | string | |
groups | optional, list of groups to which the user belongs | true | string array |
2.3.24. v1.DeleteOptions
DeleteOptions may be provided when deleting an API object
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | true | integer (int64) |
2.3.25. 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 | ||
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 |
2.3.26. v1.Build
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
spec | specification of the desired behavior for a build | false | ||
status | most recently observed status of a build as populated by the system | false |
2.3.27. v1.NetNamespace
NetNamespace represents a segregated network namespace for an entire cluster. When a group of pods, or a project, or a group of projects get a NetNamespace assigned then the openshift-sdn’s multitenant plug-in ensures network layer isolation of traffic from other NetNamespaces.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
netname | Name of the network namespace. | true | string | |
netid | NetID of the network namespace assigned to each overlay network packet. | true | unit |
2.3.28. v1.NFSVolumeSource
NFSVolumeSource represents an NFS mount that lasts the lifetime of a pod
Name | Description | Required | Schema | Default |
---|---|---|---|---|
server | Server is the hostname or IP address of the NFS server. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs | true | string | |
path | Path that is exported by the NFS server. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs | true | string | |
readOnly | ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs | false | boolean | false |
2.3.29. v1.CephFSVolumeSource
CephFSVolumeSource represents a Ceph Filesystem Mount that lasts the lifetime of a pod
Name | Description | Required | Schema | Default |
---|---|---|---|---|
monitors | Required: Monitors is a collection of Ceph monitors More info: http://releases.k8s.io/HEAD/examples/cephfs/README.md#how-to-use-it | true | string array | |
user | Optional: User is the rados user name, default is admin More info: http://releases.k8s.io/HEAD/examples/cephfs/README.md#how-to-use-it | false | string | |
secretFile | Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: http://releases.k8s.io/HEAD/examples/cephfs/README.md#how-to-use-it | false | string | |
secretRef | Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: http://releases.k8s.io/HEAD/examples/cephfs/README.md#how-to-use-it | false | ||
readOnly | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/cephfs/README.md#how-to-use-it | false | boolean | false |
2.3.30. v1.Capabilities
Adds and removes POSIX capabilities from running containers.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
add | Added capabilities | false | ||
drop | Removed capabilities | false |
2.3.31. v1.DeploymentConfig
Deployment Configs define the template for a pod and manages deploying new images or configuration changes. A single deployment configuration is usually analogous to a single micro-service. Can support many different deployment patterns, including full restart, customizable rolling updates, and fully custom behaviors, as well as pre- and post- deployment hooks. Each individual deployment is represented as a replication controller.
A deployment is "triggered" when its configuration is changed or a tag in an Image Stream is changed. Triggers can be disabled to allow manual control over a deployment. The "strategy"determines how the deployment is carried out and may be changed at any time.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
spec | a desired deployment state and how to deploy it | true | ||
status | the current state of the latest deployment | true |
2.3.32. v1.ProjectRequest
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 | true | string | |
metadata |
subfield | |||
displayName | display name to apply to a project | false | string | |
description | description to apply to a project | false | string |
2.3.33. v1.DeploymentLog
A deployment log is a virtual resource used by the OpenShift client tool for retrieving 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.34. v1.OAuthAccessToken
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
clientName | references the client that created this token | false | string | |
expiresIn | is the seconds from creation time before this token expires | false | integer (int64) | |
scopes | list of requested scopes | false | string array | |
redirectURI | redirection URI associated with the token | false | string | |
userName | user name associated with this token | false | string | |
userUID | unique UID associated with this token | false | string | |
authorizeToken | contains the token that authorized this token | false | string | |
refreshToken | optional value by which this token can be renewed | false | string |
2.3.35. unversioned.Status
Status is a return value for calls that don’t return other objects.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | ||
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 | ||
code | Suggested HTTP return code for this status, 0 if not set. | false | integer (int32) |
2.3.36. v1.BuildConfigList
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
items | list of build configs | true |
2.3.37. 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 | Default |
---|---|---|---|---|
name | The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). | false | string | |
kind | The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. 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 | ||
retryAfterSeconds | If specified, the time in seconds before the operation should be retried. | false | integer (int32) |
2.3.38. v1.SecretVolumeSource
SecretVolumeSource adapts a Secret into a VolumeSource. More info: http://releases.k8s.io/HEAD/docs/design/secrets.md
Name | Description | Required | Schema | Default |
---|---|---|---|---|
secretName | SecretName is the name of a secret in the pod’s namespace. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#secrets | true | string |
2.3.39. v1.SecretSpec
A SecretSpec specifies a secret and its corresponding mount point for a custom builder. The specified secret must be assigned to the service account that will run the build.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
secretSource | a reference to a secret | true | ||
mountPath | path within the container at which the secret should be mounted | true | string |
2.3.40. 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://releases.k8s.io/HEAD/docs/design/resources.md#resource-specifications | false | ||
requests | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: http://releases.k8s.io/HEAD/docs/design/resources.md#resource-specifications | false |
2.3.41. v1.ClusterNetworkList
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
items | list of cluster networks | true |
2.3.42. v1.ImageList
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
items | list of image objects | true |
2.3.43. unversioned.Patch
Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
2.3.44. v1.ImageStreamStatus
Name | Description | Required | Schema | Default |
---|---|---|---|---|
dockerImageRepository | represents the effective location this stream may be accessed at, may be empty until the server determines where the repository is located | true | string | |
tags | historical record of images associated with each tag, the first entry is the currently tagged image | false |
2.3.45. v1.TLSConfig
Name | Description | Required | Schema | Default |
---|---|---|---|---|
termination | indicates termination type. if not set, any termination config will be ignored | false | string | |
certificate | provides certificate contents | false | string | |
key | provides key file contents | false | string | |
caCertificate | provides the cert authority certificate contents | false | string | |
destinationCACertificate | provides the contents of the ca certificate of the final destination. When using re-encrypt termination this file should be provided in order to have routers use it for health checks on the secure connection | false | string | |
insecureEdgeTerminationPolicy | indicates desired behavior for insecure connections to an edge-terminated route (None, Allow or Redirect). If not set, insecure connections will not be allowed | false | string |
2.3.46. v1.Role
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
rules | all the rules for this role | true |
2.3.47. v1.ClusterRoleBinding
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
userNames | all user names directly bound to the role | true | string array | |
groupNames | all the groups directly bound to the role | true | string array | |
subjects | references to subjects bound to the role. Only User, Group, SystemUser, SystemGroup, and ServiceAccount are allowed. | true | ||
roleRef | reference to the policy role | true |
2.3.48. v1.OAuthClientList
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
items | list of oauth clients | true |
2.3.49. 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.50. v1.ClusterNetwork
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
network | CIDR string to specify the global overlay network’s L3 space | true | string | |
hostsubnetlength | number of bits to allocate to each host’s subnet e.g. 8 would mean a /24 network on the host | true | integer (int32) | |
serviceNetwork | CIDR string to specify the service network | true | string |
2.3.51. 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://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims | true | string | |
readOnly | Will force the ReadOnly setting in VolumeMounts. Default false. | false | boolean | false |
2.3.52. v1.ImageStreamTag
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
image | the image associated with the ImageStream and tag | true |
2.3.53. v1.SubjectAccessReview
TypeMeta describes an individual object in an API response or request with strings representing the type of the object and its API schema version. Structures that are versioned or persisted should inline TypeMeta.
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 | |
namespace | namespace of the action being requested | true | string | |
verb | one of get, list, watch, create, update, delete | true | string | |
resource | one of the existing resource types | true | string | |
resourceName | name of the resource being requested for a get or delete | true | string | |
content | actual content of the request for create and update | false | string | |
user | optional, if both user and groups are empty, the current authenticated user is used | true | string | |
groups | optional, list of groups to which the user belongs | true | string array |
2.3.54. v1.BuildStrategy
Name | Description | Required | Schema | Default |
---|---|---|---|---|
type | identifies the type of build strategy | true | string | |
dockerStrategy | holds parameters for the Docker build strategy | false | ||
sourceStrategy | holds parameters to the Source build strategy | false | ||
customStrategy | holds parameters to the Custom build strategy | false |
2.3.55. v1.DeploymentConfigList
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
items | a list of deployment configs | true |
2.3.56. v1.Group
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
users | list of users in this group | true | string array |
2.3.57. v1.OAuthAuthorizeTokenList
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
items | list of oauth authorization tokens | true |
2.3.58. v1.TemplateList
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
items | list of templates | true |
2.3.59. v1.ProjectStatus
Name | Description | Required | Schema | Default |
---|---|---|---|---|
phase | phase is the current lifecycle phase of the project | false | string |
2.3.60. 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 | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
spec | holds all the input necessary to produce a new build, and the conditions when to trigger them | true | ||
status | holds any relevant information about a build config derived by the system | true |
2.3.61. v1.Handler
Handler defines a specific action that should be taken
Name | Description | Required | Schema | Default |
---|---|---|---|---|
exec | One and only one of the following should be specified. Exec specifies the action to take. | false | ||
httpGet | HTTPGet specifies the http request to perform. | false | ||
tcpSocket | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported | false |
2.3.62. v1.FCVolumeSource
A Fibre Channel Disk can only be mounted as read/write once.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
targetWWNs | Required: FC target world wide names (WWNs) | true | string array | |
lun | Required: FC target lun number | true | integer (int32) | |
fsType | Required: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs" | true | string | |
readOnly | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. | false | boolean | false |
2.3.63. v1.DownwardAPIVolumeFile
DownwardAPIVolumeFile represents a single file containing information from the downward API
Name | Description | Required | Schema | Default |
---|---|---|---|---|
path | Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' | true | string | |
fieldRef | Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. | true |
2.3.64. v1.Container
A single application container that you want to run within a pod.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
name | Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. | true | string | |
image | Docker image name. More info: http://releases.k8s.io/HEAD/docs/user-guide/images.md | false | string | |
command | Entrypoint array. Not executed within a shell. The docker image’s entrypoint is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double , ie: (VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/containers.md#containers-and-commands | false | string array | |
args | Arguments to the entrypoint. The docker image’s cmd is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double , ie: (VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/containers.md#containers-and-commands | false | string array | |
workingDir | Container’s working directory. Defaults to Docker’s default. D efaults to image’s default. Cannot be updated. | false | string | |
ports | List of ports to expose from the container. Cannot be updated. | false | ||
env | List of environment variables to set in the container. Cannot be updated. | false | ||
resources | Compute Resources required by this container. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#resources | false | ||
volumeMounts | Pod volumes to mount into the container’s filesyste. Cannot be updated. | false | ||
livenessProbe | Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes | false | ||
readinessProbe | Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes | false | ||
lifecycle | Actions that the management system should take in response to container lifecycle events. Cannot be updated. | false | ||
terminationMessagePath | Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Defaults to /dev/termination-log. Cannot be updated. | false | string | |
imagePullPolicy | Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/images.md#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 | ||
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 | false |
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 | false |
tty | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. | false | boolean | false |
2.3.65. v1.SourceControlUser
Name | Description | Required | Schema | Default |
---|---|---|---|---|
name | name of the source control user | false | string | |
| e-mail of the source control user | false | string |
2.3.66. v1.MetadataFile
Name | Description | Required | Schema | Default |
---|---|---|---|---|
name | the name of the file to be created | true | string | |
fieldRef | selects a field of the pod. Supported fields: metadata.annotations, metadata.labels, metadata.name, metadata.namespace | true |
2.3.67. v1.PodSpec
PodSpec is a description of a pod.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
volumes | List of volumes that can be mounted by containers belonging to the pod. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md | false | ||
containers | List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/containers.md | true | ||
restartPolicy | Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#restartpolicy | false | string | |
terminationGracePeriodSeconds | Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. | false | integer (int64) | |
activeDeadlineSeconds | Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. | false | integer (int64) | |
dnsPolicy | Set DNS policy for containers within the pod. One of 'ClusterFirst' or 'Default'. Defaults to "ClusterFirst". | false | string | |
nodeSelector | NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: http://releases.k8s.io/HEAD/docs/user-guide/node-selection/README.md | false | ||
host | deprecated, use nodeName instead | false | string | |
serviceAccountName | ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: http://releases.k8s.io/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 | false |
hostPID | Use the host’s pid namespace. Optional: Default to false. | false | boolean | false |
hostIPC | Use the host’s ipc namespace. Optional: Default to false. | false | boolean | false |
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 | ||
imagePullSecrets | ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: http://releases.k8s.io/HEAD/docs/user-guide/images.md#specifying-imagepullsecrets-on-a-pod | false |
2.3.68. v1.FlockerVolumeSource
FlockerVolumeSource represents a Flocker volume mounted by the Flocker agent.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
datasetName | Required: the volume name. This is going to be store on metadata → name on the payload for Flocker | true | string |
2.3.69. v1.OAuthClientAuthorization
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
clientName | references the client that created this authorization | false | string | |
userName | user name that authorized this client | false | string | |
userUID | unique UID associated with this authorization. userUID and userName must both match for this authorization to be valid | false | string | |
scopes | list of granted scopes | false | string array |
2.3.70. v1.RBDVolumeSource
RBDVolumeSource represents a Rados Block Device Mount that lasts the lifetime of a pod
Name | Description | Required | Schema | Default |
---|---|---|---|---|
monitors | A collection of Ceph monitors. More info: http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it | true | string array | |
image | The rados image name. More info: http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it | true | string | |
fsType | Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#rbd | false | string | |
pool | The rados pool name. Default is rbd. More info: http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it. | true | string | |
user | The rados user name. Default is admin. More info: http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it | true | string | |
keyring | Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it | true | string | |
secretRef | SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is empty. More info: http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it | true | ||
readOnly | ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it | false | boolean | false |
2.3.71. v1.RollingDeploymentStrategyParams
Name | Description | Required | Schema | Default |
---|---|---|---|---|
updatePeriodSeconds | the time to wait between individual pod updates | false | integer (int64) | |
intervalSeconds | the time to wait between polling deployment status after update | false | integer (int64) | |
timeoutSeconds | the time to wait for updates before giving up | false | integer (int64) | |
maxUnavailable | max number of pods that can be unavailable during the update; value can be an absolute number or a percentage of total pods at start of update | false | string | |
maxSurge | max number of pods that can be scheduled above the original number of pods; value can be an absolute number or a percentage of total pods at start of update | false | string | |
updatePercent | the percentage of replicas to scale up or down each interval (negative value switches scale order to down/up instead of up/down) | false | integer (int32) | |
pre | a hook executed before the strategy starts the deployment | false | ||
post | a hook executed after the strategy finishes the deployment | false |
2.3.72. v1.ImageStreamSpec
Name | Description | Required | Schema | Default |
---|---|---|---|---|
dockerImageRepository | optional field if specified this stream is backed by a Docker repository on this server | false | string | |
tags | map arbitrary string values to specific image locators | false |
2.3.73. v1.BuildLog
TypeMeta describes an individual object in an API response or request with strings representing the type of the object and its API schema version. Structures that are versioned or persisted should inline TypeMeta.
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.74. v1.DeploymentConfigRollback
TypeMeta describes an individual object in an API response or request with strings representing the type of the object and its API schema version. Structures that are versioned or persisted should inline TypeMeta.
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 | |
spec | options for rollback generation | true |
2.3.75. 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 | Default |
---|---|---|---|---|
capabilities | The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. | false | ||
privileged | Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. | false | boolean | false |
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 | ||
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 | false |
2.3.76. v1.NamedRole
Name | Description | Required | Schema | Default |
---|---|---|---|---|
name | name of the role | true | string | |
role | the role | true |
2.3.77. v1.Identity
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
providerName | source of identity information | true | string | |
providerUserName | uniquely represents this identity in the scope of the provider | true | string | |
user | reference to the user this identity is associated with. both name and uid must be set | true | ||
extra | extra information for this identity | false |
2.3.78. v1.UserIdentityMapping
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
identity | reference to an identity | false | ||
user | reference to a user | false |
2.3.79. v1.Template
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
objects | list of objects to include in the template | true | ||
parameters | optional: list of parameters used during template to config transformation | false | ||
labels | optional: list of lables that are applied to every object during the template to config transformation | false |
2.3.80. v1.GCEPersistentDiskVolumeSource
GCEPersistentDiskVolumeSource represents a Persistent Disk resource in Google Compute Engine.
A GCE PD must exist and be formatted 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.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
pdName | Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk | true | string | |
fsType | Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk | true | string | |
partition | The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk | false | integer (int32) | |
readOnly | ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk | false | boolean | false |
2.3.81. v1.DeploymentConfigSpec
Name | Description | Required | Schema | Default |
---|---|---|---|---|
strategy | how a deployment is executed | true | ||
triggers | how new deployments are triggered | true | ||
replicas | the desired number of replicas | true | integer (int32) | |
selector | a label query over pods that should match the replicas count | true | ||
template | describes the pod that will be created if insufficient replicas are detected; takes precedence over a template reference | false |
2.3.82. v1.ClusterPolicy
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
lastModified | last time any part of the object was created, updated, or deleted | true | string | |
roles | all the roles held by this policy, mapped by role name | true |
2.3.83. v1.EnvVarSource
EnvVarSource represents a source for the value of an EnvVar.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
fieldRef | Selects a field of the pod. Only name and namespace are supported. | true |
2.3.84. v1.UserList
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
items | list of users | true |
2.3.85. v1.LifecycleHook
Name | Description | Required | Schema | Default |
---|---|---|---|---|
failurePolicy | what action to take if the hook fails | true | string | |
execNewPod | options for an ExecNewPodHook | false |
2.3.86. 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.87. v1.GitSourceRevision
Name | Description | Required | Schema | Default |
---|---|---|---|---|
commit | hash identifying a specific commit | false | string | |
author | author of a specific commit | false | ||
committer | committer of a specific commit | false | ||
message | description of a specific commit | false | string |
2.3.88. v1.PolicyRule
Name | Description | Required | Schema | Default |
---|---|---|---|---|
verbs | list of verbs that apply to ALL the resourceKinds and attributeRestrictions contained in this rule. The verb * represents all kinds. | true | string array | |
attributeRestrictions | vary depending on what the authorizer supports. If the authorizer does not recognize how to handle the specified value, it should report an error. | false | string | |
apiGroups | list of API groups this rule applies to. * represents all API groups. | true | string array | |
resources | list of resources this rule applies to. * represents all resources. | true | string array | |
resourceNames | optional white list of names that the rule applies to. An empty set means that everything is allowed. | false | string array | |
nonResourceURLs | set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path. | false | string array |
2.3.89. integer
2.3.90. v1.VolumeMount
VolumeMount describes a mounting of a Volume within a container.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
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 | false |
mountPath | Path within the container at which the volume should be mounted. | true | string |
2.3.91. v1.DeploymentCause
Name | Description | Required | Schema | Default |
---|---|---|---|---|
type | the type of trigger that resulted in a new deployment | true | string | |
imageTrigger | image trigger details (if applicable) | false |
2.3.92. v1.NamedTagReference
Name | Description | Required | Schema | Default |
---|---|---|---|---|
name | name of tag | true | string | |
annotations | annotations associated with images using this tag | false | ||
from | a reference to an image stream tag or image stream this tag should track | false | ||
reference | if true consider this tag a reference only and do not attempt to import metadata about the image | false | boolean | false |
2.3.93. v1.OAuthClient
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
secret | unique secret associated with a client | false | string | |
respondWithChallenges | indicates whether the client wants authentication needed responses made in the form of challenges instead of redirects | false | boolean | false |
redirectURIs | valid redirection URIs associated with a client | false | string array |
2.3.94. v1.ImageStreamList
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
items | list of image stream objects | true |
2.3.95. v1.DeploymentCauseImageTrigger
Name | Description | Required | Schema | Default |
---|---|---|---|---|
from | a reference the changed object which triggered a deployment | true |
2.3.96. 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 | Default |
---|---|---|---|---|
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 | ||
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 | false |
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 | ||
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: | false | integer (int64) |
2.3.97. v1.IdentityList
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
items | list of identities | true |
2.3.98. 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.99. v1.Image
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
dockerImageReference | string that can be used to pull this image | false | string | |
dockerImageMetadata | metadata about this image | false | string | |
dockerImageMetadataVersion | conveys version of the object, if empty defaults to '1.0' | false | string | |
dockerImageManifest | raw JSON of the manifest | false | string |
2.3.100. v1.ImageStreamImage
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
image | the image associated with the ImageStream and image name | true |
2.3.101. v1.RouteSpec
Name | Description | Required | Schema | Default |
---|---|---|---|---|
host | optional: alias/dns that points to the service, must follow DNS 952 subdomain conventions | true | string | |
path | optional: path that the router watches to route traffic to the service | false | string | |
to | an object the route points to. only the service kind is allowed, and it will be defaulted to a service. | true | ||
port | port that should be used by the router; this is a hint to control which pod endpoint port is used; if empty routers may use all endpoints and ports | false | ||
tls | provides the ability to configure certificates and termination for the route | false |
2.3.102. v1.BuildList
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
items | list of builds | true |
2.3.103. v1.RecreateDeploymentStrategyParams
Name | Description | Required | Schema | Default |
---|---|---|---|---|
pre | a hook executed before the strategy starts the deployment | false | ||
post | a hook executed after the strategy finishes the deployment | false |
2.3.104. v1.EmptyDirVolumeSource
EmptyDirVolumeSource is temporary directory that shares a pod’s lifetime.
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://releases.k8s.io/HEAD/docs/user-guide/volumes.md#emptydir | false | string |
2.3.105. v1.BuildSource
Name | Description | Required | Schema | Default |
---|---|---|---|---|
type | type of build input to accept | true | string | |
binary | the binary will be provided by the builder as an archive or file to be placed within the input directory; allows Dockerfile to be optionally set; may not be set with git source type also set | false | ||
dockerfile | the contents of a Dockerfile to build; FROM may be overridden by your strategy source, and additional ENV from your strategy will be placed before the rest of the Dockerfile stanzas | false | string | |
git | optional information about git build source | false | ||
contextDir | specifies sub-directory where the source code for the application exists, allows for sources to be built from a directory other than the root of a repository | false | string | |
sourceSecret | supported auth methods are: ssh-privatekey | false |
2.3.106. v1.HTTPGetAction
HTTPGetAction describes an action based on HTTP Get requests.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
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. | false | string | |
scheme | Scheme to use for connecting to the host. Defaults to HTTP. | false | string |
2.3.107. v1.WebHookTrigger
Name | Description | Required | Schema | Default |
---|---|---|---|---|
secret | secret used to validate requests | false | string |
2.3.108. v1.DeploymentDetails
Name | Description | Required | Schema | Default |
---|---|---|---|---|
message | a user specified change message | false | string | |
causes | extended data associated with all the causes for creating a new deployment | false |
2.3.109. v1.Probe
Probe describes a liveness probe to be examined to the container.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
exec | One and only one of the following should be specified. Exec specifies the action to take. | false | ||
httpGet | HTTPGet specifies the http request to perform. | false | ||
tcpSocket | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported | false | ||
initialDelaySeconds | Number of seconds after the container has started before liveness probes are initiated. More info: http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes | false | integer (int64) | |
timeoutSeconds | Number of seconds after which liveness probes timeout. Defaults to 1 second. More info: http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes | false | integer (int64) |
2.3.110. v1.NamedClusterRoleBinding
Name | Description | Required | Schema | Default |
---|---|---|---|---|
name | name of the cluster role binding | true | string | |
roleBinding | the cluster role binding | true |
2.3.111. v1.ISCSIVolumeSource
ISCSIVolumeSource describes an ISCSI Disk can only be mounted as read/write once.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
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) | |
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". More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#iscsi | true | string | |
readOnly | ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. | false | boolean | false |
2.3.112. v1.GitRepoVolumeSource
GitRepoVolumeSource represents a volume that is pulled from git when the pod is created.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
repository | Repository URL | true | string | |
revision | Commit hash for the specified revision. | true | string |
2.3.113. v1.ObjectMeta
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
name | Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names | false | string | |
generateName |
GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. | 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. | 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. | 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. | false | string | |
generation | A sequence number representing a specific generation of the desired state. Currently only implemented by replication controllers. 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. | false | string | |
deletionTimestamp |
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested. | false | string | |
deletionGracePeriodSeconds | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. | false | integer (int64) | |
labels | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://releases.k8s.io/HEAD/docs/user-guide/labels.md | false | ||
annotations | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://releases.k8s.io/HEAD/docs/user-guide/annotations.md | false |
2.3.114. 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.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
spec | spec defines the behavior of the Project | false | ||
status | status describes the current status of a Project; read-only | false |
2.3.115. v1.DeploymentConfigStatus
Name | Description | Required | Schema | Default |
---|---|---|---|---|
latestVersion | used to determine whether the current deployment is out of sync | false | integer (int32) | |
details | reasons for the last update to the config | false |
2.3.116. v1.NamedClusterRole
Name | Description | Required | Schema | Default |
---|---|---|---|---|
name | name of the cluster role | true | string | |
role | the cluster role | true |
2.3.117. 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://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names | false | string |
2.3.118. v1.OAuthAuthorizeToken
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
clientName | references the client that created this token | false | string | |
expiresIn | seconds from creation time before this token expires | false | integer (int64) | |
scopes | list of requested scopes | false | string array | |
redirectURI | redirection URI associated with the token | false | string | |
state | state data from request | false | string | |
userName | user name associated with this token | false | string | |
userUID | unique UID associated with this token. userUID and userName must both match for this token to be valid | false | string |
2.3.119. v1.BinaryBuildSource
Name | Description | Required | Schema | Default |
---|---|---|---|---|
asFile | indicate the provided binary should be considered a single file placed within the root of the input; must be a valid filename with no path segments | false | string |
2.3.120. v1.BuildSpec
Name | Description | Required | Schema | Default |
---|---|---|---|---|
serviceAccount | the name of the service account to use to run pods created by the build, pod will be allowed to use secrets referenced by the service account | false | string | |
source | describes the source control management system in use | false | ||
revision | specific revision in the source repository | false | ||
strategy | defines how to perform a build | true | ||
output | describes the output of a build that a strategy should produce | false | ||
resources | the desired compute resources the build should have | false | ||
completionDeadlineSeconds | optional duration in seconds the build may be active on a node before the system will actively try to mark it failed and kill associated containers; value must be a positive integer | false | integer (int64) |
2.3.121. v1.ClusterPolicyBindingList
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
items | list of cluster policy bindings | true |
2.3.122. v1.DeploymentConfigRollbackSpec
Name | Description | Required | Schema | Default |
---|---|---|---|---|
from | a reference to a deployment, which is a ReplicationController | true | ||
includeTriggers | whether to include old config triggers in the rollback | true | boolean | false |
includeTemplate | whether to include the old pod template spec in the rollback | true | boolean | false |
includeReplicationMeta | whether to include the replica count and replica selector in the rollback | true | boolean | false |
includeStrategy | whether to include the deployment strategy in the rollback | true | boolean | false |
2.3.123. v1.NamedTagEventList
Name | Description | Required | Schema | Default |
---|---|---|---|---|
tag | the tag | true | string | |
items | list of tag events related to the tag | true |
2.3.124. v1.ContainerPort
ContainerPort represents a network port in a single container.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
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.125. v1.NamedRoleBinding
Name | Description | Required | Schema | Default |
---|---|---|---|---|
name | name of the roleBinding | true | string | |
roleBinding | the roleBinding | true |
2.3.126. v1.DownwardAPIVolumeSource
DownwardAPIVolumeSource represents a volume containing downward API info
Name | Description | Required | Schema | Default |
---|---|---|---|---|
items | Items is a list of downward API volume file | false |
2.3.127. v1.CinderVolumeSource
CinderVolumeSource represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
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 | Required: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Only ext3 and ext4 are allowed 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 | false |
2.3.128. v1.SourceBuildStrategy
Name | Description | Required | Schema | Default |
---|---|---|---|---|
from | reference to an image stream, image stream tag, or image stream image from which the Docker image should be pulled | true | ||
pullSecret | supported type: dockercfg | false | ||
env | additional environment variables you want to pass into a builder container | false | ||
scripts | location of the source scripts | false | string | |
incremental | forces the source build to do incremental builds if true | false | boolean | false |
forcePull | forces the source build to pull the image if true | false | boolean | false |
2.3.129. v1.BuildConfigStatus
Name | Description | Required | Schema | Default |
---|---|---|---|---|
lastVersion | used to inform about number of last triggered build | true | integer (int32) |
2.3.130. v1.ExecNewPodHook
Name | Description | Required | Schema | Default |
---|---|---|---|---|
command | the hook command and its arguments | true | string array | |
env | environment variables provided to the hook container | false | ||
containerName | the name of a container from the pod template whose image will be used for the hook container | true | string | |
volumes | the names of volumes from the pod template which should be included in the hook pod; an empty list means no volumes will be copied, and names not found in the pod spec will be ignored | false | string array |
2.3.131. v1.SELinuxOptions
SELinuxOptions are the labels to be applied to the container
Name | Description | Required | Schema | Default |
---|---|---|---|---|
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.132. v1.ObjectReference
ObjectReference contains enough information to let you inspect or modify the referred object.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
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://releases.k8s.io/HEAD/docs/user-guide/namespaces.md | false | string | |
name | Name of the referent. More info: http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names | false | string | |
uid | UID of the referent. More info: http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#uids | false | string | |
apiVersion | API version of the referent. | false | string | |
resourceVersion | Specific resourceVersion to which this reference is made, if any. 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.133. v1.DockerBuildStrategy
Name | Description | Required | Schema | Default |
---|---|---|---|---|
from | reference to image stream, image stream tag, or image stream image from which docker image should be pulled, resulting image will be used in the FROM line for the Dockerfile for this build | false | ||
pullSecret | supported type: dockercfg | false | ||
noCache | if true, indicates that the Docker build must be executed with the --no-cache=true flag | false | boolean | false |
env | additional environment variables you want to pass into a builder container | false | ||
forcePull | forces the source build to pull the image if true | false | boolean | false |
dockerfilePath | path of the Dockerfile to use for building the Docker image, relative to the contextDir, if set | false | string |
2.3.134. v1.DeploymentTriggerPolicy
Name | Description | Required | Schema | Default |
---|---|---|---|---|
type | the type of the trigger | false | string | |
imageChangeParams | input to the ImageChange trigger | false |
2.3.135. v1.BuildOutput
Name | Description | Required | Schema | Default |
---|---|---|---|---|
to | The optional image stream to push the output of this build. The namespace may be empty, in which case, the image stream will be looked up based on the namespace of the build. | false | ||
pushSecret | supported type: dockercfg | false |
2.3.136. v1.ClusterRoleBindingList
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
items | list of cluster role bindings | true |
2.3.137. 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.138. v1.OAuthAccessTokenList
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
items | list of oauth access tokens | true |
2.3.139. 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://releases.k8s.io/HEAD/docs/user-guide/container-environment.md#hook-details | false | ||
preStop | PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: http://releases.k8s.io/HEAD/docs/user-guide/container-environment.md#hook-details | false |
2.3.140. v1.RoleList
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
items | list of roles | true |
2.3.141. v1.OAuthClientAuthorizationList
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
items | list of oauth client authorizations | true |
2.3.142. v1.RoleBinding
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
userNames | all the usernames directly bound to the role | true | string array | |
groupNames | all the groups directly bound to the role | true | string array | |
subjects | references to subjects bound to the role. Only User, Group, SystemUser, SystemGroup, and ServiceAccount are allowed. | true | ||
roleRef | a reference to a role | true |
2.3.143. v1.BuildConfigSpec
Name | Description | Required | Schema | Default |
---|---|---|---|---|
triggers | determines how new builds can be launched from a build config. if no triggers are defined, a new build can only occur as a result of an explicit client build creation. | true | ||
serviceAccount | the name of the service account to use to run pods created by the build, pod will be allowed to use secrets referenced by the service account | false | string | |
source | describes the source control management system in use | false | ||
revision | specific revision in the source repository | false | ||
strategy | defines how to perform a build | true | ||
output | describes the output of a build that a strategy should produce | false | ||
resources | the desired compute resources the build should have | false | ||
completionDeadlineSeconds | optional duration in seconds the build may be active on a node before the system will actively try to mark it failed and kill associated containers; value must be a positive integer | false | integer (int64) |
2.3.144. v1.ImageStreamMapping
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
image | a Docker image | true | ||
tag | string value this image can be located with inside the stream | true | string |
2.3.145. json.WatchEvent
Name | Description | Required | Schema | Default |
---|---|---|---|---|
type | the type of watch event; may be ADDED, MODIFIED, DELETED, or ERROR | false | string | |
object | the object being watched; will match the type of the resource endpoint or be a Status object if the type is ERROR | false | string |
2.3.146. v1.AWSElasticBlockStoreVolumeSource
Represents a persistent disk resource in AWS.
An Amazon Elastic Block Store (EBS) must already be created, formatted, and reside in the same AWS zone as the kubelet before it can be mounted. Note: Amazon EBS volumes can be mounted to only one instance at a time.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
volumeID | Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore | true | string | |
fsType | Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore | true | string | |
partition | The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). | false | integer (int32) | |
readOnly | Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore | false | boolean | false |
2.3.147. v1.ClusterPolicyList
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
items | list of cluster policies | true |
2.3.148. v1.LocalResourceAccessReview
Local Resource Access Reviews are objects that allow you to determine which users and groups can perform a given action in a given namespace.
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 | |
namespace | namespace of the action being requested | true | string | |
verb | one of get, list, watch, create, update, delete | true | string | |
resource | one of the existing resource types | true | string | |
resourceName | name of the resource being requested for a get or delete | true | string | |
content | actual content of the request for create and update | false | string |
2.3.149. v1.CustomBuildStrategy
Name | Description | Required | Schema | Default |
---|---|---|---|---|
from | reference to an image stream, image stream tag, or image stream image from which the Docker image should be pulled | true | ||
pullSecret | supported type: dockercfg | false | ||
env | additional environment variables you want to pass into a builder container | false | ||
exposeDockerSocket | allow running Docker commands (and build Docker images) from inside the container | false | boolean | false |
forcePull | forces pulling of builder image from remote registry if true | false | boolean | false |
secrets | a list of secrets to include in the build pod in addition to pull, push and source secrets | false |
2.3.150. v1.RoutePort
Name | Description | Required | Schema | Default |
---|---|---|---|---|
targetPort | the target port on the endpoints for the service; if this is a string must match the named port, if an integer, must match the port number | true | string |
2.3.151. v1.ProjectList
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
items | list of projects | true |
2.3.152. v1.CustomDeploymentStrategyParams
Name | Description | Required | Schema | Default |
---|---|---|---|---|
image | a Docker image which can carry out a deployment | false | string | |
environment | environment variables provided to the deployment process container | false | ||
command | optionally overrides the container command (default is specified by the image) | false | string array |
2.3.153. v1.ClusterRole
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
rules | list of policy rules | true |
2.3.154. 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.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
spec | desired state of the route | true | ||
status | current state of the route | true |
2.3.155. v1.ImageStream
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
spec | desired state of the stream | true | ||
status | current state of the stream as observed by the system | false |
2.3.156. runtime.RawExtension
this may be any JSON object with a 'kind' and 'apiVersion' field; and is preserved unmodified by processing
2.3.157. v1.ImageChangeTrigger
Name | Description | Required | Schema | Default |
---|---|---|---|---|
lastTriggeredImageID | used internally to save last used image ID for build | false | string | |
from | reference to an ImageStreamTag that will trigger the build | false |
2.3.158. v1.EnvVar
EnvVar represents an environment variable present in a Container.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
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 |
2.3.159. unversioned.StatusCause
StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
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. | false | string |
2.3.160. v1.Policy
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
lastModified | last time that any part of the policy was created, updated, or deleted | true | string | |
roles | roles held by this policy | true |
2.3.161. v1.PolicyBinding
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
lastModified | last time that any part of the object was created, updated, or deleted | true | string | |
policyRef | reference to the policy that contains all the Roles that this object’s roleBindings may reference | true | ||
roleBindings | all roleBindings held by this policyBinding | true |
2.3.162. v1.RouteList
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
items | list of routes | true |
2.3.163. v1.RoleBindingList
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
items | list of role bindings | true |
2.3.164. v1.TagEvent
Name | Description | Required | Schema | Default |
---|---|---|---|---|
created | when the event was created | true | string | |
dockerImageReference | the string that can be used to pull this image | true | string | |
image | the image | true | string |
2.3.165. v1.FinalizerName
2.3.166. v1.DeploymentStrategy
Name | Description | Required | Schema | Default |
---|---|---|---|---|
type | the name of a deployment strategy | false | string | |
customParams | input to the Custom deployment strategy | false | ||
recreateParams | input to the Recreate deployment strategy | false | ||
rollingParams | input to the Rolling deployment strategy | false | ||
resources | resource requirements to execute the deployment | false |
2.3.167. v1.ResourceAccessReview
TypeMeta describes an individual object in an API response or request with strings representing the type of the object and its API schema version. Structures that are versioned or persisted should inline TypeMeta.
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 | |
namespace | namespace of the action being requested | true | string | |
verb | one of get, list, watch, create, update, delete | true | string | |
resource | one of the existing resource types | true | string | |
resourceName | name of the resource being requested for a get or delete | true | string | |
content | actual content of the request for create and update | false | string |
2.3.168. v1.GlusterfsVolumeSource
GlusterfsVolumeSource represents a Glusterfs Mount that lasts the lifetime of a pod.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
endpoints | EndpointsName is the endpoint name that details Glusterfs topology. More info: http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod | true | string | |
path | Path is the Glusterfs volume path. More info: http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod | true | string | |
readOnly | ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod | false | boolean | false |
2.3.169. v1.ProjectSpec
Name | Description | Required | Schema | Default |
---|---|---|---|---|
finalizers | an opaque list of values that must be empty to permanently remove object from storage | false |
2.3.170. v1.DeploymentTriggerImageChangeParams
Name | Description | Required | Schema | Default |
---|---|---|---|---|
automatic | whether detection of a new tag value should trigger a deployment | false | boolean | false |
containerNames | restricts tag updates to a set of container names in the pod | false | string array | |
from | a reference to an ImageRepository, ImageStream, or ImageStreamTag to watch for changes | true | ||
lastTriggeredImage | the last image to be triggered | false | string |
2.3.171. any
Represents an untyped JSON map - see the description of the field for more info about the structure of this object.
Chapter 3. Kubernetes v1 REST API
3.1. Overview
The Kubernetes API allows you to run containerized applications, bind persistent storage, link those applications through service discovery, and manage the cluster infrastructure.
3.1.1. Version information
Version: v1
3.1.2. URI scheme
Host: 127.0.0.1:8443
BasePath: /
Schemes: HTTPS
3.2. Paths
3.2.1. get available resources
GET /api/v1
3.2.1.1. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
3.2.1.2. Consumes
- application/json
3.2.1.3. Produces
- application/json
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 |
3.2.2.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.2.3. Consumes
- /
3.2.2.4. Produces
- application/json
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 | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.3.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.3.3. Consumes
- /
3.2.3.4. Produces
- application/json
3.2.3.5. Tags
- apiv1
3.2.4. list or watch objects of kind Endpoints
GET /api/v1/endpoints
3.2.4.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.4.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.4.3. Consumes
- /
3.2.4.4. Produces
- application/json
3.2.4.5. Tags
- apiv1
3.2.5. create a Endpoints
POST /api/v1/endpoints
3.2.5.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
3.2.5.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.5.3. Consumes
- /
3.2.5.4. Produces
- application/json
3.2.5.5. Tags
- apiv1
3.2.6. list or watch objects of kind Event
GET /api/v1/events
3.2.6.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.6.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.6.3. Consumes
- /
3.2.6.4. Produces
- application/json
3.2.6.5. Tags
- apiv1
3.2.7. create a Event
POST /api/v1/events
3.2.7.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
3.2.7.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.7.3. Consumes
- /
3.2.7.4. Produces
- application/json
3.2.7.5. Tags
- apiv1
3.2.8. list or watch objects of kind LimitRange
GET /api/v1/limitranges
3.2.8.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.8.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.8.3. Consumes
- /
3.2.8.4. Produces
- application/json
3.2.8.5. Tags
- apiv1
3.2.9. create a LimitRange
POST /api/v1/limitranges
3.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 |
3.2.9.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.9.3. Consumes
- /
3.2.9.4. Produces
- application/json
3.2.9.5. Tags
- apiv1
3.2.10. list or watch objects of kind Namespace
GET /api/v1/namespaces
3.2.10.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.10.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.10.3. Consumes
- /
3.2.10.4. Produces
- application/json
3.2.10.5. Tags
- apiv1
3.2.11. create a Namespace
POST /api/v1/namespaces
3.2.11.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
3.2.11.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.11.3. Consumes
- /
3.2.11.4. Produces
- application/json
3.2.11.5. Tags
- apiv1
3.2.12. create a Binding
POST /api/v1/namespaces/{namespace}/bindings
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 | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.12.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.12.3. Consumes
- /
3.2.12.4. Produces
- application/json
3.2.12.5. Tags
- apiv1
3.2.13. list objects of kind ComponentStatus
GET /api/v1/namespaces/{namespace}/componentstatuses
3.2.13.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.13.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.13.3. Consumes
- /
3.2.13.4. Produces
- application/json
3.2.13.5. Tags
- apiv1
3.2.14. read the specified ComponentStatus
GET /api/v1/namespaces/{namespace}/componentstatuses/{name}
3.2.14.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the ComponentStatus | true | string |
3.2.14.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.14.3. Consumes
- /
3.2.14.4. Produces
- application/json
3.2.14.5. Tags
- apiv1
3.2.15. list or watch objects of kind Endpoints
GET /api/v1/namespaces/{namespace}/endpoints
3.2.15.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.15.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.15.3. Consumes
- /
3.2.15.4. Produces
- application/json
3.2.15.5. Tags
- apiv1
3.2.16. create a Endpoints
POST /api/v1/namespaces/{namespace}/endpoints
3.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 | |||
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 |
3.2.16.3. Consumes
- /
3.2.16.4. Produces
- application/json
3.2.16.5. Tags
- apiv1
3.2.17. read the specified Endpoints
GET /api/v1/namespaces/{namespace}/endpoints/{name}
3.2.17.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Endpoints | true | string |
3.2.17.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.17.3. Consumes
- /
3.2.17.4. Produces
- application/json
3.2.17.5. Tags
- apiv1
3.2.18. replace the specified Endpoints
PUT /api/v1/namespaces/{namespace}/endpoints/{name}
3.2.18.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Endpoints | true | string |
3.2.18.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.18.3. Consumes
- /
3.2.18.4. Produces
- application/json
3.2.18.5. Tags
- apiv1
3.2.19. delete a Endpoints
DELETE /api/v1/namespaces/{namespace}/endpoints/{name}
3.2.19.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Endpoints | true | string |
3.2.19.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.19.3. Consumes
- /
3.2.19.4. Produces
- application/json
3.2.19.5. Tags
- apiv1
3.2.20. partially update the specified Endpoints
PATCH /api/v1/namespaces/{namespace}/endpoints/{name}
3.2.20.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.20.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.20.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
3.2.20.4. Produces
- application/json
3.2.20.5. Tags
- apiv1
3.2.21. list or watch objects of kind Event
GET /api/v1/namespaces/{namespace}/events
3.2.21.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.21.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.21.3. Consumes
- /
3.2.21.4. Produces
- application/json
3.2.21.5. Tags
- apiv1
3.2.22. create a Event
POST /api/v1/namespaces/{namespace}/events
3.2.22.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.22.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.22.3. Consumes
- /
3.2.22.4. Produces
- application/json
3.2.22.5. Tags
- apiv1
3.2.23. read the specified Event
GET /api/v1/namespaces/{namespace}/events/{name}
3.2.23.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Event | true | string |
3.2.23.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.23.3. Consumes
- /
3.2.23.4. Produces
- application/json
3.2.23.5. Tags
- apiv1
3.2.24. replace the specified Event
PUT /api/v1/namespaces/{namespace}/events/{name}
3.2.24.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Event | true | string |
3.2.24.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.24.3. Consumes
- /
3.2.24.4. Produces
- application/json
3.2.24.5. Tags
- apiv1
3.2.25. delete a Event
DELETE /api/v1/namespaces/{namespace}/events/{name}
3.2.25.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Event | true | string |
3.2.25.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.25.3. Consumes
- /
3.2.25.4. Produces
- application/json
3.2.25.5. Tags
- apiv1
3.2.26. partially update the specified Event
PATCH /api/v1/namespaces/{namespace}/events/{name}
3.2.26.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.26.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.26.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
3.2.26.4. Produces
- application/json
3.2.26.5. Tags
- apiv1
3.2.27. list or watch objects of kind LimitRange
GET /api/v1/namespaces/{namespace}/limitranges
3.2.27.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.27.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.27.3. Consumes
- /
3.2.27.4. Produces
- application/json
3.2.27.5. Tags
- apiv1
3.2.28. create a LimitRange
POST /api/v1/namespaces/{namespace}/limitranges
3.2.28.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.28.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.28.3. Consumes
- /
3.2.28.4. Produces
- application/json
3.2.28.5. Tags
- apiv1
3.2.29. read the specified LimitRange
GET /api/v1/namespaces/{namespace}/limitranges/{name}
3.2.29.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the LimitRange | true | string |
3.2.29.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.29.3. Consumes
- /
3.2.29.4. Produces
- application/json
3.2.29.5. Tags
- apiv1
3.2.30. replace the specified LimitRange
PUT /api/v1/namespaces/{namespace}/limitranges/{name}
3.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 | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the LimitRange | true | string |
3.2.30.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.30.3. Consumes
- /
3.2.30.4. Produces
- application/json
3.2.30.5. Tags
- apiv1
3.2.31. delete a LimitRange
DELETE /api/v1/namespaces/{namespace}/limitranges/{name}
3.2.31.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the LimitRange | true | string |
3.2.31.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.31.3. Consumes
- /
3.2.31.4. Produces
- application/json
3.2.31.5. Tags
- apiv1
3.2.32. partially update the specified LimitRange
PATCH /api/v1/namespaces/{namespace}/limitranges/{name}
3.2.32.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.32.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.32.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
3.2.32.4. Produces
- application/json
3.2.32.5. Tags
- apiv1
3.2.33. list or watch objects of kind PersistentVolumeClaim
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims
3.2.33.1. Description
Persistent Volume Claims (PVC) represent a request to use a persistent volume (PV) with a pod. When creating a pod definition (or replication controller or deployment config) a developer may specify the amount of storage they need via a persistent volume reference. If an administrator has enabled and configured persistent volumes for use, they will be allocated on demand to pods that have similar requirements. Since volumes are created lazily, some pods may be scheduled to a node before their volume is assigned. The node will detect this situation and wait to start the pod until the volume is bound. Events will be generated (visible by using the describe
command on the pod) that indicate the pod is waiting for volumes.
3.2.33.2. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.33.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.33.4. Consumes
- /
3.2.33.5. Produces
- application/json
3.2.33.6. Tags
- apiv1
3.2.34. create a PersistentVolumeClaim
POST /api/v1/namespaces/{namespace}/persistentvolumeclaims
3.2.34.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.34.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.34.3. Consumes
- /
3.2.34.4. Produces
- application/json
3.2.34.5. Tags
- apiv1
3.2.35. read the specified PersistentVolumeClaim
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
3.2.35.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the PersistentVolumeClaim | true | string |
3.2.35.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.35.3. Consumes
- /
3.2.35.4. Produces
- application/json
3.2.35.5. Tags
- apiv1
3.2.36. replace the specified PersistentVolumeClaim
PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
3.2.36.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the PersistentVolumeClaim | true | string |
3.2.36.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.36.3. Consumes
- /
3.2.36.4. Produces
- application/json
3.2.36.5. Tags
- apiv1
3.2.37. delete a PersistentVolumeClaim
DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
3.2.37.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the PersistentVolumeClaim | true | string |
3.2.37.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.37.3. Consumes
- /
3.2.37.4. Produces
- application/json
3.2.37.5. Tags
- apiv1
3.2.38. partially update the specified PersistentVolumeClaim
PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
3.2.38.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the PersistentVolumeClaim | true | string |
3.2.38.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.38.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
3.2.38.4. Produces
- application/json
3.2.38.5. Tags
- apiv1
3.2.39. replace status of the specified PersistentVolumeClaim
PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
3.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 | |||
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.39.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.39.3. Consumes
- /
3.2.39.4. Produces
- application/json
3.2.39.5. Tags
- apiv1
3.2.40. list or watch objects of kind Pod
GET /api/v1/namespaces/{namespace}/pods
3.2.40.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.40.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.40.3. Consumes
- /
3.2.40.4. Produces
- application/json
3.2.40.5. Tags
- apiv1
3.2.41. create a Pod
POST /api/v1/namespaces/{namespace}/pods
3.2.41.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.41.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.41.3. Consumes
- /
3.2.41.4. Produces
- application/json
3.2.41.5. Tags
- apiv1
3.2.42. read the specified Pod
GET /api/v1/namespaces/{namespace}/pods/{name}
3.2.42.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Pod | true | string |
3.2.42.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.42.3. Consumes
- /
3.2.42.4. Produces
- application/json
3.2.42.5. Tags
- apiv1
3.2.43. replace the specified Pod
PUT /api/v1/namespaces/{namespace}/pods/{name}
3.2.43.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Pod | true | string |
3.2.43.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.43.3. Consumes
- /
3.2.43.4. Produces
- application/json
3.2.43.5. Tags
- apiv1
3.2.44. delete a Pod
DELETE /api/v1/namespaces/{namespace}/pods/{name}
3.2.44.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Pod | true | string |
3.2.44.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.44.3. Consumes
- /
3.2.44.4. Produces
- application/json
3.2.44.5. Tags
- apiv1
3.2.45. partially update the specified Pod
PATCH /api/v1/namespaces/{namespace}/pods/{name}
3.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 | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Pod | true | string |
3.2.45.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.45.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
3.2.45.4. Produces
- application/json
3.2.45.5. Tags
- apiv1
3.2.46. connect GET requests to attach of Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/attach
3.2.46.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | stdin | Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. | false | boolean | |
QueryParameter | stdout | Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. | false | boolean | |
QueryParameter | stderr | Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. | false | boolean | |
QueryParameter | tty | TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. | false | boolean | |
QueryParameter | container | The container in which to execute the command. Defaults to only container if there is only one container in the pod. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Pod | true | string |
3.2.46.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
3.2.46.3. Consumes
- /
3.2.46.4. Produces
- /
3.2.46.5. Tags
- apiv1
3.2.47. connect POST requests to attach of Pod
POST /api/v1/namespaces/{namespace}/pods/{name}/attach
3.2.47.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | stdin | Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. | false | boolean | |
QueryParameter | stdout | Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. | false | boolean | |
QueryParameter | stderr | Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. | false | boolean | |
QueryParameter | tty | TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. | false | boolean | |
QueryParameter | container | The container in which to execute the command. Defaults to only container if there is only one container in the pod. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Pod | true | string |
3.2.47.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
3.2.47.3. Consumes
- /
3.2.47.4. Produces
- /
3.2.47.5. Tags
- apiv1
3.2.48. create binding of a Binding
POST /api/v1/namespaces/{namespace}/pods/{name}/binding
3.2.48.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.48.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.48.3. Consumes
- /
3.2.48.4. Produces
- application/json
3.2.48.5. Tags
- apiv1
3.2.49. connect GET requests to exec of Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/exec
3.2.49.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | stdin | Redirect the standard input stream of the pod for this call. Defaults to false. | false | boolean | |
QueryParameter | stdout | Redirect the standard output stream of the pod for this call. Defaults to true. | false | boolean | |
QueryParameter | stderr | Redirect the standard error stream of the pod for this call. Defaults to true. | false | boolean | |
QueryParameter | tty | TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. | false | boolean | |
QueryParameter | container | Container in which to execute the command. Defaults to only container if there is only one container in the pod. | false | string | |
QueryParameter | command | Command is the remote command to execute. argv array. Not executed within a shell. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Pod | true | string |
3.2.49.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
3.2.49.3. Consumes
- /
3.2.49.4. Produces
- /
3.2.49.5. Tags
- apiv1
3.2.50. connect POST requests to exec of Pod
POST /api/v1/namespaces/{namespace}/pods/{name}/exec
3.2.50.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | stdin | Redirect the standard input stream of the pod for this call. Defaults to false. | false | boolean | |
QueryParameter | stdout | Redirect the standard output stream of the pod for this call. Defaults to true. | false | boolean | |
QueryParameter | stderr | Redirect the standard error stream of the pod for this call. Defaults to true. | false | boolean | |
QueryParameter | tty | TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. | false | boolean | |
QueryParameter | container | Container in which to execute the command. Defaults to only container if there is only one container in the pod. | false | string | |
QueryParameter | command | Command is the remote command to execute. argv array. Not executed within a shell. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Pod | true | string |
3.2.50.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
3.2.50.3. Consumes
- /
3.2.50.4. Produces
- /
3.2.50.5. Tags
- apiv1
3.2.51. read log of the specified Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/log
3.2.51.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | container | The container for which to stream logs. Defaults to only container if there is one container in the pod. | false | string | |
QueryParameter | follow | Follow the log stream of the pod. Defaults to false. | false | boolean | |
QueryParameter | previous | Return previous terminated container logs. Defaults to false. | false | boolean | |
QueryParameter | sinceSeconds | A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. | false | ref | |
QueryParameter | sinceTime | An RFC3339 timestamp from which to show logs. If this value preceeds the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. | false | string | |
QueryParameter | timestamps | If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. | false | boolean | |
QueryParameter | tailLines | If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime | false | ref | |
QueryParameter | limitBytes | If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. | false | ref | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Pod | true | string |
3.2.51.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.51.3. Consumes
- /
3.2.51.4. Produces
- application/json
3.2.51.5. Tags
- apiv1
3.2.52. connect GET requests to portforward of Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/portforward
3.2.52.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.52.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
3.2.52.3. Consumes
- /
3.2.52.4. Produces
- /
3.2.52.5. Tags
- apiv1
3.2.53. connect POST requests to portforward of Pod
POST /api/v1/namespaces/{namespace}/pods/{name}/portforward
3.2.53.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.53.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
3.2.53.3. Consumes
- /
3.2.53.4. Produces
- /
3.2.53.5. Tags
- apiv1
3.2.54. connect GET requests to proxy of Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/proxy
3.2.54.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | path | Path is the URL path to use for the current proxy request to pod. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Pod | true | string |
3.2.54.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
3.2.54.3. Consumes
- /
3.2.54.4. Produces
- /
3.2.54.5. Tags
- apiv1
3.2.55. connect PUT requests to proxy of Pod
PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy
3.2.55.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | path | Path is the URL path to use for the current proxy request to pod. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Pod | true | string |
3.2.55.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
3.2.55.3. Consumes
- /
3.2.55.4. Produces
- /
3.2.55.5. Tags
- apiv1
3.2.56. connect DELETE requests to proxy of Pod
DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy
3.2.56.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | path | Path is the URL path to use for the current proxy request to pod. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Pod | true | string |
3.2.56.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
3.2.56.3. Consumes
- /
3.2.56.4. Produces
- /
3.2.56.5. Tags
- apiv1
3.2.57. connect POST requests to proxy of Pod
POST /api/v1/namespaces/{namespace}/pods/{name}/proxy
3.2.57.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | path | Path is the URL path to use for the current proxy request to pod. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Pod | true | string |
3.2.57.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
3.2.57.3. Consumes
- /
3.2.57.4. Produces
- /
3.2.57.5. Tags
- apiv1
3.2.58. connect GET requests to proxy of Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path:*}
3.2.58.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | path | Path is the URL path to use for the current proxy request to pod. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Pod | true | string | |
PathParameter | path | path to the resource | true | string |
3.2.58.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
3.2.58.3. Consumes
- /
3.2.58.4. Produces
- /
3.2.58.5. Tags
- apiv1
3.2.59. connect PUT requests to proxy of Pod
PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path:*}
3.2.59.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | path | Path is the URL path to use for the current proxy request to pod. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Pod | true | string | |
PathParameter | path | path to the resource | true | string |
3.2.59.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
3.2.59.3. Consumes
- /
3.2.59.4. Produces
- /
3.2.59.5. Tags
- apiv1
3.2.60. connect DELETE requests to proxy of Pod
DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path:*}
3.2.60.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | path | Path is the URL path to use for the current proxy request to pod. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Pod | true | string | |
PathParameter | path | path to the resource | true | string |
3.2.60.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
3.2.60.3. Consumes
- /
3.2.60.4. Produces
- /
3.2.60.5. Tags
- apiv1
3.2.61. connect POST requests to proxy of Pod
POST /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path:*}
3.2.61.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | path | Path is the URL path to use for the current proxy request to pod. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Pod | true | string | |
PathParameter | path | path to the resource | true | string |
3.2.61.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
3.2.61.3. Consumes
- /
3.2.61.4. Produces
- /
3.2.61.5. Tags
- apiv1
3.2.62. replace status of the specified Pod
PUT /api/v1/namespaces/{namespace}/pods/{name}/status
3.2.62.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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 |
---|---|---|
200 | success |
3.2.62.3. Consumes
- /
3.2.62.4. Produces
- application/json
3.2.62.5. Tags
- apiv1
3.2.63. list or watch objects of kind PodTemplate
GET /api/v1/namespaces/{namespace}/podtemplates
3.2.63.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.63.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.63.3. Consumes
- /
3.2.63.4. Produces
- application/json
3.2.63.5. Tags
- apiv1
3.2.64. create a PodTemplate
POST /api/v1/namespaces/{namespace}/podtemplates
3.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 | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.64.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.64.3. Consumes
- /
3.2.64.4. Produces
- application/json
3.2.64.5. Tags
- apiv1
3.2.65. read the specified PodTemplate
GET /api/v1/namespaces/{namespace}/podtemplates/{name}
3.2.65.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the PodTemplate | true | string |
3.2.65.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.65.3. Consumes
- /
3.2.65.4. Produces
- application/json
3.2.65.5. Tags
- apiv1
3.2.66. replace the specified PodTemplate
PUT /api/v1/namespaces/{namespace}/podtemplates/{name}
3.2.66.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the PodTemplate | true | string |
3.2.66.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.66.3. Consumes
- /
3.2.66.4. Produces
- application/json
3.2.66.5. Tags
- apiv1
3.2.67. delete a PodTemplate
DELETE /api/v1/namespaces/{namespace}/podtemplates/{name}
3.2.67.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the PodTemplate | true | string |
3.2.67.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.67.3. Consumes
- /
3.2.67.4. Produces
- application/json
3.2.67.5. Tags
- apiv1
3.2.68. partially update the specified PodTemplate
PATCH /api/v1/namespaces/{namespace}/podtemplates/{name}
3.2.68.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.68.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.68.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
3.2.68.4. Produces
- application/json
3.2.68.5. Tags
- apiv1
3.2.69. list or watch objects of kind ReplicationController
GET /api/v1/namespaces/{namespace}/replicationcontrollers
3.2.69.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.69.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.69.3. Consumes
- /
3.2.69.4. Produces
- application/json
3.2.69.5. Tags
- apiv1
3.2.70. create a ReplicationController
POST /api/v1/namespaces/{namespace}/replicationcontrollers
3.2.70.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.70.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.70.3. Consumes
- /
3.2.70.4. Produces
- application/json
3.2.70.5. Tags
- apiv1
3.2.71. read the specified ReplicationController
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
3.2.71.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the ReplicationController | true | string |
3.2.71.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.71.3. Consumes
- /
3.2.71.4. Produces
- application/json
3.2.71.5. Tags
- apiv1
3.2.72. replace the specified ReplicationController
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
3.2.72.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the ReplicationController | true | string |
3.2.72.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.72.3. Consumes
- /
3.2.72.4. Produces
- application/json
3.2.72.5. Tags
- apiv1
3.2.73. delete a ReplicationController
DELETE /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
3.2.73.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the ReplicationController | true | string |
3.2.73.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.73.3. Consumes
- /
3.2.73.4. Produces
- application/json
3.2.73.5. Tags
- apiv1
3.2.74. partially update the specified ReplicationController
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
3.2.74.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.74.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.74.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
3.2.74.4. Produces
- application/json
3.2.74.5. Tags
- apiv1
3.2.75. replace status of the specified ReplicationController
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
3.2.75.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.75.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.75.3. Consumes
- /
3.2.75.4. Produces
- application/json
3.2.75.5. Tags
- apiv1
3.2.76. list or watch objects of kind ResourceQuota
GET /api/v1/namespaces/{namespace}/resourcequotas
3.2.76.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.76.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.76.3. Consumes
- /
3.2.76.4. Produces
- application/json
3.2.76.5. Tags
- apiv1
3.2.77. create a ResourceQuota
POST /api/v1/namespaces/{namespace}/resourcequotas
3.2.77.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.77.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.77.3. Consumes
- /
3.2.77.4. Produces
- application/json
3.2.77.5. Tags
- apiv1
3.2.78. read the specified ResourceQuota
GET /api/v1/namespaces/{namespace}/resourcequotas/{name}
3.2.78.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the ResourceQuota | true | string |
3.2.78.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.78.3. Consumes
- /
3.2.78.4. Produces
- application/json
3.2.78.5. Tags
- apiv1
3.2.79. replace the specified ResourceQuota
PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}
3.2.79.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the ResourceQuota | true | string |
3.2.79.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.79.3. Consumes
- /
3.2.79.4. Produces
- application/json
3.2.79.5. Tags
- apiv1
3.2.80. delete a ResourceQuota
DELETE /api/v1/namespaces/{namespace}/resourcequotas/{name}
3.2.80.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the ResourceQuota | true | string |
3.2.80.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.80.3. Consumes
- /
3.2.80.4. Produces
- application/json
3.2.80.5. Tags
- apiv1
3.2.81. partially update the specified ResourceQuota
PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}
3.2.81.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.81.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.81.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
3.2.81.4. Produces
- application/json
3.2.81.5. Tags
- apiv1
3.2.82. replace status of the specified ResourceQuota
PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
3.2.82.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.82.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.82.3. Consumes
- /
3.2.82.4. Produces
- application/json
3.2.82.5. Tags
- apiv1
3.2.83. list or watch objects of kind Secret
GET /api/v1/namespaces/{namespace}/secrets
3.2.83.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.83.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.83.3. Consumes
- /
3.2.83.4. Produces
- application/json
3.2.83.5. Tags
- apiv1
3.2.84. create a Secret
POST /api/v1/namespaces/{namespace}/secrets
3.2.84.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.84.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.84.3. Consumes
- /
3.2.84.4. Produces
- application/json
3.2.84.5. Tags
- apiv1
3.2.85. read the specified Secret
GET /api/v1/namespaces/{namespace}/secrets/{name}
3.2.85.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Secret | true | string |
3.2.85.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.85.3. Consumes
- /
3.2.85.4. Produces
- application/json
3.2.85.5. Tags
- apiv1
3.2.86. replace the specified Secret
PUT /api/v1/namespaces/{namespace}/secrets/{name}
3.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 | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Secret | true | string |
3.2.86.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.86.3. Consumes
- /
3.2.86.4. Produces
- application/json
3.2.86.5. Tags
- apiv1
3.2.87. delete a Secret
DELETE /api/v1/namespaces/{namespace}/secrets/{name}
3.2.87.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.87.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.87.3. Consumes
- /
3.2.87.4. Produces
- application/json
3.2.87.5. Tags
- apiv1
3.2.88. partially update the specified Secret
PATCH /api/v1/namespaces/{namespace}/secrets/{name}
3.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 | |||
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.88.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.88.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
3.2.88.4. Produces
- application/json
3.2.88.5. Tags
- apiv1
3.2.89. list or watch objects of kind ServiceAccount
GET /api/v1/namespaces/{namespace}/serviceaccounts
3.2.89.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.89.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.89.3. Consumes
- /
3.2.89.4. Produces
- application/json
3.2.89.5. Tags
- apiv1
3.2.90. create a ServiceAccount
POST /api/v1/namespaces/{namespace}/serviceaccounts
3.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 | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.90.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.90.3. Consumes
- /
3.2.90.4. Produces
- application/json
3.2.90.5. Tags
- apiv1
3.2.91. read the specified ServiceAccount
GET /api/v1/namespaces/{namespace}/serviceaccounts/{name}
3.2.91.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the ServiceAccount | true | string |
3.2.91.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.91.3. Consumes
- /
3.2.91.4. Produces
- application/json
3.2.91.5. Tags
- apiv1
3.2.92. replace the specified ServiceAccount
PUT /api/v1/namespaces/{namespace}/serviceaccounts/{name}
3.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 | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the ServiceAccount | true | string |
3.2.92.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.92.3. Consumes
- /
3.2.92.4. Produces
- application/json
3.2.92.5. Tags
- apiv1
3.2.93. delete a ServiceAccount
DELETE /api/v1/namespaces/{namespace}/serviceaccounts/{name}
3.2.93.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.93.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.93.3. Consumes
- /
3.2.93.4. Produces
- application/json
3.2.93.5. Tags
- apiv1
3.2.94. partially update the specified ServiceAccount
PATCH /api/v1/namespaces/{namespace}/serviceaccounts/{name}
3.2.94.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.94.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.94.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
3.2.94.4. Produces
- application/json
3.2.94.5. Tags
- apiv1
3.2.95. list or watch objects of kind Service
GET /api/v1/namespaces/{namespace}/services
3.2.95.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.95.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.95.3. Consumes
- /
3.2.95.4. Produces
- application/json
3.2.95.5. Tags
- apiv1
3.2.96. create a Service
POST /api/v1/namespaces/{namespace}/services
3.2.96.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.96.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.96.3. Consumes
- /
3.2.96.4. Produces
- application/json
3.2.96.5. Tags
- apiv1
3.2.97. read the specified Service
GET /api/v1/namespaces/{namespace}/services/{name}
3.2.97.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Service | true | string |
3.2.97.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.97.3. Consumes
- /
3.2.97.4. Produces
- application/json
3.2.97.5. Tags
- apiv1
3.2.98. replace the specified Service
PUT /api/v1/namespaces/{namespace}/services/{name}
3.2.98.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Service | true | string |
3.2.98.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.98.3. Consumes
- /
3.2.98.4. Produces
- application/json
3.2.98.5. Tags
- apiv1
3.2.99. delete a Service
DELETE /api/v1/namespaces/{namespace}/services/{name}
3.2.99.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Service | true | string |
3.2.99.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.99.3. Consumes
- /
3.2.99.4. Produces
- application/json
3.2.99.5. Tags
- apiv1
3.2.100. partially update the specified Service
PATCH /api/v1/namespaces/{namespace}/services/{name}
3.2.100.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
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.100.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.100.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
3.2.100.4. Produces
- application/json
3.2.100.5. Tags
- apiv1
3.2.101. read the specified Namespace
GET /api/v1/namespaces/{name}
3.2.101.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.101.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.101.3. Consumes
- /
3.2.101.4. Produces
- application/json
3.2.101.5. Tags
- apiv1
3.2.102. replace the specified Namespace
PUT /api/v1/namespaces/{name}
3.2.102.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the Namespace | true | string |
3.2.102.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.102.3. Consumes
- /
3.2.102.4. Produces
- application/json
3.2.102.5. Tags
- apiv1
3.2.103. delete a Namespace
DELETE /api/v1/namespaces/{name}
3.2.103.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the Namespace | true | string |
3.2.103.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.103.3. Consumes
- /
3.2.103.4. Produces
- application/json
3.2.103.5. Tags
- apiv1
3.2.104. partially update the specified Namespace
PATCH /api/v1/namespaces/{name}
3.2.104.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the Namespace | true | string |
3.2.104.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.104.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
3.2.104.4. Produces
- application/json
3.2.104.5. Tags
- apiv1
3.2.105. replace finalize of the specified Namespace
PUT /api/v1/namespaces/{name}/finalize
3.2.105.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the Namespace | true | string |
3.2.105.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.105.3. Consumes
- /
3.2.105.4. Produces
- application/json
3.2.105.5. Tags
- apiv1
3.2.106. replace status of the specified Namespace
PUT /api/v1/namespaces/{name}/status
3.2.106.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the Namespace | true | string |
3.2.106.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.106.3. Consumes
- /
3.2.106.4. Produces
- application/json
3.2.106.5. Tags
- apiv1
3.2.107. list or watch objects of kind Node
GET /api/v1/nodes
3.2.107.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.107.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.107.3. Consumes
- /
3.2.107.4. Produces
- application/json
3.2.107.5. Tags
- apiv1
3.2.108. create a Node
POST /api/v1/nodes
3.2.108.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
3.2.108.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.108.3. Consumes
- /
3.2.108.4. Produces
- application/json
3.2.108.5. Tags
- apiv1
3.2.109. read the specified Node
GET /api/v1/nodes/{name}
3.2.109.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.109.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.109.3. Consumes
- /
3.2.109.4. Produces
- application/json
3.2.109.5. Tags
- apiv1
3.2.110. replace the specified Node
PUT /api/v1/nodes/{name}
3.2.110.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the Node | true | string |
3.2.110.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.110.3. Consumes
- /
3.2.110.4. Produces
- application/json
3.2.110.5. Tags
- apiv1
3.2.111. delete a Node
DELETE /api/v1/nodes/{name}
3.2.111.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the Node | true | string |
3.2.111.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.111.3. Consumes
- /
3.2.111.4. Produces
- application/json
3.2.111.5. Tags
- apiv1
3.2.112. partially update the specified Node
PATCH /api/v1/nodes/{name}
3.2.112.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the Node | true | string |
3.2.112.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
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
3.2.112.5. Tags
- apiv1
3.2.113. replace status of the specified Node
PUT /api/v1/nodes/{name}/status
3.2.113.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the Node | true | string |
3.2.113.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.113.3. Consumes
- /
3.2.113.4. Produces
- application/json
3.2.113.5. Tags
- apiv1
3.2.114. list or watch objects of kind PersistentVolumeClaim
GET /api/v1/persistentvolumeclaims
3.2.114.1. Description
Persistent Volume Claims (PVC) represent a request to use a persistent volume (PV) with a pod. When creating a pod definition (or replication controller or deployment config) a developer may specify the amount of storage they need via a persistent volume reference. If an administrator has enabled and configured persistent volumes for use, they will be allocated on demand to pods that have similar requirements. Since volumes are created lazily, some pods may be scheduled to a node before their volume is assigned. The node will detect this situation and wait to start the pod until the volume is bound. Events will be generated (visible by using the describe
command on the pod) that indicate the pod is waiting for volumes.
3.2.114.2. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.114.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.114.4. Consumes
- /
3.2.114.5. Produces
- application/json
3.2.114.6. Tags
- apiv1
3.2.115. create a PersistentVolumeClaim
POST /api/v1/persistentvolumeclaims
3.2.115.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
3.2.115.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.115.3. Consumes
- /
3.2.115.4. Produces
- application/json
3.2.115.5. Tags
- apiv1
3.2.116. list or watch objects of kind PersistentVolume
GET /api/v1/persistentvolumes
3.2.116.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.116.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.116.3. Consumes
- /
3.2.116.4. Produces
- application/json
3.2.116.5. Tags
- apiv1
3.2.117. create a PersistentVolume
POST /api/v1/persistentvolumes
3.2.117.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
3.2.117.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.117.3. Consumes
- /
3.2.117.4. Produces
- application/json
3.2.117.5. Tags
- apiv1
3.2.118. read the specified PersistentVolume
GET /api/v1/persistentvolumes/{name}
3.2.118.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.118.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.118.3. Consumes
- /
3.2.118.4. Produces
- application/json
3.2.118.5. Tags
- apiv1
3.2.119. replace the specified PersistentVolume
PUT /api/v1/persistentvolumes/{name}
3.2.119.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the PersistentVolume | true | string |
3.2.119.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.119.3. Consumes
- /
3.2.119.4. Produces
- application/json
3.2.119.5. Tags
- apiv1
3.2.120. delete a PersistentVolume
DELETE /api/v1/persistentvolumes/{name}
3.2.120.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the PersistentVolume | true | string |
3.2.120.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.120.3. Consumes
- /
3.2.120.4. Produces
- application/json
3.2.120.5. Tags
- apiv1
3.2.121. partially update the specified PersistentVolume
PATCH /api/v1/persistentvolumes/{name}
3.2.121.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the PersistentVolume | true | string |
3.2.121.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.121.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
3.2.121.4. Produces
- application/json
3.2.121.5. Tags
- apiv1
3.2.122. replace status of the specified PersistentVolume
PUT /api/v1/persistentvolumes/{name}/status
3.2.122.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the PersistentVolume | true | string |
3.2.122.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.122.3. Consumes
- /
3.2.122.4. Produces
- application/json
3.2.122.5. Tags
- apiv1
3.2.123. list or watch objects of kind Pod
GET /api/v1/pods
3.2.123.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.123.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.123.3. Consumes
- /
3.2.123.4. Produces
- application/json
3.2.123.5. Tags
- apiv1
3.2.124. create a Pod
POST /api/v1/pods
3.2.124.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
3.2.124.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.124.3. Consumes
- /
3.2.124.4. Produces
- application/json
3.2.124.5. Tags
- apiv1
3.2.125. list or watch objects of kind PodTemplate
GET /api/v1/podtemplates
3.2.125.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.125.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.125.3. Consumes
- /
3.2.125.4. Produces
- application/json
3.2.125.5. Tags
- apiv1
3.2.126. create a PodTemplate
POST /api/v1/podtemplates
3.2.126.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
3.2.126.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.126.3. Consumes
- /
3.2.126.4. Produces
- application/json
3.2.126.5. Tags
- apiv1
3.2.127. proxy GET requests to Pod
GET /api/v1/proxy/namespaces/{namespace}/pods/{name}
3.2.127.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.127.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
3.2.127.3. Consumes
- /
3.2.127.4. Produces
- /
3.2.127.5. Tags
- apiv1
3.2.128. proxy PUT requests to Pod
PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}
3.2.128.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.128.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
3.2.128.3. Consumes
- /
3.2.128.4. Produces
- /
3.2.128.5. Tags
- apiv1
3.2.129. proxy DELETE requests to Pod
DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}
3.2.129.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.129.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
3.2.129.3. Consumes
- /
3.2.129.4. Produces
- /
3.2.129.5. Tags
- apiv1
3.2.130. proxy POST requests to Pod
POST /api/v1/proxy/namespaces/{namespace}/pods/{name}
3.2.130.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.130.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
3.2.130.3. Consumes
- /
3.2.130.4. Produces
- /
3.2.130.5. Tags
- apiv1
3.2.131. proxy GET requests to Pod
GET /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path:*}
3.2.131.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 | |
PathParameter | path | path to the resource | true | string |
3.2.131.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
3.2.131.3. Consumes
- /
3.2.131.4. Produces
- /
3.2.131.5. Tags
- apiv1
3.2.132. proxy PUT requests to Pod
PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path:*}
3.2.132.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 | |
PathParameter | path | path to the resource | true | string |
3.2.132.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
3.2.132.3. Consumes
- /
3.2.132.4. Produces
- /
3.2.132.5. Tags
- apiv1
3.2.133. proxy DELETE requests to Pod
DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path:*}
3.2.133.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 | |
PathParameter | path | path to the resource | true | string |
3.2.133.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
3.2.133.3. Consumes
- /
3.2.133.4. Produces
- /
3.2.133.5. Tags
- apiv1
3.2.134. proxy POST requests to Pod
POST /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path:*}
3.2.134.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 | |
PathParameter | path | path to the resource | true | string |
3.2.134.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
3.2.134.3. Consumes
- /
3.2.134.4. Produces
- /
3.2.134.5. Tags
- apiv1
3.2.135. proxy GET requests to Service
GET /api/v1/proxy/namespaces/{namespace}/services/{name}
3.2.135.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.135.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
3.2.135.3. Consumes
- /
3.2.135.4. Produces
- /
3.2.135.5. Tags
- apiv1
3.2.136. proxy PUT requests to Service
PUT /api/v1/proxy/namespaces/{namespace}/services/{name}
3.2.136.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.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. proxy DELETE requests to Service
DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}
3.2.137.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.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. proxy POST requests to Service
POST /api/v1/proxy/namespaces/{namespace}/services/{name}
3.2.138.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.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. proxy GET requests to Service
GET /api/v1/proxy/namespaces/{namespace}/services/{name}/{path:*}
3.2.139.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 | |
PathParameter | path | path to the resource | 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. proxy PUT requests to Service
PUT /api/v1/proxy/namespaces/{namespace}/services/{name}/{path:*}
3.2.140.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 | |
PathParameter | path | path to the resource | 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. proxy DELETE requests to Service
DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}/{path:*}
3.2.141.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 | |
PathParameter | path | path to the resource | 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. proxy POST requests to Service
POST /api/v1/proxy/namespaces/{namespace}/services/{name}/{path:*}
3.2.142.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 | |
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. proxy GET requests to Node
GET /api/v1/proxy/nodes/{name}
3.2.143.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter | name | name of the Node | 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. proxy PUT requests to Node
PUT /api/v1/proxy/nodes/{name}
3.2.144.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter | name | name of the Node | 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. proxy DELETE requests to Node
DELETE /api/v1/proxy/nodes/{name}
3.2.145.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter | name | name of the Node | 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. proxy POST requests to Node
POST /api/v1/proxy/nodes/{name}
3.2.146.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter | name | name of the Node | 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. proxy GET requests to Node
GET /api/v1/proxy/nodes/{name}/{path:*}
3.2.147.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.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. proxy PUT requests to Node
PUT /api/v1/proxy/nodes/{name}/{path:*}
3.2.148.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.148.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
3.2.148.3. Consumes
- /
3.2.148.4. Produces
- /
3.2.148.5. Tags
- apiv1
3.2.149. proxy DELETE requests to Node
DELETE /api/v1/proxy/nodes/{name}/{path:*}
3.2.149.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.149.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
3.2.149.3. Consumes
- /
3.2.149.4. Produces
- /
3.2.149.5. Tags
- apiv1
3.2.150. proxy POST requests to Node
POST /api/v1/proxy/nodes/{name}/{path:*}
3.2.150.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.150.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
3.2.150.3. Consumes
- /
3.2.150.4. Produces
- /
3.2.150.5. Tags
- apiv1
3.2.151. list or watch objects of kind ReplicationController
GET /api/v1/replicationcontrollers
3.2.151.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.151.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.151.3. Consumes
- /
3.2.151.4. Produces
- application/json
3.2.151.5. Tags
- apiv1
3.2.152. create a ReplicationController
POST /api/v1/replicationcontrollers
3.2.152.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
3.2.152.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.152.3. Consumes
- /
3.2.152.4. Produces
- application/json
3.2.152.5. Tags
- apiv1
3.2.153. list or watch objects of kind ResourceQuota
GET /api/v1/resourcequotas
3.2.153.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.153.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.153.3. Consumes
- /
3.2.153.4. Produces
- application/json
3.2.153.5. Tags
- apiv1
3.2.154. create a ResourceQuota
POST /api/v1/resourcequotas
3.2.154.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
3.2.154.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.154.3. Consumes
- /
3.2.154.4. Produces
- application/json
3.2.154.5. Tags
- apiv1
3.2.155. list or watch objects of kind Secret
GET /api/v1/secrets
3.2.155.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.155.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.155.3. Consumes
- /
3.2.155.4. Produces
- application/json
3.2.155.5. Tags
- apiv1
3.2.156. create a Secret
POST /api/v1/secrets
3.2.156.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
3.2.156.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.156.3. Consumes
- /
3.2.156.4. Produces
- application/json
3.2.156.5. Tags
- apiv1
3.2.157. list or watch objects of kind SecurityContextConstraints
GET /api/v1/securitycontextconstraints
3.2.157.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.157.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.157.3. Consumes
- /
3.2.157.4. Produces
- application/json
3.2.157.5. Tags
- apiv1
3.2.158. create a SecurityContextConstraints
POST /api/v1/securitycontextconstraints
3.2.158.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
3.2.158.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.158.3. Consumes
- /
3.2.158.4. Produces
- application/json
3.2.158.5. Tags
- apiv1
3.2.159. read the specified SecurityContextConstraints
GET /api/v1/securitycontextconstraints/{name}
3.2.159.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 SecurityContextConstraints | true | string |
3.2.159.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.159.3. Consumes
- /
3.2.159.4. Produces
- application/json
3.2.159.5. Tags
- apiv1
3.2.160. replace the specified SecurityContextConstraints
PUT /api/v1/securitycontextconstraints/{name}
3.2.160.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the SecurityContextConstraints | true | string |
3.2.160.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.160.3. Consumes
- /
3.2.160.4. Produces
- application/json
3.2.160.5. Tags
- apiv1
3.2.161. delete a SecurityContextConstraints
DELETE /api/v1/securitycontextconstraints/{name}
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 | |||
PathParameter | name | name of the SecurityContextConstraints | true | string |
3.2.161.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.161.3. Consumes
- /
3.2.161.4. Produces
- application/json
3.2.161.5. Tags
- apiv1
3.2.162. partially update the specified SecurityContextConstraints
PATCH /api/v1/securitycontextconstraints/{name}
3.2.162.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the SecurityContextConstraints | true | string |
3.2.162.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.162.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
3.2.162.4. Produces
- application/json
3.2.162.5. Tags
- apiv1
3.2.163. list or watch objects of kind ServiceAccount
GET /api/v1/serviceaccounts
3.2.163.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.163.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.163.3. Consumes
- /
3.2.163.4. Produces
- application/json
3.2.163.5. Tags
- apiv1
3.2.164. create a ServiceAccount
POST /api/v1/serviceaccounts
3.2.164.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
3.2.164.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.164.3. Consumes
- /
3.2.164.4. Produces
- application/json
3.2.164.5. Tags
- apiv1
3.2.165. list or watch objects of kind Service
GET /api/v1/services
3.2.165.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.165.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.165.3. Consumes
- /
3.2.165.4. Produces
- application/json
3.2.165.5. Tags
- apiv1
3.2.166. create a Service
POST /api/v1/services
3.2.166.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
3.2.166.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.166.3. Consumes
- /
3.2.166.4. Produces
- application/json
3.2.166.5. Tags
- apiv1
3.2.167. watch individual changes to a list of Endpoints
GET /api/v1/watch/endpoints
3.2.167.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.167.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.167.3. Consumes
- /
3.2.167.4. Produces
- application/json
3.2.167.5. Tags
- apiv1
3.2.168. watch individual changes to a list of Event
GET /api/v1/watch/events
3.2.168.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.168.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.168.3. Consumes
- /
3.2.168.4. Produces
- application/json
3.2.168.5. Tags
- apiv1
3.2.169. watch individual changes to a list of LimitRange
GET /api/v1/watch/limitranges
3.2.169.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.169.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.169.3. Consumes
- /
3.2.169.4. Produces
- application/json
3.2.169.5. Tags
- apiv1
3.2.170. watch individual changes to a list of Namespace
GET /api/v1/watch/namespaces
3.2.170.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.170.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.170.3. Consumes
- /
3.2.170.4. Produces
- application/json
3.2.170.5. Tags
- apiv1
3.2.171. watch individual changes to a list of Endpoints
GET /api/v1/watch/namespaces/{namespace}/endpoints
3.2.171.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.171.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.171.3. Consumes
- /
3.2.171.4. Produces
- application/json
3.2.171.5. Tags
- apiv1
3.2.172. watch changes to an object of kind Endpoints
GET /api/v1/watch/namespaces/{namespace}/endpoints/{name}
3.2.172.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Endpoints | true | string |
3.2.172.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.172.3. Consumes
- /
3.2.172.4. Produces
- application/json
3.2.172.5. Tags
- apiv1
3.2.173. watch individual changes to a list of Event
GET /api/v1/watch/namespaces/{namespace}/events
3.2.173.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.173.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.173.3. Consumes
- /
3.2.173.4. Produces
- application/json
3.2.173.5. Tags
- apiv1
3.2.174. watch changes to an object of kind Event
GET /api/v1/watch/namespaces/{namespace}/events/{name}
3.2.174.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Event | true | string |
3.2.174.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.174.3. Consumes
- /
3.2.174.4. Produces
- application/json
3.2.174.5. Tags
- apiv1
3.2.175. watch individual changes to a list of LimitRange
GET /api/v1/watch/namespaces/{namespace}/limitranges
3.2.175.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.175.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.175.3. Consumes
- /
3.2.175.4. Produces
- application/json
3.2.175.5. Tags
- apiv1
3.2.176. watch changes to an object of kind LimitRange
GET /api/v1/watch/namespaces/{namespace}/limitranges/{name}
3.2.176.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the LimitRange | true | string |
3.2.176.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.176.3. Consumes
- /
3.2.176.4. Produces
- application/json
3.2.176.5. Tags
- apiv1
3.2.177. watch individual changes to a list of PersistentVolumeClaim
GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims
3.2.177.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.177.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.177.3. Consumes
- /
3.2.177.4. Produces
- application/json
3.2.177.5. Tags
- apiv1
3.2.178. watch changes to an object of kind PersistentVolumeClaim
GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}
3.2.178.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the PersistentVolumeClaim | true | string |
3.2.178.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.178.3. Consumes
- /
3.2.178.4. Produces
- application/json
3.2.178.5. Tags
- apiv1
3.2.179. watch individual changes to a list of Pod
GET /api/v1/watch/namespaces/{namespace}/pods
3.2.179.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.179.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.179.3. Consumes
- /
3.2.179.4. Produces
- application/json
3.2.179.5. Tags
- apiv1
3.2.180. watch changes to an object of kind Pod
GET /api/v1/watch/namespaces/{namespace}/pods/{name}
3.2.180.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Pod | true | string |
3.2.180.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.180.3. Consumes
- /
3.2.180.4. Produces
- application/json
3.2.180.5. Tags
- apiv1
3.2.181. watch individual changes to a list of PodTemplate
GET /api/v1/watch/namespaces/{namespace}/podtemplates
3.2.181.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.181.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.181.3. Consumes
- /
3.2.181.4. Produces
- application/json
3.2.181.5. Tags
- apiv1
3.2.182. watch changes to an object of kind PodTemplate
GET /api/v1/watch/namespaces/{namespace}/podtemplates/{name}
3.2.182.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the PodTemplate | true | string |
3.2.182.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.182.3. Consumes
- /
3.2.182.4. Produces
- application/json
3.2.182.5. Tags
- apiv1
3.2.183. watch individual changes to a list of ReplicationController
GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers
3.2.183.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.183.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.183.3. Consumes
- /
3.2.183.4. Produces
- application/json
3.2.183.5. Tags
- apiv1
3.2.184. watch changes to an object of kind ReplicationController
GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers/{name}
3.2.184.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the ReplicationController | true | string |
3.2.184.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.184.3. Consumes
- /
3.2.184.4. Produces
- application/json
3.2.184.5. Tags
- apiv1
3.2.185. watch individual changes to a list of ResourceQuota
GET /api/v1/watch/namespaces/{namespace}/resourcequotas
3.2.185.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.185.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.185.3. Consumes
- /
3.2.185.4. Produces
- application/json
3.2.185.5. Tags
- apiv1
3.2.186. watch changes to an object of kind ResourceQuota
GET /api/v1/watch/namespaces/{namespace}/resourcequotas/{name}
3.2.186.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the ResourceQuota | true | string |
3.2.186.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.186.3. Consumes
- /
3.2.186.4. Produces
- application/json
3.2.186.5. Tags
- apiv1
3.2.187. watch individual changes to a list of Secret
GET /api/v1/watch/namespaces/{namespace}/secrets
3.2.187.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.187.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.187.3. Consumes
- /
3.2.187.4. Produces
- application/json
3.2.187.5. Tags
- apiv1
3.2.188. watch changes to an object of kind Secret
GET /api/v1/watch/namespaces/{namespace}/secrets/{name}
3.2.188.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Secret | true | string |
3.2.188.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.188.3. Consumes
- /
3.2.188.4. Produces
- application/json
3.2.188.5. Tags
- apiv1
3.2.189. watch individual changes to a list of ServiceAccount
GET /api/v1/watch/namespaces/{namespace}/serviceaccounts
3.2.189.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.189.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.189.3. Consumes
- /
3.2.189.4. Produces
- application/json
3.2.189.5. Tags
- apiv1
3.2.190. watch changes to an object of kind ServiceAccount
GET /api/v1/watch/namespaces/{namespace}/serviceaccounts/{name}
3.2.190.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the ServiceAccount | true | string |
3.2.190.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.190.3. Consumes
- /
3.2.190.4. Produces
- application/json
3.2.190.5. Tags
- apiv1
3.2.191. watch individual changes to a list of Service
GET /api/v1/watch/namespaces/{namespace}/services
3.2.191.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
3.2.191.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.191.3. Consumes
- /
3.2.191.4. Produces
- application/json
3.2.191.5. Tags
- apiv1
3.2.192. watch changes to an object of kind Service
GET /api/v1/watch/namespaces/{namespace}/services/{name}
3.2.192.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Service | true | string |
3.2.192.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.192.3. Consumes
- /
3.2.192.4. Produces
- application/json
3.2.192.5. Tags
- apiv1
3.2.193. watch changes to an object of kind Namespace
GET /api/v1/watch/namespaces/{name}
3.2.193.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | name | name of the Namespace | true | string |
3.2.193.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.193.3. Consumes
- /
3.2.193.4. Produces
- application/json
3.2.193.5. Tags
- apiv1
3.2.194. watch individual changes to a list of Node
GET /api/v1/watch/nodes
3.2.194.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.194.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.194.3. Consumes
- /
3.2.194.4. Produces
- application/json
3.2.194.5. Tags
- apiv1
3.2.195. watch changes to an object of kind Node
GET /api/v1/watch/nodes/{name}
3.2.195.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | name | name of the Node | true | string |
3.2.195.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.195.3. Consumes
- /
3.2.195.4. Produces
- application/json
3.2.195.5. Tags
- apiv1
3.2.196. watch individual changes to a list of PersistentVolumeClaim
GET /api/v1/watch/persistentvolumeclaims
3.2.196.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.196.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.196.3. Consumes
- /
3.2.196.4. Produces
- application/json
3.2.196.5. Tags
- apiv1
3.2.197. watch individual changes to a list of PersistentVolume
GET /api/v1/watch/persistentvolumes
3.2.197.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.197.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.197.3. Consumes
- /
3.2.197.4. Produces
- application/json
3.2.197.5. Tags
- apiv1
3.2.198. watch changes to an object of kind PersistentVolume
GET /api/v1/watch/persistentvolumes/{name}
3.2.198.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | name | name of the PersistentVolume | true | string |
3.2.198.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.198.3. Consumes
- /
3.2.198.4. Produces
- application/json
3.2.198.5. Tags
- apiv1
3.2.199. watch individual changes to a list of Pod
GET /api/v1/watch/pods
3.2.199.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.199.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.199.3. Consumes
- /
3.2.199.4. Produces
- application/json
3.2.199.5. Tags
- apiv1
3.2.200. watch individual changes to a list of PodTemplate
GET /api/v1/watch/podtemplates
3.2.200.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.200.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.200.3. Consumes
- /
3.2.200.4. Produces
- application/json
3.2.200.5. Tags
- apiv1
3.2.201. watch individual changes to a list of ReplicationController
GET /api/v1/watch/replicationcontrollers
3.2.201.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.201.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.201.3. Consumes
- /
3.2.201.4. Produces
- application/json
3.2.201.5. Tags
- apiv1
3.2.202. watch individual changes to a list of ResourceQuota
GET /api/v1/watch/resourcequotas
3.2.202.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.202.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.202.3. Consumes
- /
3.2.202.4. Produces
- application/json
3.2.202.5. Tags
- apiv1
3.2.203. watch individual changes to a list of Secret
GET /api/v1/watch/secrets
3.2.203.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.203.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.203.3. Consumes
- /
3.2.203.4. Produces
- application/json
3.2.203.5. Tags
- apiv1
3.2.204. watch individual changes to a list of SecurityContextConstraints
GET /api/v1/watch/securitycontextconstraints
3.2.204.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.204.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.204.3. Consumes
- /
3.2.204.4. Produces
- application/json
3.2.204.5. Tags
- apiv1
3.2.205. watch changes to an object of kind SecurityContextConstraints
GET /api/v1/watch/securitycontextconstraints/{name}
3.2.205.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
PathParameter | name | name of the SecurityContextConstraints | true | string |
3.2.205.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.205.3. Consumes
- /
3.2.205.4. Produces
- application/json
3.2.205.5. Tags
- apiv1
3.2.206. watch individual changes to a list of ServiceAccount
GET /api/v1/watch/serviceaccounts
3.2.206.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.206.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.206.3. Consumes
- /
3.2.206.4. Produces
- application/json
3.2.206.5. Tags
- apiv1
3.2.207. watch individual changes to a list of Service
GET /api/v1/watch/services
3.2.207.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string |
3.2.207.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
3.2.207.3. Consumes
- /
3.2.207.4. Produces
- application/json
3.2.207.5. Tags
- apiv1
3.3. Definitions
3.3.1. v1.PersistentVolume
A Persistent Volume (PV) is a storage device that is made available for use by applications by an administrator. When a user requests persistent storage be allocated for a pod, they create a persistent volume claim with the size and type of storage they need. The system will look for persistent volumes that match that claim and, if one is available, it will assign that persistent volume to the claim. Information about the volume (type, location, secrets necessary to use it) will be available to the claim and the claim may then be used from a pod as a volume source.
Deleting a persistent volume removes the cluster’s record of the volume, and may result in automated processes destroying the underlying network store.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata | false | ||
spec | Spec defines a specification of a persistent volume owned by the cluster. Provisioned by an administrator. More info: http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistent-volumes | false | ||
status | Status represents the current information/status for the persistent volume. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistent-volumes | false |
3.3.2. v1.MetadataVolumeSource
Name | Description | Required | Schema | Default |
---|---|---|---|---|
items | list of metadata files | false |
3.3.3. 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.4. 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 | ||
used | Used is the current observed total usage of the resource in the namespace. | false |
3.3.5. v1.ContainerStateTerminated
ContainerStateTerminated is a terminated state of a container.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
exitCode | Exit status from the last termination of the container | true | integer (int32) | |
signal | Signal from the last termination of the container | false | integer (int32) | |
reason | (brief) reason from the last termination of the container | false | string | |
message | Message regarding the last termination of the container | false | string | |
startedAt | Time at which previous execution of the container started | false | string | |
finishedAt | Time at which the container last terminated | false | string | |
containerID | Container’s ID in the format 'docker://<container_id>' | false | string |
3.3.6. v1.ReplicationControllerList
ReplicationControllerList is a collection of replication controllers.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | ||
items | List of replication controllers. More info: http://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md | true |
3.3.7. v1.Capability
3.3.8. v1.Pod
A pod corresponds to a group of containers running together on the same machine. All containers in a pod share an IP address, and may have access to shared volumes and local fileystem. Like individual application containers, pods are considered to be relatively ephemeral rather than durable entities. Pods are scheduled to nodes and remain there until termination (according to restart policy) or deletion. When a node dies, the pods scheduled to that node are deleted. Specific pods are never rescheduled to new nodes; instead, they must be replaced by a component like the replication controller.
See the Kubernetes pod documentation for more information.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata | false | ||
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 | ||
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 |
3.3.9. v1.Event
Event is a report of an event somewhere in the cluster.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata | true | ||
involvedObject | The object that this event is about. | true | ||
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 | ||
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) |
3.3.10. 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 |
3.3.11. v1.HostPathVolumeSource
HostPathVolumeSource represents bare host directory volume.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
path | Path of the directory on the host. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#hostpath | true | string |
3.3.12. v1.Volume
Volume represents a named volume in a pod that may be accessed by any container in the pod.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
name | Volume’s name. Must be a DNS_LABEL and unique within the pod. More info: http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names | true | string | |
hostPath | HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#hostpath | false | ||
emptyDir | EmptyDir represents a temporary directory that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#emptydir | false | ||
gcePersistentDisk | GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk | false | ||
awsElasticBlockStore | AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore | false | ||
gitRepo | GitRepo represents a git repository at a particular revision. | false | ||
secret | Secret represents a secret that should populate this volume. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#secrets | false | ||
nfs | NFS represents an NFS mount on the host that shares a pod’s lifetime More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs | false | ||
iscsi | ISCSI represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/HEAD/examples/iscsi/README.md | false | ||
glusterfs | Glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/glusterfs/README.md | false | ||
persistentVolumeClaim | PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims | false | ||
rbd | RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/rbd/README.md | false | ||
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 | ||
cephfs | CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime | false | ||
flocker | Flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running | false | ||
downwardAPI | DownwardAPI represents downward API about the pod that should populate this volume | false | ||
fc | FC represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod. | false | ||
metadata | false |
3.3.13. 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.14. v1.DeleteOptions
DeleteOptions may be provided when deleting an API object
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | true | integer (int64) |
3.3.15. 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 | ||
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 |
3.3.16. v1.SecretList
SecretList is a list of Secret.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | ||
items | Items is a list of secret objects. More info: http://releases.k8s.io/HEAD/docs/user-guide/secrets.md | true |
3.3.17. v1.NFSVolumeSource
NFSVolumeSource represents an NFS mount that lasts the lifetime of a pod
Name | Description | Required | Schema | Default |
---|---|---|---|---|
server | Server is the hostname or IP address of the NFS server. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs | true | string | |
path | Path that is exported by the NFS server. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs | true | string | |
readOnly | ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs | false | boolean | false |
3.3.18. v1.CephFSVolumeSource
CephFSVolumeSource represents a Ceph Filesystem Mount that lasts the lifetime of a pod
Name | Description | Required | Schema | Default |
---|---|---|---|---|
monitors | Required: Monitors is a collection of Ceph monitors More info: http://releases.k8s.io/HEAD/examples/cephfs/README.md#how-to-use-it | true | string array | |
user | Optional: User is the rados user name, default is admin More info: http://releases.k8s.io/HEAD/examples/cephfs/README.md#how-to-use-it | false | string | |
secretFile | Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: http://releases.k8s.io/HEAD/examples/cephfs/README.md#how-to-use-it | false | string | |
secretRef | Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: http://releases.k8s.io/HEAD/examples/cephfs/README.md#how-to-use-it | false | ||
readOnly | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/cephfs/README.md#how-to-use-it | false | boolean | false |
3.3.19. v1.Capabilities
Adds and removes POSIX capabilities from running containers.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
add | Added capabilities | false | ||
drop | Removed capabilities | false |
3.3.20. v1.ComponentCondition
Information about the condition of a component.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
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.21. unversioned.Status
Status is a return value for calls that don’t return other objects.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | ||
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 | ||
code | Suggested HTTP return code for this status, 0 if not set. | false | integer (int32) |
3.3.22. 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 |
3.3.23. 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 | Default |
---|---|---|---|---|
name | The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). | false | string | |
kind | The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. 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 | ||
retryAfterSeconds | If specified, the time in seconds before the operation should be retried. | false | integer (int32) |
3.3.24. v1.SecretVolumeSource
SecretVolumeSource adapts a Secret into a VolumeSource. More info: http://releases.k8s.io/HEAD/docs/design/secrets.md
Name | Description | Required | Schema | Default |
---|---|---|---|---|
secretName | SecretName is the name of a secret in the pod’s namespace. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#secrets | true | string |
3.3.25. 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://releases.k8s.io/HEAD/docs/design/resources.md#resource-specifications | false | ||
requests | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: http://releases.k8s.io/HEAD/docs/design/resources.md#resource-specifications | false |
3.3.26. v1.PersistentVolumeClaim
Persistent Volume Claims (PVC) represent a request to use a persistent volume (PV) with a pod. When creating a pod definition (or replication controller or deployment config) a developer may specify the amount of storage they need via a persistent volume reference. If an administrator has enabled and configured persistent volumes for use, they will be allocated on demand to pods that have similar requirements. Since volumes are created lazily, some pods may be scheduled to a node before their volume is assigned. The node will detect this situation and wait to start the pod until the volume is bound. Events will be generated (visible by using the describe
command on the pod) that indicate the pod is waiting for volumes.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata | false | ||
spec | Spec defines the desired characteristics of a volume requested by a pod author. More info: http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims | false | ||
status | Status represents the current information/status of a persistent volume claim. Read-only. More info: http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims | false |
3.3.27. unversioned.Patch
Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
3.3.28. v1.SecurityContextConstraintsList
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
items | true |
3.3.29. 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.30. v1.PersistentVolumeAccessMode
3.3.31. 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 |
3.3.32. v1.RunAsUserStrategyOptions
Name | Description | Required | Schema | Default |
---|---|---|---|---|
type | strategy used to generate RunAsUser | false | string | |
uid | the uid to always run as; required for MustRunAs | false | integer (int64) | |
uidRangeMin | min value for range based allocators | false | integer (int64) | |
uidRangeMax | max value for range based allocators | false | integer (int64) |
3.3.33. v1.PersistentVolumeSpec
PersistentVolumeSpec is the specification of a persistent volume.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
capacity | A description of the persistent volume’s resources and capacity. More info: http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#capacity | false | ||
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://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk | false | ||
awsElasticBlockStore | AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore | false | ||
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://releases.k8s.io/HEAD/docs/user-guide/volumes.md#hostpath | false | ||
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/glusterfs/README.md | false | ||
nfs | NFS represents an NFS mount on the host. Provisioned by an admin. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs | false | ||
rbd | RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/rbd/README.md | false | ||
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 | ||
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 | ||
cephfs | CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime | false | ||
fc | FC represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod. | false | ||
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 | ||
accessModes | AccessModes contains all ways the volume can be mounted. More info: http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#access-modes | false | ||
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://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#binding | false | ||
persistentVolumeReclaimPolicy | What happens to a persistent volume when released from its claim. Valid options are Retain (default) and Recycle. Recyling must be supported by the volume plug-in underlying this persistent volume. More info: http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#recycling-policy | false | string |
3.3.34. 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.35. 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://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims | true | string | |
readOnly | Will force the ReadOnly setting in VolumeMounts. Default false. | false | boolean | false |
3.3.36. v1.ServiceSpec
ServiceSpec describes the attributes that a user creates on a service.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
ports | The list of ports that are exposed by this service. More info: http://releases.k8s.io/HEAD/docs/user-guide/services.md#virtual-ips-and-service-proxies | true | ||
selector | This service will route traffic to pods having labels matching this selector. Label keys and values that must match in order to receive traffic for this service. If empty, all pods are selected, if not specified, endpoints must be manually specified. More info: http://releases.k8s.io/HEAD/docs/user-guide/services.md#overview | false | ||
portalIP | deprecated, use clusterIP instead | false | string | |
clusterIP | ClusterIP is usually assigned by the master and is the IP address of the service. If specified, it will be allocated to the service if it is unused or else creation of the service will fail. Valid values are None, empty string (""), or a valid IP address. 'None' can be specified for a headless service when proxying is not required. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/services.md#virtual-ips-and-service-proxies | false | string | |
type | Type of exposed service. Must be ClusterIP, NodePort, or LoadBalancer. Defaults to ClusterIP. More info: http://releases.k8s.io/HEAD/docs/user-guide/services.md#external-services | 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://releases.k8s.io/HEAD/docs/user-guide/services.md#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 |
3.3.37. v1.ServiceList
ServiceList holds a list of services.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | ||
items | List of services | true |
3.3.38. v1.PersistentVolumeList
PersistentVolumeList is a list of PersistentVolume items.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | ||
items | List of persistent volumes. More info: http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md | true |
3.3.39. v1.ContainerStatus
ContainerStatus contains details for the current status of this container.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
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 | ||
lastState | Details about the container’s last termination condition. | false | ||
ready | Specifies whether the container has passed its readiness probe. | true | boolean | false |
restartCount | The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. 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://releases.k8s.io/HEAD/docs/user-guide/images.md | true | string | |
imageID | ImageID of the container’s image. | true | string | |
containerID | Container’s ID in the format 'docker://<container_id>'. More info: http://releases.k8s.io/HEAD/docs/user-guide/container-environment.md#container-information | false | string |
3.3.40. v1.Handler
Handler defines a specific action that should be taken
Name | Description | Required | Schema | Default |
---|---|---|---|---|
exec | One and only one of the following should be specified. Exec specifies the action to take. | false | ||
httpGet | HTTPGet specifies the http request to perform. | false | ||
tcpSocket | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported | false |
3.3.41. 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.42. v1.FCVolumeSource
A Fibre Channel Disk can only be mounted as read/write once.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
targetWWNs | Required: FC target world wide names (WWNs) | true | string array | |
lun | Required: FC target lun number | true | integer (int32) | |
fsType | Required: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs" | true | string | |
readOnly | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. | false | boolean | false |
3.3.43. v1.EndpointPort
EndpointPort is a tuple that describes a single port.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
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.44. v1.DownwardAPIVolumeFile
DownwardAPIVolumeFile represents a single file containing information from the downward API
Name | Description | Required | Schema | Default |
---|---|---|---|---|
path | Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' | true | string | |
fieldRef | Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. | true |
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 | Default |
---|---|---|---|---|
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 | ||
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 | ||
ports | Port numbers available on the related IP addresses. | false |
3.3.46. v1.LimitRangeList
LimitRangeList is a list of LimitRange items.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | ||
items | Items is a list of LimitRange objects. More info: http://releases.k8s.io/HEAD/docs/design/admission_control_limit_range.md | true |
3.3.47. v1.Container
A single application container that you want to run within a pod.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
name | Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. | true | string | |
image | Docker image name. More info: http://releases.k8s.io/HEAD/docs/user-guide/images.md | false | string | |
command | Entrypoint array. Not executed within a shell. The docker image’s entrypoint is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double , ie: (VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/containers.md#containers-and-commands | false | string array | |
args | Arguments to the entrypoint. The docker image’s cmd is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double , ie: (VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/containers.md#containers-and-commands | false | string array | |
workingDir | Container’s working directory. Defaults to Docker’s default. D efaults to image’s default. Cannot be updated. | false | string | |
ports | List of ports to expose from the container. Cannot be updated. | false | ||
env | List of environment variables to set in the container. Cannot be updated. | false | ||
resources | Compute Resources required by this container. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#resources | false | ||
volumeMounts | Pod volumes to mount into the container’s filesyste. Cannot be updated. | false | ||
livenessProbe | Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes | false | ||
readinessProbe | Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes | false | ||
lifecycle | Actions that the management system should take in response to container lifecycle events. Cannot be updated. | false | ||
terminationMessagePath | Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Defaults to /dev/termination-log. Cannot be updated. | false | string | |
imagePullPolicy | Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/images.md#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 | ||
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 | false |
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 | false |
tty | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. | false | boolean | false |
3.3.48. v1.MetadataFile
Name | Description | Required | Schema | Default |
---|---|---|---|---|
name | the name of the file to be created | true | string | |
fieldRef | selects a field of the pod. Supported fields: metadata.annotations, metadata.labels, metadata.name, metadata.namespace | true |
3.3.49. v1.PodSpec
PodSpec is a description of a pod.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
volumes | List of volumes that can be mounted by containers belonging to the pod. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md | false | ||
containers | List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/containers.md | true | ||
restartPolicy | Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#restartpolicy | false | string | |
terminationGracePeriodSeconds | Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. | false | integer (int64) | |
activeDeadlineSeconds | Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. | false | integer (int64) | |
dnsPolicy | Set DNS policy for containers within the pod. One of 'ClusterFirst' or 'Default'. Defaults to "ClusterFirst". | false | string | |
nodeSelector | NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: http://releases.k8s.io/HEAD/docs/user-guide/node-selection/README.md | false | ||
host | deprecated, use nodeName instead | false | string | |
serviceAccountName | ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: http://releases.k8s.io/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 | false |
hostPID | Use the host’s pid namespace. Optional: Default to false. | false | boolean | false |
hostIPC | Use the host’s ipc namespace. Optional: Default to false. | false | boolean | false |
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 | ||
imagePullSecrets | ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: http://releases.k8s.io/HEAD/docs/user-guide/images.md#specifying-imagepullsecrets-on-a-pod | false |
3.3.50. v1.FlockerVolumeSource
FlockerVolumeSource represents a Flocker volume mounted by the Flocker agent.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
datasetName | Required: the volume name. This is going to be store on metadata → name on the payload for Flocker | true | string |
3.3.51. v1.PersistentVolumeStatus
PersistentVolumeStatus is the current status of a persistent volume.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
phase | Phase indicates if a volume is available, bound to a claim, or released by a claim. More info: http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#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.52. v1.RBDVolumeSource
RBDVolumeSource represents a Rados Block Device Mount that lasts the lifetime of a pod
Name | Description | Required | Schema | Default |
---|---|---|---|---|
monitors | A collection of Ceph monitors. More info: http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it | true | string array | |
image | The rados image name. More info: http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it | true | string | |
fsType | Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#rbd | false | string | |
pool | The rados pool name. Default is rbd. More info: http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it. | true | string | |
user | The rados user name. Default is admin. More info: http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it | true | string | |
keyring | Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it | true | string | |
secretRef | SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is empty. More info: http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it | true | ||
readOnly | ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it | false | boolean | false |
3.3.53. 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.54. v1.SupplementalGroupsStrategyOptions
SupplementalGroupsStrategyOptions is the strategy that will dictate what supplemental groups are used by the SecurityContext.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
type | strategy used to generate supplemental groups | false | string | |
ranges | ranges of allowable IDs for supplemental groups | false |
3.3.55. 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 | Default |
---|---|---|---|---|
capabilities | The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. | false | ||
privileged | Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. | false | boolean | false |
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 | ||
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 | false |
3.3.56. v1.ServicePort
ServicePort conatins information on service’s port.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
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 Port is used (an identity map). Defaults to the service port. More info: http://releases.k8s.io/HEAD/docs/user-guide/services.md#defining-a-service | false | string | |
nodePort | The port on each node on which this service is exposed when type=NodePort or LoadBalancer. Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one. More info: http://releases.k8s.io/HEAD/docs/user-guide/services.md#type—nodeport | false | integer (int32) |
3.3.57. v1.Namespace
Namespace provides a scope for Names. Use of multiple namespaces is optional.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata | false | ||
spec | Spec defines the behavior of the Namespace. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status | false | ||
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 |
3.3.58. v1.GCEPersistentDiskVolumeSource
GCEPersistentDiskVolumeSource represents a Persistent Disk resource in Google Compute Engine.
A GCE PD must exist and be formatted 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.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
pdName | Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk | true | string | |
fsType | Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk | true | string | |
partition | The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk | false | integer (int32) | |
readOnly | ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk | false | boolean | false |
3.3.59. v1.EndpointsList
EndpointsList is a list of endpoints.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | ||
items | List of endpoints. | true |
3.3.60. v1.NodeList
NodeList is the whole list of all Nodes which have been registered with master.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | ||
items | List of nodes | true |
3.3.61. v1.EventSource
EventSource contains information for an event.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
component | Component from which the event is generated. | false | string | |
host | Host name on which the event is generated. | false | string |
3.3.62. v1.EnvVarSource
EnvVarSource represents a source for the value of an EnvVar.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
fieldRef | Selects a field of the pod. Only name and namespace are supported. | true |
3.3.63. 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.64. 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 |
3.3.65. v1.PersistentVolumeClaimSpec
PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes
Name | Description | Required | Schema | Default |
---|---|---|---|---|
accessModes | AccessModes contains the desired access modes the volume should have. More info: http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#access-modes-1 | false | ||
resources | Resources represents the minimum resources the volume should have. More info: http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#resources | false | ||
volumeName | VolumeName is the binding reference to the PersistentVolume backing this claim. | false | string |
3.3.66. v1.ReplicationController
ReplicationController represents the configuration of a replication controller.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | 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 | ||
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 | ||
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 |
3.3.67. v1.NamespaceList
NamespaceList is a list of Namespaces.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | ||
items | Items is the list of Namespace objects in the list. More info: http://releases.k8s.io/HEAD/docs/user-guide/namespaces.md | true |
3.3.68. integer
3.3.69. v1.SecurityContextConstraints
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | false | |||
allowPrivilegedContainer | allow containers to run as privileged | true | boolean | false |
allowedCapabilities | capabilities that are allowed to be added | true | ||
allowHostDirVolumePlugin | allow the use of the host dir volume plugin | true | boolean | false |
allowHostNetwork | allow the use of the hostNetwork in the pod spec | true | boolean | false |
allowHostPorts | allow the use of the host ports in the containers | true | boolean | false |
allowHostPID | allow the use of the host pid in the containers | true | boolean | false |
allowHostIPC | allow the use of the host ipc in the containers | true | boolean | false |
seLinuxContext | strategy used to generate SELinuxOptions | false | ||
runAsUser | strategy used to generate RunAsUser | false | ||
supplementalGroups | strategy used to generate supplemental groups | false | ||
fsGroup | strategy used to generate fsGroup | false | ||
users | users allowed to use this SecurityContextConstraints | false | string array | |
groups | groups allowed to use this SecurityContextConstraints | false | string array |
3.3.70. v1.VolumeMount
VolumeMount describes a mounting of a Volume within a container.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
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 | false |
mountPath | Path within the container at which the volume should be mounted. | true | string |
3.3.71. v1.NodeStatus
NodeStatus is information about the current status of a node.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
capacity | Capacity represents the available resources of a node. More info: http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#capacity for more details. | false | ||
phase | NodePhase is the recently observed lifecycle phase of the node. More info: http://releases.k8s.io/HEAD/docs/admin/node.md#node-phase | 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 | ||
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 | ||
daemonEndpoints | Endpoints of daemons running on the Node. | false | ||
nodeInfo | Set of ids/uuids to uniquely identify the node. More info: http://releases.k8s.io/HEAD/docs/admin/node.md#node-info | false |
3.3.72. v1.ReplicationControllerStatus
ReplicationControllerStatus represents the current status of a replication controller.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
replicas | Replicas is the most recently oberved number of replicas. More info: http://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md#what-is-a-replication-controller | true | integer (int32) | |
observedGeneration | ObservedGeneration reflects the generation of the most recently observed replication controller. | false | integer (int64) |
3.3.73. v1.PodCondition
PodCondition contains details for the current condition of this pod.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
type | Type is the type of the condition. Currently only Ready. More info: http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#pod-conditions | true | string | |
status | Status is the status of the condition. Can be True, False, Unknown. More info: http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#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.74. v1.NodeCondition
NodeCondition contains condition infromation for a node.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
type | Type of node condition, currently only Ready. | true | string | |
status | Status of the condition, one of True, False, Unknown. | true | string | |
lastHeartbeatTime | Last time we got an update on a given condition. | false | string | |
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.75. 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 | Default |
---|---|---|---|---|
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 | ||
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 | false |
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 | ||
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: | false | integer (int64) |
3.3.76. 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 | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata | false | ||
secrets | Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount. More info: http://releases.k8s.io/HEAD/docs/user-guide/secrets.md | false | ||
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://releases.k8s.io/HEAD/docs/user-guide/secrets.md#manually-specifying-an-imagepullsecret | false |
3.3.77. v1.PodTemplate
PodTemplate describes a template for creating copies of a predefined pod.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata | false | ||
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 |
3.3.78. v1.PodList
PodList is a list of Pods.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | ||
items | List of pods. More info: http://releases.k8s.io/HEAD/docs/user-guide/pods.md | true | Section 3.3.8, “v1.Pod” array |
3.3.79. v1.EmptyDirVolumeSource
EmptyDirVolumeSource is temporary directory that shares a pod’s lifetime.
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://releases.k8s.io/HEAD/docs/user-guide/volumes.md#emptydir | false | string |
3.3.80. v1.NodeSpec
NodeSpec describes the attributes that a node is created with.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
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 | false |
3.3.81. v1.HTTPGetAction
HTTPGetAction describes an action based on HTTP Get requests.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
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. | false | string | |
scheme | Scheme to use for connecting to the host. Defaults to HTTP. | false | string |
3.3.82. v1.ResourceQuotaList
ResourceQuotaList is a list of ResourceQuota items.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | ||
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 |
3.3.83. v1.IDRange
IDRange provides a min/max of an allowed range of IDs.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
min | min value for the range | false | integer (int64) | |
max | min value for the range | false | integer (int64) |
3.3.84. 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.85. v1.ServiceAccountList
ServiceAccountList is a list of ServiceAccount objects
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | ||
items | List of ServiceAccounts. More info: http://releases.k8s.io/HEAD/docs/design/service_accounts.md#service-accounts | true |
3.3.86. v1.Probe
Probe describes a liveness probe to be examined to the container.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
exec | One and only one of the following should be specified. Exec specifies the action to take. | false | ||
httpGet | HTTPGet specifies the http request to perform. | false | ||
tcpSocket | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported | false | ||
initialDelaySeconds | Number of seconds after the container has started before liveness probes are initiated. More info: http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes | false | integer (int64) | |
timeoutSeconds | Number of seconds after which liveness probes timeout. Defaults to 1 second. More info: http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes | false | integer (int64) |
3.3.87. 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 |
3.3.88. v1.ISCSIVolumeSource
ISCSIVolumeSource describes an ISCSI Disk can only be mounted as read/write once.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
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) | |
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". More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#iscsi | true | string | |
readOnly | ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. | false | boolean | false |
3.3.89. v1.EventList
EventList is a list of events.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | ||
items | List of events | true |
3.3.90. 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 |
3.3.91. v1.PersistentVolumeClaimList
PersistentVolumeClaimList is a list of PersistentVolumeClaim items.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | ||
items | A list of persistent volume claims. More info: http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims | true |
3.3.92. v1.ComponentStatus
ComponentStatus (and ComponentStatusList) holds the cluster validation info.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata | false | ||
conditions | List of component conditions observed | false |
3.3.93. v1.GitRepoVolumeSource
GitRepoVolumeSource represents a volume that is pulled from git when the pod is created.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
repository | Repository URL | true | string | |
revision | Commit hash for the specified revision. | true | string |
3.3.94. v1.ObjectMeta
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
name | Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names | false | string | |
generateName |
GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. | 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. | 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. | 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. | false | string | |
generation | A sequence number representing a specific generation of the desired state. Currently only implemented by replication controllers. 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. | false | string | |
deletionTimestamp |
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested. | false | string | |
deletionGracePeriodSeconds | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. | false | integer (int64) | |
labels | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://releases.k8s.io/HEAD/docs/user-guide/labels.md | false | ||
annotations | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://releases.k8s.io/HEAD/docs/user-guide/annotations.md | false |
3.3.95. 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://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names | false | string |
3.3.96. v1.ContainerPort
ContainerPort represents a network port in a single container.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
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.97. 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 | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata | false | ||
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 | ||
type | Used to facilitate programmatic handling of secret data. | false | string |
3.3.98. v1.DownwardAPIVolumeSource
DownwardAPIVolumeSource represents a volume containing downward API info
Name | Description | Required | Schema | Default |
---|---|---|---|---|
items | Items is a list of downward API volume file | false |
3.3.99. 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 | Default |
---|---|---|---|---|
waiting | Details about a waiting container | false | ||
running | Details about a running container | false | ||
terminated | Details about a terminated container | false |
3.3.100. 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 | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata | false | ||
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 |
3.3.101. v1.CinderVolumeSource
CinderVolumeSource represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
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 | Required: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Only ext3 and ext4 are allowed 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 | false |
3.3.102. v1.SELinuxContextStrategyOptions
Name | Description | Required | Schema | Default |
---|---|---|---|---|
type | strategy used to generate the SELinux context | false | string | |
seLinuxOptions | seLinuxOptions required to run as; required for MustRunAs | false |
3.3.103. v1.PodStatus
PodStatus represents information about the status of a pod. Status may trail the actual state of a system.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
phase | Current condition of the pod. More info: http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#pod-phase | false | string | |
conditions | Current service state of pod. More info: http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#pod-conditions | false | ||
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 | false |
3.3.104. v1.SELinuxOptions
SELinuxOptions are the labels to be applied to the container
Name | Description | Required | Schema | Default |
---|---|---|---|---|
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.105. v1.Service
A Service is an abstraction which defines a logical set of Pods and a policy by which to access them - sometimes called a micro-service. The set of Pods targeted by a Service is (usually) determined by a Label selector. Services broadly fall into two types - those that load balance a set of Pods and hide which Pod a client talks to (clusterIP set to an IP address), and those where clients want to talk to the individual member pods directly (clusterIP set to 'None', also known as 'headless’services). The cluster IP of a service is exposed as an environment variable in each pod in the same namespace.
Services may be exposed only inside the cluster (type ClusterIP), inside the cluster and on a high port on each node (type NodePort), or exposed to a load balancer via the hosting cloud infrastructure (type LoadBalancer). Services with a ClusterIP may choose to map the ports available on the ClusterIP to different ports on the pods. Each service has a DNS entry of the form <name>.<namespace>.svc.cluster.local
that will be valid from other pods in the cluster.
If the selector for pods is not specified, the service endpoints may be managed by the client directly. Update the endpoint resource to program the service - this can be used to inject external network services into a namsepace.
See the Kubernetes service documentation for more information.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata | false | ||
spec | Spec defines the behavior of a service. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status | false | ||
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 |
3.3.106. v1.ObjectReference
ObjectReference contains enough information to let you inspect or modify the referred object.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
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://releases.k8s.io/HEAD/docs/user-guide/namespaces.md | false | string | |
name | Name of the referent. More info: http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names | false | string | |
uid | UID of the referent. More info: http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#uids | false | string | |
apiVersion | API version of the referent. | false | string | |
resourceVersion | Specific resourceVersion to which this reference is made, if any. 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.107. 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.108. v1.ComponentStatusList
Status of all the conditions for the component as a list of ComponentStatus objects.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | ||
items | List of ComponentStatus objects. | true |
3.3.109. 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://releases.k8s.io/HEAD/docs/user-guide/container-environment.md#hook-details | false | ||
preStop | PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: http://releases.k8s.io/HEAD/docs/user-guide/container-environment.md#hook-details | false |
3.3.110. v1.NodeSystemInfo
NodeSystemInfo is a set of ids/uuids to uniquely identify the node.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
machineID | Machine ID reported by the node. | true | string | |
systemUUID | System UUID reported by the node. | 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 |
3.3.111. v1.FSGroupStrategyOptions
FSGroupStrategyOptions is the strategy that will dictate what fs group is used by the SecurityContext.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
type | strategy used to generate fsGroup | false | string | |
ranges | ranges of allowable IDs for fsGroup | false |
3.3.112. json.WatchEvent
Name | Description | Required | Schema | Default |
---|---|---|---|---|
type | the type of watch event; may be ADDED, MODIFIED, DELETED, or ERROR | false | string | |
object | the object being watched; will match the type of the resource endpoint or be a Status object if the type is ERROR | false | string |
3.3.113. v1.EndpointAddress
EndpointAddress is a tuple that describes single IP address.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
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). | true | string | |
targetRef | Reference to object providing the endpoint. | false |
3.3.114. v1.AWSElasticBlockStoreVolumeSource
Represents a persistent disk resource in AWS.
An Amazon Elastic Block Store (EBS) must already be created, formatted, and reside in the same AWS zone as the kubelet before it can be mounted. Note: Amazon EBS volumes can be mounted to only one instance at a time.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
volumeID | Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore | true | string | |
fsType | Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore | true | string | |
partition | The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). | false | integer (int32) | |
readOnly | Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore | false | boolean | false |
3.3.115. v1.Binding
Binding ties one object to another. For example, a pod is bound to a node by a scheduler.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata | false | ||
target | The target object that you want to bind to the standard object. | true |
3.3.116. v1.Node
Nodes represent the machines that run the pods and containers in the cluster. A node resource is typically created and modified by the software running on the node - reporting information about capacity and the current health of the node. The labels of the node can be used by pods to specify a subset of the cluster to be scheduled on. The scheduler will only assign pods to nodes that have the schedulable
condition set and also ready
.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata | false | ||
spec | Spec defines the behavior of a node. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status | false | ||
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 |
3.3.117. v1.ResourceQuota
ResourceQuota sets aggregate quota restrictions enforced per namespace
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata | false | ||
spec | Spec defines the desired quota. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status | false | ||
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 |
3.3.118. v1.EnvVar
EnvVar represents an environment variable present in a Container.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
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 |
3.3.119. unversioned.StatusCause
StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
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. | false | string |
3.3.120. v1.ReplicationControllerSpec
ReplicationControllerSpec is the specification of a replication controller.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
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://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md#what-is-a-replication-controller | 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://releases.k8s.io/HEAD/docs/user-guide/labels.md#label-selectors | false | ||
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://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md#pod-template | false |
3.3.121. 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.122. v1.PodTemplateList
PodTemplateList is a list of PodTemplates.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | ||
items | List of pod templates | true |
3.3.123. v1.LimitRangeItem
LimitRangeItem defines a min/max usage limit for any resource that matches on kind.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
type | Type of resource that this limit applies to. | false | string | |
max | Max usage constraints on this kind by resource name. | false | ||
min | Min usage constraints on this kind by resource name. | false | ||
default | Default resource requirement limit value by resource name if resource limit is omitted. | false | ||
defaultRequest | DefaultRequest is the default resource requirement request value by resource name if resource request is omitted. | false | ||
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 |
3.3.124. v1.FinalizerName
3.3.125. v1.LimitRange
LimitRange sets resource usage limits for each kind of resource in a Namespace.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
kind | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string | |
apiVersion | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string | |
metadata | Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata | false | ||
spec | Spec defines the limits enforced. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status | false |
3.3.126. v1.GlusterfsVolumeSource
GlusterfsVolumeSource represents a Glusterfs Mount that lasts the lifetime of a pod.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
endpoints | EndpointsName is the endpoint name that details Glusterfs topology. More info: http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod | true | string | |
path | Path is the Glusterfs volume path. More info: http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod | true | string | |
readOnly | ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod | false | boolean | false |
3.3.127. v1.PersistentVolumeClaimStatus
PersistentVolumeClaimStatus is the current status of a persistent volume claim.
Name | Description | Required | Schema | Default |
---|---|---|---|---|
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://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#access-modes-1 | false | ||
capacity | Represents the actual resources of the underlying volume. | false |
3.3.128. any
Represents an untyped JSON map - see the description of the field for more info about the structure of this object.
Chapter 4. Revision History: REST API Reference
4.1. Tue Oct 04 2016
Affected Topic | Description of Change |
---|---|
Updated the |
4.2. Thu Nov 19 2015
OpenShift Enterprise 3.1 release.
Legal Notice
Copyright © 2024 Red Hat, Inc.
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.