GET /oapi/v1
×
OpenShift Enterprise v1 REST API
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.
Paths
list or watch objects of kind BuildConfig
GET /oapi/v1/buildconfigs
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 |
create a BuildConfig
POST /oapi/v1/buildconfigs
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list or watch objects of kind Build
GET /oapi/v1/builds
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 |
create a Build
POST /oapi/v1/builds
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list or watch objects of kind ClusterNetwork
GET /oapi/v1/clusternetworks
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 |
create a ClusterNetwork
POST /oapi/v1/clusternetworks
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
read the specified ClusterNetwork
GET /oapi/v1/clusternetworks/{name}
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 |
replace the specified ClusterNetwork
PUT /oapi/v1/clusternetworks/{name}
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 |
delete a ClusterNetwork
DELETE /oapi/v1/clusternetworks/{name}
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 |
partially update the specified ClusterNetwork
PATCH /oapi/v1/clusternetworks/{name}
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 |
list or watch objects of kind ClusterPolicy
GET /oapi/v1/clusterpolicies
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 |
create a ClusterPolicy
POST /oapi/v1/clusterpolicies
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
read the specified ClusterPolicy
GET /oapi/v1/clusterpolicies/{name}
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 |
replace the specified ClusterPolicy
PUT /oapi/v1/clusterpolicies/{name}
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 |
delete a ClusterPolicy
DELETE /oapi/v1/clusterpolicies/{name}
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 |
partially update the specified ClusterPolicy
PATCH /oapi/v1/clusterpolicies/{name}
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 |
list or watch objects of kind ClusterPolicyBinding
GET /oapi/v1/clusterpolicybindings
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 |
create a ClusterPolicyBinding
POST /oapi/v1/clusterpolicybindings
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
read the specified ClusterPolicyBinding
GET /oapi/v1/clusterpolicybindings/{name}
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 |
replace the specified ClusterPolicyBinding
PUT /oapi/v1/clusterpolicybindings/{name}
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 |
delete a ClusterPolicyBinding
DELETE /oapi/v1/clusterpolicybindings/{name}
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 |
partially update the specified ClusterPolicyBinding
PATCH /oapi/v1/clusterpolicybindings/{name}
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 |
list objects of kind ClusterRoleBinding
GET /oapi/v1/clusterrolebindings
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 |
create a ClusterRoleBinding
POST /oapi/v1/clusterrolebindings
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
read the specified ClusterRoleBinding
GET /oapi/v1/clusterrolebindings/{name}
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 |
replace the specified ClusterRoleBinding
PUT /oapi/v1/clusterrolebindings/{name}
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 |
delete a ClusterRoleBinding
DELETE /oapi/v1/clusterrolebindings/{name}
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 |
partially update the specified ClusterRoleBinding
PATCH /oapi/v1/clusterrolebindings/{name}
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 |
list objects of kind ClusterRole
GET /oapi/v1/clusterroles
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 |
create a ClusterRole
POST /oapi/v1/clusterroles
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
read the specified ClusterRole
GET /oapi/v1/clusterroles/{name}
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 |
replace the specified ClusterRole
PUT /oapi/v1/clusterroles/{name}
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 |
delete a ClusterRole
DELETE /oapi/v1/clusterroles/{name}
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 |
partially update the specified ClusterRole
PATCH /oapi/v1/clusterroles/{name}
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 |
create a DeploymentConfigRollback
POST /oapi/v1/deploymentconfigrollbacks
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list or watch objects of kind DeploymentConfig
GET /oapi/v1/deploymentconfigs
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 |
create a DeploymentConfig
POST /oapi/v1/deploymentconfigs
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list or watch objects of kind Group
GET /oapi/v1/groups
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 |
create a Group
POST /oapi/v1/groups
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
read the specified Group
GET /oapi/v1/groups/{name}
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 |
replace the specified Group
PUT /oapi/v1/groups/{name}
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 |
delete a Group
DELETE /oapi/v1/groups/{name}
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 |
partially update the specified Group
PATCH /oapi/v1/groups/{name}
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 |
list or watch objects of kind HostSubnet
GET /oapi/v1/hostsubnets
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 |
create a HostSubnet
POST /oapi/v1/hostsubnets
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
read the specified HostSubnet
GET /oapi/v1/hostsubnets/{name}
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 |
replace the specified HostSubnet
PUT /oapi/v1/hostsubnets/{name}
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 |
delete a HostSubnet
DELETE /oapi/v1/hostsubnets/{name}
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 |
partially update the specified HostSubnet
PATCH /oapi/v1/hostsubnets/{name}
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 |
list or watch objects of kind Identity
GET /oapi/v1/identities
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 |
create a Identity
POST /oapi/v1/identities
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
read the specified Identity
GET /oapi/v1/identities/{name}
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 |
replace the specified Identity
PUT /oapi/v1/identities/{name}
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 |
delete a Identity
DELETE /oapi/v1/identities/{name}
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 |
partially update the specified Identity
PATCH /oapi/v1/identities/{name}
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 |
list or watch objects of kind Image
GET /oapi/v1/images
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 |
create a Image
POST /oapi/v1/images
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
read the specified Image
GET /oapi/v1/images/{name}
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 |
replace the specified Image
PUT /oapi/v1/images/{name}
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 |
delete a Image
DELETE /oapi/v1/images/{name}
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 |
partially update the specified Image
PATCH /oapi/v1/images/{name}
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 |
create a ImageStreamMapping
POST /oapi/v1/imagestreammappings
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list or watch objects of kind ImageStream
GET /oapi/v1/imagestreams
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 |
create a ImageStream
POST /oapi/v1/imagestreams
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list objects of kind ImageStreamTag
GET /oapi/v1/imagestreamtags
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 |
create a LocalResourceAccessReview
POST /oapi/v1/localresourceaccessreviews
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
create a LocalSubjectAccessReview
POST /oapi/v1/localsubjectaccessreviews
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list or watch objects of kind BuildConfig
GET /oapi/v1/namespaces/{namespace}/buildconfigs
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 |
create a BuildConfig
POST /oapi/v1/namespaces/{namespace}/buildconfigs
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 |
read the specified BuildConfig
GET /oapi/v1/namespaces/{namespace}/buildconfigs/{name}
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 |
replace the specified BuildConfig
PUT /oapi/v1/namespaces/{namespace}/buildconfigs/{name}
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 |
delete a BuildConfig
DELETE /oapi/v1/namespaces/{namespace}/buildconfigs/{name}
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 |
partially update the specified BuildConfig
PATCH /oapi/v1/namespaces/{namespace}/buildconfigs/{name}
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 |
create instantiate of a BuildRequest
POST /oapi/v1/namespaces/{namespace}/buildconfigs/{name}/instantiate
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 |
connect POST requests to instantiatebinary of BinaryBuildRequestOptions
POST /oapi/v1/namespaces/{namespace}/buildconfigs/{name}/instantiatebinary
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 |
connect POST requests to webhooks of Status
POST /oapi/v1/namespaces/{namespace}/buildconfigs/{name}/webhooks
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 |
connect POST requests to webhooks of Status
POST /oapi/v1/namespaces/{namespace}/buildconfigs/{name}/webhooks/{path:*}
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 |
list or watch objects of kind Build
GET /oapi/v1/namespaces/{namespace}/builds
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 |
create a Build
POST /oapi/v1/namespaces/{namespace}/builds
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 |
read the specified Build
GET /oapi/v1/namespaces/{namespace}/builds/{name}
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 |
replace the specified Build
PUT /oapi/v1/namespaces/{namespace}/builds/{name}
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 |
delete a Build
DELETE /oapi/v1/namespaces/{namespace}/builds/{name}
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 |
partially update the specified Build
PATCH /oapi/v1/namespaces/{namespace}/builds/{name}
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 |
create clone of a BuildRequest
POST /oapi/v1/namespaces/{namespace}/builds/{name}/clone
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 |
read log of the specified BuildLog
GET /oapi/v1/namespaces/{namespace}/builds/{name}/log
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 |
create a DeploymentConfigRollback
POST /oapi/v1/namespaces/{namespace}/deploymentconfigrollbacks
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 |
list or watch objects of kind DeploymentConfig
GET /oapi/v1/namespaces/{namespace}/deploymentconfigs
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 |
create a DeploymentConfig
POST /oapi/v1/namespaces/{namespace}/deploymentconfigs
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 |
read the specified DeploymentConfig
GET /oapi/v1/namespaces/{namespace}/deploymentconfigs/{name}
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 |
replace the specified DeploymentConfig
PUT /oapi/v1/namespaces/{namespace}/deploymentconfigs/{name}
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 |
delete a DeploymentConfig
DELETE /oapi/v1/namespaces/{namespace}/deploymentconfigs/{name}
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 |
partially update the specified DeploymentConfig
PATCH /oapi/v1/namespaces/{namespace}/deploymentconfigs/{name}
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 |
read log of the specified DeploymentLog
GET /oapi/v1/namespaces/{namespace}/deploymentconfigs/{name}/log
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 |
read the specified DeploymentConfig
GET /oapi/v1/namespaces/{namespace}/generatedeploymentconfigs/{name}
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 |
read the specified ImageStreamImage
GET /oapi/v1/namespaces/{namespace}/imagestreamimages/{name}
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 |
create a ImageStreamMapping
POST /oapi/v1/namespaces/{namespace}/imagestreammappings
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 |
list or watch objects of kind ImageStream
GET /oapi/v1/namespaces/{namespace}/imagestreams
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 |
create a ImageStream
POST /oapi/v1/namespaces/{namespace}/imagestreams
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 |
read the specified ImageStream
GET /oapi/v1/namespaces/{namespace}/imagestreams/{name}
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 |
replace the specified ImageStream
PUT /oapi/v1/namespaces/{namespace}/imagestreams/{name}
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 |
delete a ImageStream
DELETE /oapi/v1/namespaces/{namespace}/imagestreams/{name}
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 |
partially update the specified ImageStream
PATCH /oapi/v1/namespaces/{namespace}/imagestreams/{name}
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 |
replace status of the specified ImageStream
PUT /oapi/v1/namespaces/{namespace}/imagestreams/{name}/status
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 |
list objects of kind ImageStreamTag
GET /oapi/v1/namespaces/{namespace}/imagestreamtags
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 |
read the specified ImageStreamTag
GET /oapi/v1/namespaces/{namespace}/imagestreamtags/{name}
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 |
replace the specified ImageStreamTag
PUT /oapi/v1/namespaces/{namespace}/imagestreamtags/{name}
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 |
delete a ImageStreamTag
DELETE /oapi/v1/namespaces/{namespace}/imagestreamtags/{name}
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 |
partially update the specified ImageStreamTag
PATCH /oapi/v1/namespaces/{namespace}/imagestreamtags/{name}
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 |
create a LocalResourceAccessReview
POST /oapi/v1/namespaces/{namespace}/localresourceaccessreviews
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 |
create a LocalSubjectAccessReview
POST /oapi/v1/namespaces/{namespace}/localsubjectaccessreviews
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 |
list or watch objects of kind Policy
GET /oapi/v1/namespaces/{namespace}/policies
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 |
create a Policy
POST /oapi/v1/namespaces/{namespace}/policies
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 |
read the specified Policy
GET /oapi/v1/namespaces/{namespace}/policies/{name}
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 |
replace the specified Policy
PUT /oapi/v1/namespaces/{namespace}/policies/{name}
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 |
delete a Policy
DELETE /oapi/v1/namespaces/{namespace}/policies/{name}
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 |
partially update the specified Policy
PATCH /oapi/v1/namespaces/{namespace}/policies/{name}
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 |
list or watch objects of kind PolicyBinding
GET /oapi/v1/namespaces/{namespace}/policybindings
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 |
create a PolicyBinding
POST /oapi/v1/namespaces/{namespace}/policybindings
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 |
read the specified PolicyBinding
GET /oapi/v1/namespaces/{namespace}/policybindings/{name}
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 |
replace the specified PolicyBinding
PUT /oapi/v1/namespaces/{namespace}/policybindings/{name}
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 |
delete a PolicyBinding
DELETE /oapi/v1/namespaces/{namespace}/policybindings/{name}
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 |
partially update the specified PolicyBinding
PATCH /oapi/v1/namespaces/{namespace}/policybindings/{name}
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 |
create a Template
POST /oapi/v1/namespaces/{namespace}/processedtemplates
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 |
create a ResourceAccessReview
POST /oapi/v1/namespaces/{namespace}/resourceaccessreviews
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 |
list objects of kind RoleBinding
GET /oapi/v1/namespaces/{namespace}/rolebindings
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 |
create a RoleBinding
POST /oapi/v1/namespaces/{namespace}/rolebindings
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 |
read the specified RoleBinding
GET /oapi/v1/namespaces/{namespace}/rolebindings/{name}
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 |
replace the specified RoleBinding
PUT /oapi/v1/namespaces/{namespace}/rolebindings/{name}
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 |
delete a RoleBinding
DELETE /oapi/v1/namespaces/{namespace}/rolebindings/{name}
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 |
partially update the specified RoleBinding
PATCH /oapi/v1/namespaces/{namespace}/rolebindings/{name}
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 |
list objects of kind Role
GET /oapi/v1/namespaces/{namespace}/roles
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 |
create a Role
POST /oapi/v1/namespaces/{namespace}/roles
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 |
read the specified Role
GET /oapi/v1/namespaces/{namespace}/roles/{name}
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 |
replace the specified Role
PUT /oapi/v1/namespaces/{namespace}/roles/{name}
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 |
delete a Role
DELETE /oapi/v1/namespaces/{namespace}/roles/{name}
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 |
partially update the specified Role
PATCH /oapi/v1/namespaces/{namespace}/roles/{name}
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 |
list or watch objects of kind Route
GET /oapi/v1/namespaces/{namespace}/routes
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 |
create a Route
POST /oapi/v1/namespaces/{namespace}/routes
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 |
read the specified Route
GET /oapi/v1/namespaces/{namespace}/routes/{name}
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 |
replace the specified Route
PUT /oapi/v1/namespaces/{namespace}/routes/{name}
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 |
delete a Route
DELETE /oapi/v1/namespaces/{namespace}/routes/{name}
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 |
partially update the specified Route
PATCH /oapi/v1/namespaces/{namespace}/routes/{name}
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 |
replace status of the specified Route
PUT /oapi/v1/namespaces/{namespace}/routes/{name}/status
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 |
create a SubjectAccessReview
POST /oapi/v1/namespaces/{namespace}/subjectaccessreviews
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 |
list or watch objects of kind Template
GET /oapi/v1/namespaces/{namespace}/templates
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 |
create a Template
POST /oapi/v1/namespaces/{namespace}/templates
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 |
read the specified Template
GET /oapi/v1/namespaces/{namespace}/templates/{name}
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 |
replace the specified Template
PUT /oapi/v1/namespaces/{namespace}/templates/{name}
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 |
delete a Template
DELETE /oapi/v1/namespaces/{namespace}/templates/{name}
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 |
partially update the specified Template
PATCH /oapi/v1/namespaces/{namespace}/templates/{name}
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 |
list or watch objects of kind NetNamespace
GET /oapi/v1/netnamespaces
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 |
create a NetNamespace
POST /oapi/v1/netnamespaces
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
read the specified NetNamespace
GET /oapi/v1/netnamespaces/{name}
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 |
replace the specified NetNamespace
PUT /oapi/v1/netnamespaces/{name}
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 |
delete a NetNamespace
DELETE /oapi/v1/netnamespaces/{name}
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 |
partially update the specified NetNamespace
PATCH /oapi/v1/netnamespaces/{name}
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 |
list objects of kind OAuthAccessToken
GET /oapi/v1/oauthaccesstokens
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 |
create a OAuthAccessToken
POST /oapi/v1/oauthaccesstokens
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
read the specified OAuthAccessToken
GET /oapi/v1/oauthaccesstokens/{name}
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 |
delete a OAuthAccessToken
DELETE /oapi/v1/oauthaccesstokens/{name}
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 |
list objects of kind OAuthAuthorizeToken
GET /oapi/v1/oauthauthorizetokens
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 |
create a OAuthAuthorizeToken
POST /oapi/v1/oauthauthorizetokens
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
read the specified OAuthAuthorizeToken
GET /oapi/v1/oauthauthorizetokens/{name}
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 |
delete a OAuthAuthorizeToken
DELETE /oapi/v1/oauthauthorizetokens/{name}
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 |
list or watch objects of kind OAuthClientAuthorization
GET /oapi/v1/oauthclientauthorizations
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 |
create a OAuthClientAuthorization
POST /oapi/v1/oauthclientauthorizations
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
read the specified OAuthClientAuthorization
GET /oapi/v1/oauthclientauthorizations/{name}
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 |
replace the specified OAuthClientAuthorization
PUT /oapi/v1/oauthclientauthorizations/{name}
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 |
delete a OAuthClientAuthorization
DELETE /oapi/v1/oauthclientauthorizations/{name}
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 |
partially update the specified OAuthClientAuthorization
PATCH /oapi/v1/oauthclientauthorizations/{name}
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 |
list or watch objects of kind OAuthClient
GET /oapi/v1/oauthclients
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 |
create a OAuthClient
POST /oapi/v1/oauthclients
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
read the specified OAuthClient
GET /oapi/v1/oauthclients/{name}
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 |
replace the specified OAuthClient
PUT /oapi/v1/oauthclients/{name}
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 |
delete a OAuthClient
DELETE /oapi/v1/oauthclients/{name}
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 |
partially update the specified OAuthClient
PATCH /oapi/v1/oauthclients/{name}
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 |
list or watch objects of kind Policy
GET /oapi/v1/policies
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 |
create a Policy
POST /oapi/v1/policies
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list or watch objects of kind PolicyBinding
GET /oapi/v1/policybindings
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 |
create a PolicyBinding
POST /oapi/v1/policybindings
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
create a Template
POST /oapi/v1/processedtemplates
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list objects of kind ProjectRequest
GET /oapi/v1/projectrequests
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 |
create a ProjectRequest
POST /oapi/v1/projectrequests
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list objects of kind Project
GET /oapi/v1/projects
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 |
create a Project
POST /oapi/v1/projects
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
read the specified Project
GET /oapi/v1/projects/{name}
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 |
replace the specified Project
PUT /oapi/v1/projects/{name}
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 |
delete a Project
DELETE /oapi/v1/projects/{name}
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 |
partially update the specified Project
PATCH /oapi/v1/projects/{name}
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 |
create a ResourceAccessReview
POST /oapi/v1/resourceaccessreviews
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list objects of kind RoleBinding
GET /oapi/v1/rolebindings
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 |
create a RoleBinding
POST /oapi/v1/rolebindings
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list objects of kind Role
GET /oapi/v1/roles
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 |
create a Role
POST /oapi/v1/roles
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list or watch objects of kind Route
GET /oapi/v1/routes
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 |
create a Route
POST /oapi/v1/routes
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
create a SubjectAccessReview
POST /oapi/v1/subjectaccessreviews
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list or watch objects of kind Template
GET /oapi/v1/templates
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 |
create a Template
POST /oapi/v1/templates
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
create a UserIdentityMapping
POST /oapi/v1/useridentitymappings
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
read the specified UserIdentityMapping
GET /oapi/v1/useridentitymappings/{name}
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 |
replace the specified UserIdentityMapping
PUT /oapi/v1/useridentitymappings/{name}
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 |
delete a UserIdentityMapping
DELETE /oapi/v1/useridentitymappings/{name}
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 |
partially update the specified UserIdentityMapping
PATCH /oapi/v1/useridentitymappings/{name}
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 |
list or watch objects of kind User
GET /oapi/v1/users
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 |
create a User
POST /oapi/v1/users
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
read the specified User
GET /oapi/v1/users/{name}
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 |
replace the specified User
PUT /oapi/v1/users/{name}
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 |
delete a User
DELETE /oapi/v1/users/{name}
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 |
partially update the specified User
PATCH /oapi/v1/users/{name}
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 |
watch individual changes to a list of BuildConfig
GET /oapi/v1/watch/buildconfigs
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 |
watch individual changes to a list of Build
GET /oapi/v1/watch/builds
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 |
watch individual changes to a list of ClusterNetwork
GET /oapi/v1/watch/clusternetworks
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 |
watch changes to an object of kind ClusterNetwork
GET /oapi/v1/watch/clusternetworks/{name}
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 |
watch individual changes to a list of ClusterPolicy
GET /oapi/v1/watch/clusterpolicies
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 |
watch changes to an object of kind ClusterPolicy
GET /oapi/v1/watch/clusterpolicies/{name}
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 |
watch individual changes to a list of ClusterPolicyBinding
GET /oapi/v1/watch/clusterpolicybindings
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 |
watch changes to an object of kind ClusterPolicyBinding
GET /oapi/v1/watch/clusterpolicybindings/{name}
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 |
watch individual changes to a list of DeploymentConfig
GET /oapi/v1/watch/deploymentconfigs
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 |
watch individual changes to a list of Group
GET /oapi/v1/watch/groups
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 |
watch changes to an object of kind Group
GET /oapi/v1/watch/groups/{name}
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 |
watch individual changes to a list of HostSubnet
GET /oapi/v1/watch/hostsubnets
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 |
watch changes to an object of kind HostSubnet
GET /oapi/v1/watch/hostsubnets/{name}
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 |
watch individual changes to a list of Identity
GET /oapi/v1/watch/identities
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 |
watch changes to an object of kind Identity
GET /oapi/v1/watch/identities/{name}
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 |
watch individual changes to a list of Image
GET /oapi/v1/watch/images
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 |
watch changes to an object of kind Image
GET /oapi/v1/watch/images/{name}
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 |
watch individual changes to a list of ImageStream
GET /oapi/v1/watch/imagestreams
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 |
watch individual changes to a list of BuildConfig
GET /oapi/v1/watch/namespaces/{namespace}/buildconfigs
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 |
watch changes to an object of kind BuildConfig
GET /oapi/v1/watch/namespaces/{namespace}/buildconfigs/{name}
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 |
watch individual changes to a list of Build
GET /oapi/v1/watch/namespaces/{namespace}/builds
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 |
watch changes to an object of kind Build
GET /oapi/v1/watch/namespaces/{namespace}/builds/{name}
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 |
watch individual changes to a list of DeploymentConfig
GET /oapi/v1/watch/namespaces/{namespace}/deploymentconfigs
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 |
watch changes to an object of kind DeploymentConfig
GET /oapi/v1/watch/namespaces/{namespace}/deploymentconfigs/{name}
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 |
watch individual changes to a list of ImageStream
GET /oapi/v1/watch/namespaces/{namespace}/imagestreams
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 |
watch changes to an object of kind ImageStream
GET /oapi/v1/watch/namespaces/{namespace}/imagestreams/{name}
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 |
watch individual changes to a list of Policy
GET /oapi/v1/watch/namespaces/{namespace}/policies
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 |
watch changes to an object of kind Policy
GET /oapi/v1/watch/namespaces/{namespace}/policies/{name}
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 |
watch individual changes to a list of PolicyBinding
GET /oapi/v1/watch/namespaces/{namespace}/policybindings
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 |
watch changes to an object of kind PolicyBinding
GET /oapi/v1/watch/namespaces/{namespace}/policybindings/{name}
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 |
watch individual changes to a list of Route
GET /oapi/v1/watch/namespaces/{namespace}/routes
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 |
watch changes to an object of kind Route
GET /oapi/v1/watch/namespaces/{namespace}/routes/{name}
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 |
watch individual changes to a list of Template
GET /oapi/v1/watch/namespaces/{namespace}/templates
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 |
watch changes to an object of kind Template
GET /oapi/v1/watch/namespaces/{namespace}/templates/{name}
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 |
watch individual changes to a list of NetNamespace
GET /oapi/v1/watch/netnamespaces
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 |
watch changes to an object of kind NetNamespace
GET /oapi/v1/watch/netnamespaces/{name}
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 |
watch individual changes to a list of OAuthClientAuthorization
GET /oapi/v1/watch/oauthclientauthorizations
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 |
watch changes to an object of kind OAuthClientAuthorization
GET /oapi/v1/watch/oauthclientauthorizations/{name}
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 |
watch individual changes to a list of OAuthClient
GET /oapi/v1/watch/oauthclients
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 |
watch changes to an object of kind OAuthClient
GET /oapi/v1/watch/oauthclients/{name}
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 |
watch individual changes to a list of Policy
GET /oapi/v1/watch/policies
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 |
watch individual changes to a list of PolicyBinding
GET /oapi/v1/watch/policybindings
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 |
watch individual changes to a list of Route
GET /oapi/v1/watch/routes
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 |
watch individual changes to a list of Template
GET /oapi/v1/watch/templates
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 |
watch individual changes to a list of User
GET /oapi/v1/watch/users
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 |
watch changes to an object of kind User
GET /oapi/v1/watch/users/{name}
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 |
Definitions
v1.MetadataVolumeSource
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
items |
list of metadata files |
false |
v1.MetadataFile array |
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 |
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 |
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 |
v1.HostSubnet array |
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 |
v1.Group array |
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 |
v1.PolicyBinding array |
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 |
v1.ClusterRole array |
v1.SourceRevision
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
type |
type of the build source |
true |
string |
|
git |
information about git-based build source |
false |
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 |
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 |
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 |
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 |
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) |
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 |
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 |
v1.NetNamespace array |
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 |
v1.ImageStreamTag array |
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 |
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 |
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 |
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 |
v1.Policy array |
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 |
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) |
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 |
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 |
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 |
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 |
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 |
v1.Capabilities
Adds and removes POSIX capabilities from running containers.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
add |
Added capabilities |
false |
v1.Capability array |
|
drop |
Removed capabilities |
false |
v1.Capability array |
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 |
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 |
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 |
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 |
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) |
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 |
v1.BuildConfig array |
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 |
unversioned.StatusCause array |
|
retryAfterSeconds |
If specified, the time in seconds before the operation should be retried. |
false |
integer (int32) |
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 |
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 |
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 |
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 |
v1.ClusterNetwork array |
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 |
v1.Image array |
unversioned.Patch
Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
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 |
v1.NamedTagEventList array |
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 |
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 |
v1.PolicyRule array |
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 |
v1.ObjectReference array |
|
roleRef |
reference to the policy role |
true |
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 |
v1.OAuthClient array |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
v1.DeploymentConfig array |
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 |
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 |
v1.OAuthAuthorizeToken array |
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 |
v1.Template array |
v1.ProjectStatus
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
phase |
phase is the current lifecycle phase of the project |
false |
string |
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 |
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 |
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 |
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 |
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 |
v1.ContainerPort array |
|
env |
List of environment variables to set in the container. Cannot be updated. |
false |
v1.EnvVar array |
|
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 |
v1.VolumeMount array |
|
livenessProbe |
Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://releases.k8s.io/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 |
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 |
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 |
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 |
v1.Volume array |
|
containers |
List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/containers.md |
true |
v1.Container array |
|
restartPolicy |
Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://releases.k8s.io/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 |
v1.LocalObjectReference array |
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 |
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 |
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 |
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 |
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 |
v1.NamedTagReference array |
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 |
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 |
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 |
v1.NamedRole
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
name of the role |
true |
string |
|
role |
the role |
true |
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 |
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 |
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 |
runtime.RawExtension array |
|
parameters |
optional: list of parameters used during template to config transformation |
false |
v1.Parameter array |
|
labels |
optional: list of lables that are applied to every object during the template to config transformation |
false |
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 |
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 |
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 |
v1.NamedClusterRole array |
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 |
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 |
v1.User array |
v1.LifecycleHook
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
failurePolicy |
what action to take if the hook fails |
true |
string |
|
execNewPod |
options for an ExecNewPodHook |
false |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
v1.ImageStream array |
v1.DeploymentCauseImageTrigger
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
from |
a reference the changed object which triggered a deployment |
true |
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 |
integer array |
|
fsGroup |
A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: |
false |
integer (int64) |
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 |
v1.Identity array |
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
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 |
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 |
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 |
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 |
v1.Build array |
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 |
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 |
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 |
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 |
v1.WebHookTrigger
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
secret |
secret used to validate requests |
false |
string |
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 |
v1.DeploymentCause array |
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) |
v1.NamedClusterRoleBinding
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
name of the cluster role binding |
true |
string |
|
roleBinding |
the cluster role binding |
true |
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 |
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 |
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 |
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 |
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 |
v1.NamedClusterRole
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
name of the cluster role |
true |
string |
|
role |
the cluster role |
true |
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 |
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 |
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 |
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) |
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 |
v1.ClusterPolicyBinding array |
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 |
v1.NamedTagEventList
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
tag |
the tag |
true |
string |
|
items |
list of tag events related to the tag |
true |
v1.TagEvent array |
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 |
v1.NamedRoleBinding
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
name of the roleBinding |
true |
string |
|
roleBinding |
the roleBinding |
true |
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 |
v1.DownwardAPIVolumeFile array |
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 |
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 |
v1.EnvVar array |
|
scripts |
location of the source scripts |
false |
string |
|
incremental |
forces the source build to do incremental builds if true |
false |
boolean |
false |
forcePull |
forces the source build to pull the image if true |
false |
boolean |
false |
v1.BuildConfigStatus
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
lastVersion |
used to inform about number of last triggered build |
true |
integer (int32) |
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 |
v1.EnvVar array |
|
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 |
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 |
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 |
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 |
v1.EnvVar array |
|
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 |
v1.DeploymentTriggerPolicy
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
type |
the type of the trigger |
false |
string |
|
imageChangeParams |
input to the ImageChange trigger |
false |
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 |
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 |
v1.ClusterRoleBinding array |
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 |
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 |
v1.OAuthAccessToken array |
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 |
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 |
v1.Role array |
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 |
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 |
v1.ObjectReference array |
|
roleRef |
a reference to a role |
true |
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 |
v1.BuildTriggerPolicy array |
|
serviceAccount |
the name of the service account to use to run pods created by the build, pod will be allowed to use secrets referenced by the service account |
false |
string |
|
source |
describes the source control management system in use |
false |
||
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) |
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 |
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 |
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 |
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 |
v1.ClusterPolicy array |
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 |
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 |
v1.EnvVar array |
|
exposeDockerSocket |
allow running Docker commands (and build Docker images) from inside the container |
false |
boolean |
false |
forcePull |
forces pulling of builder image from remote registry if true |
false |
boolean |
false |
secrets |
a list of secrets to include in the build pod in addition to pull, push and source secrets |
false |
v1.SecretSpec array |
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 |
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 |
v1.Project array |
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 |
v1.EnvVar array |
|
command |
optionally overrides the container command (default is specified by the image) |
false |
string array |
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 |
v1.PolicyRule array |
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 |
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 |
runtime.RawExtension
this may be any JSON object with a 'kind' and 'apiVersion' field; and is preserved unmodified by processing
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 |
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 |
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 |
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 |
v1.NamedRole array |
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 |
v1.NamedRoleBinding array |
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 |
v1.Route array |
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 |
v1.RoleBinding array |
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 |
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 |
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 |
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 |
v1.ProjectSpec
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
finalizers |
an opaque list of values that must be empty to permanently remove object from storage |
false |
v1.FinalizerName array |
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 |