×

Overview

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

Version information

Version: v1

URI scheme

Host: 127.0.0.1:8443 BasePath: / Schemes: HTTPS

Paths

get available resources

GET /oapi/v1

Responses

HTTP Code Description Schema

default

success

unversioned.APIResourceList

Consumes

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

list objects of kind AppliedClusterResourceQuota

GET /oapi/v1/appliedclusterresourcequotas

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.AppliedClusterResourceQuotaList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.BuildConfigList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

v1.BuildConfig

Responses

HTTP Code Description Schema

200

success

v1.BuildConfig

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.BuildList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

v1.Build

Responses

HTTP Code Description Schema

200

success

v1.Build

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete collection of ClusterNetwork

DELETE /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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.ClusterNetworkList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

v1.ClusterNetwork

Responses

HTTP Code Description Schema

200

success

v1.ClusterNetwork

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

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

false

integer

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

name

name of the ClusterNetwork

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.ClusterNetwork

PathParameter

name

name of the ClusterNetwork

true

string

Responses

HTTP Code Description Schema

200

success

v1.ClusterNetwork

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

export

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

false

boolean

QueryParameter

exact

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

false

boolean

PathParameter

name

name of the ClusterNetwork

true

string

Responses

HTTP Code Description Schema

200

success

v1.ClusterNetwork

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

unversioned.Patch

PathParameter

name

name of the ClusterNetwork

true

string

Responses

HTTP Code Description Schema

200

success

v1.ClusterNetwork

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete collection of ClusterPolicy

DELETE /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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.ClusterPolicyList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

v1.ClusterPolicy

Responses

HTTP Code Description Schema

200

success

v1.ClusterPolicy

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

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

false

integer

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

name

name of the ClusterPolicy

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.ClusterPolicy

PathParameter

name

name of the ClusterPolicy

true

string

Responses

HTTP Code Description Schema

200

success

v1.ClusterPolicy

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

export

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

false

boolean

QueryParameter

exact

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

false

boolean

PathParameter

name

name of the ClusterPolicy

true

string

Responses

HTTP Code Description Schema

200

success

v1.ClusterPolicy

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

unversioned.Patch

PathParameter

name

name of the ClusterPolicy

true

string

Responses

HTTP Code Description Schema

200

success

v1.ClusterPolicy

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete collection of ClusterPolicyBinding

DELETE /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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.ClusterPolicyBindingList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

v1.ClusterPolicyBinding

Responses

HTTP Code Description Schema

200

success

v1.ClusterPolicyBinding

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

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

false

integer

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

name

name of the ClusterPolicyBinding

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.ClusterPolicyBinding

PathParameter

name

name of the ClusterPolicyBinding

true

string

Responses

HTTP Code Description Schema

200

success

v1.ClusterPolicyBinding

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

export

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

false

boolean

QueryParameter

exact

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

false

boolean

PathParameter

name

name of the ClusterPolicyBinding

true

string

Responses

HTTP Code Description Schema

200

success

v1.ClusterPolicyBinding

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

unversioned.Patch

PathParameter

name

name of the ClusterPolicyBinding

true

string

Responses

HTTP Code Description Schema

200

success

v1.ClusterPolicyBinding

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete collection of ClusterResourceQuota

DELETE /oapi/v1/clusterresourcequotas

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

list or watch objects of kind ClusterResourceQuota

GET /oapi/v1/clusterresourcequotas

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.ClusterResourceQuotaList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

create a ClusterResourceQuota

POST /oapi/v1/clusterresourcequotas

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.ClusterResourceQuota

Responses

HTTP Code Description Schema

200

success

v1.ClusterResourceQuota

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete a ClusterResourceQuota

DELETE /oapi/v1/clusterresourcequotas/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

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

false

integer

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

name

name of the ClusterResourceQuota

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

replace the specified ClusterResourceQuota

PUT /oapi/v1/clusterresourcequotas/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.ClusterResourceQuota

PathParameter

name

name of the ClusterResourceQuota

true

string

Responses

HTTP Code Description Schema

200

success

v1.ClusterResourceQuota

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

read the specified ClusterResourceQuota

GET /oapi/v1/clusterresourcequotas/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

QueryParameter

export

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

false

boolean

QueryParameter

exact

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

false

boolean

PathParameter

name

name of the ClusterResourceQuota

true

string

Responses

HTTP Code Description Schema

200

success

v1.ClusterResourceQuota

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

partially update the specified ClusterResourceQuota

PATCH /oapi/v1/clusterresourcequotas/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the ClusterResourceQuota

true

string

Responses

HTTP Code Description Schema

200

success

v1.ClusterResourceQuota

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

replace status of the specified ClusterResourceQuota

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.ClusterResourceQuota

PathParameter

name

name of the ClusterResourceQuota

true

string

Responses

HTTP Code Description Schema

200

success

v1.ClusterResourceQuota

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

read status of the specified ClusterResourceQuota

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

PathParameter

name

name of the ClusterResourceQuota

true

string

Responses

HTTP Code Description Schema

200

success

v1.ClusterResourceQuota

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

partially update status of the specified ClusterResourceQuota

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the ClusterResourceQuota

true

string

Responses

HTTP Code Description Schema

200

success

v1.ClusterResourceQuota

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.ClusterRoleBindingList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

v1.ClusterRoleBinding

Responses

HTTP Code Description Schema

200

success

v1.ClusterRoleBinding

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

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

false

integer

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

name

name of the ClusterRoleBinding

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.ClusterRoleBinding

PathParameter

name

name of the ClusterRoleBinding

true

string

Responses

HTTP Code Description Schema

200

success

v1.ClusterRoleBinding

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

Responses

HTTP Code Description Schema

200

success

v1.ClusterRoleBinding

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

unversioned.Patch

PathParameter

name

name of the ClusterRoleBinding

true

string

Responses

HTTP Code Description Schema

200

success

v1.ClusterRoleBinding

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.ClusterRoleList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

v1.ClusterRole

Responses

HTTP Code Description Schema

200

success

v1.ClusterRole

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

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

false

integer

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

name

name of the ClusterRole

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.ClusterRole

PathParameter

name

name of the ClusterRole

true

string

Responses

HTTP Code Description Schema

200

success

v1.ClusterRole

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

Responses

HTTP Code Description Schema

200

success

v1.ClusterRole

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

unversioned.Patch

PathParameter

name

name of the ClusterRole

true

string

Responses

HTTP Code Description Schema

200

success

v1.ClusterRole

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.DeploymentConfigRollback

Responses

HTTP Code Description Schema

200

success

v1.DeploymentConfigRollback

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.DeploymentConfigList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

v1.DeploymentConfig

Responses

HTTP Code Description Schema

200

success

v1.DeploymentConfig

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

list or watch objects of kind EgressNetworkPolicy

GET /oapi/v1/egressnetworkpolicies

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.EgressNetworkPolicyList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

create an EgressNetworkPolicy

POST /oapi/v1/egressnetworkpolicies

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.EgressNetworkPolicy

Responses

HTTP Code Description Schema

200

success

v1.EgressNetworkPolicy

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete collection of Group

DELETE /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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.GroupList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

v1.Group

Responses

HTTP Code Description Schema

200

success

v1.Group

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

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

false

integer

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

name

name of the Group

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.Group

PathParameter

name

name of the Group

true

string

Responses

HTTP Code Description Schema

200

success

v1.Group

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

export

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

false

boolean

QueryParameter

exact

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

false

boolean

PathParameter

name

name of the Group

true

string

Responses

HTTP Code Description Schema

200

success

v1.Group

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

unversioned.Patch

PathParameter

name

name of the Group

true

string

Responses

HTTP Code Description Schema

200

success

v1.Group

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete collection of HostSubnet

DELETE /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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.HostSubnetList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

v1.HostSubnet

Responses

HTTP Code Description Schema

200

success

v1.HostSubnet

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

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

false

integer

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

name

name of the HostSubnet

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.HostSubnet

PathParameter

name

name of the HostSubnet

true

string

Responses

HTTP Code Description Schema

200

success

v1.HostSubnet

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

export

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

false

boolean

QueryParameter

exact

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

false

boolean

PathParameter

name

name of the HostSubnet

true

string

Responses

HTTP Code Description Schema

200

success

v1.HostSubnet

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

unversioned.Patch

PathParameter

name

name of the HostSubnet

true

string

Responses

HTTP Code Description Schema

200

success

v1.HostSubnet

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete collection of Identity

DELETE /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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.IdentityList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

create an 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

v1.Identity

Responses

HTTP Code Description Schema

200

success

v1.Identity

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete an 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

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

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

false

integer

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

name

name of the Identity

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.Identity

PathParameter

name

name of the Identity

true

string

Responses

HTTP Code Description Schema

200

success

v1.Identity

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

export

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

false

boolean

QueryParameter

exact

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

false

boolean

PathParameter

name

name of the Identity

true

string

Responses

HTTP Code Description Schema

200

success

v1.Identity

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

unversioned.Patch

PathParameter

name

name of the Identity

true

string

Responses

HTTP Code Description Schema

200

success

v1.Identity

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete collection of Image

DELETE /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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.ImageList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

create an 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

v1.Image

Responses

HTTP Code Description Schema

200

success

v1.Image

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete an 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

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

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

false

integer

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

name

name of the Image

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.Image

PathParameter

name

name of the Image

true

string

Responses

HTTP Code Description Schema

200

success

v1.Image

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

export

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

false

boolean

QueryParameter

exact

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

false

boolean

PathParameter

name

name of the Image

true

string

Responses

HTTP Code Description Schema

200

success

v1.Image

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

unversioned.Patch

PathParameter

name

name of the Image

true

string

Responses

HTTP Code Description Schema

200

success

v1.Image

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

create an ImageSignature

POST /oapi/v1/imagesignatures

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.ImageSignature

Responses

HTTP Code Description Schema

200

success

v1.ImageSignature

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete an ImageSignature

DELETE /oapi/v1/imagesignatures/{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 ImageSignature

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

create an ImageStreamImport

POST /oapi/v1/imagestreamimports

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.ImageStreamImport

Responses

HTTP Code Description Schema

200

success

v1.ImageStreamImport

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

create an 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

v1.ImageStreamMapping

Responses

HTTP Code Description Schema

200

success

v1.ImageStreamMapping

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.ImageStreamList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

create an 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

v1.ImageStream

Responses

HTTP Code Description Schema

200

success

v1.ImageStream

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.ImageStreamTagList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

create an ImageStreamTag

POST /oapi/v1/imagestreamtags

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.ImageStreamTag

Responses

HTTP Code Description Schema

200

success

v1.ImageStreamTag

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.LocalResourceAccessReview

Responses

HTTP Code Description Schema

200

success

v1.LocalResourceAccessReview

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.LocalSubjectAccessReview

Responses

HTTP Code Description Schema

200

success

v1.LocalSubjectAccessReview

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

list objects of kind AppliedClusterResourceQuota

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

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.AppliedClusterResourceQuotaList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

read the specified AppliedClusterResourceQuota

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.AppliedClusterResourceQuota

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete collection of BuildConfig

DELETE /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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.BuildConfigList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

v1.BuildConfig

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.BuildConfig

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

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

false

integer

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

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

true

string

PathParameter

name

name of the BuildConfig

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.BuildConfig

PathParameter

namespace

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

true

string

PathParameter

name

name of the BuildConfig

true

string

Responses

HTTP Code Description Schema

200

success

v1.BuildConfig

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

export

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

false

boolean

QueryParameter

exact

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

false

boolean

PathParameter

namespace

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

true

string

PathParameter

name

name of the BuildConfig

true

string

Responses

HTTP Code Description Schema

200

success

v1.BuildConfig

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

unversioned.Patch

PathParameter

namespace

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

true

string

PathParameter

name

name of the BuildConfig

true

string

Responses

HTTP Code Description Schema

200

success

v1.BuildConfig

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.BuildRequest

PathParameter

namespace

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

true

string

PathParameter

name

name of the BuildRequest

true

string

Responses

HTTP Code Description Schema

200

success

v1.BuildRequest

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

connect POST requests to instantiatebinary of BinaryBuildRequestOptions

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

Parameters

Type Name Description Required Schema Default

QueryParameter

asFile

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

false

string

QueryParameter

revision.commit

revision.commit is the value identifying a specific commit

false

string

QueryParameter

revision.message

revision.message is the description of a specific commit

false

string

QueryParameter

revision.authorName

revision.authorName of the source control user

false

string

QueryParameter

revision.authorEmail

revision.authorEmail of the source control user

false

string

QueryParameter

revision.committerName

revision.committerName of the source control user

false

string

QueryParameter

revision.committerEmail

revision.committerEmail of the source control user

false

string

PathParameter

namespace

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

true

string

PathParameter

name

name of the BinaryBuildRequestOptions

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • oapiv1

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

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • oapiv1

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

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • /

Produces

  • /

Tags

  • oapiv1

delete collection of Build

DELETE /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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.BuildList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

v1.Build

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.Build

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

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

false

integer

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

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

true

string

PathParameter

name

name of the Build

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.Build

PathParameter

namespace

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

true

string

PathParameter

name

name of the Build

true

string

Responses

HTTP Code Description Schema

200

success

v1.Build

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

export

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

false

boolean

QueryParameter

exact

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

false

boolean

PathParameter

namespace

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

true

string

PathParameter

name

name of the Build

true

string

Responses

HTTP Code Description Schema

200

success

v1.Build

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

unversioned.Patch

PathParameter

namespace

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

true

string

PathParameter

name

name of the Build

true

string

Responses

HTTP Code Description Schema

200

success

v1.Build

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.BuildRequest

PathParameter

namespace

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

true

string

PathParameter

name

name of the BuildRequest

true

string

Responses

HTTP Code Description Schema

200

success

v1.BuildRequest

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

replace details of the specified Build

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.Build

PathParameter

namespace

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

true

string

PathParameter

name

name of the Build

true

string

Responses

HTTP Code Description Schema

200

success

v1.Build

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

cointainer for which to stream logs. Defaults to only container if there is one container in the pod.

false

string

QueryParameter

follow

follow if true indicates that the build log should be streamed until the build terminates.

false

boolean

QueryParameter

previous

previous returns previous build logs. Defaults to false.

false

boolean

QueryParameter

sinceSeconds

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

false

integer

QueryParameter

sinceTime

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

false

string

QueryParameter

timestamps

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

false

boolean

QueryParameter

tailLines

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

false

integer

QueryParameter

limitBytes

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

false

integer

QueryParameter

nowait

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

false

boolean

QueryParameter

version

version of the build for which to view logs.

false

integer

PathParameter

namespace

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

true

string

PathParameter

name

name of the BuildLog

true

string

Responses

HTTP Code Description Schema

200

success

v1.BuildLog

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.DeploymentConfigRollback

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.DeploymentConfigRollback

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete collection of DeploymentConfig

DELETE /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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.DeploymentConfigList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

v1.DeploymentConfig

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.DeploymentConfig

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

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

false

integer

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

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

true

string

PathParameter

name

name of the DeploymentConfig

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.DeploymentConfig

PathParameter

namespace

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

true

string

PathParameter

name

name of the DeploymentConfig

true

string

Responses

HTTP Code Description Schema

200

success

v1.DeploymentConfig

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

export

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

false

boolean

QueryParameter

exact

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

false

boolean

PathParameter

namespace

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

true

string

PathParameter

name

name of the DeploymentConfig

true

string

Responses

HTTP Code Description Schema

200

success

v1.DeploymentConfig

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

unversioned.Patch

PathParameter

namespace

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

true

string

PathParameter

name

name of the DeploymentConfig

true

string

Responses

HTTP Code Description Schema

200

success

v1.DeploymentConfig

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

create instantiate of a DeploymentRequest

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.DeploymentRequest

PathParameter

namespace

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

true

string

PathParameter

name

name of the DeploymentRequest

true

string

Responses

HTTP Code Description Schema

200

success

v1.DeploymentRequest

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

The container for which to stream logs. Defaults to only container if there is one container in the pod.

false

string

QueryParameter

follow

Follow if true indicates that the build log should be streamed until the build terminates.

false

boolean

QueryParameter

previous

Return previous deployment logs. Defaults to false.

false

boolean

QueryParameter

sinceSeconds

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

false

integer

QueryParameter

sinceTime

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

false

string

QueryParameter

timestamps

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

false

boolean

QueryParameter

tailLines

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

false

integer

QueryParameter

limitBytes

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

false

integer

QueryParameter

nowait

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

false

boolean

QueryParameter

version

Version of the deployment for which to view logs.

false

integer

PathParameter

namespace

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

true

string

PathParameter

name

name of the DeploymentLog

true

string

Responses

HTTP Code Description Schema

200

success

v1.DeploymentLog

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

create rollback of a DeploymentConfigRollback

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.DeploymentConfigRollback

PathParameter

namespace

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

true

string

PathParameter

name

name of the DeploymentConfigRollback

true

string

Responses

HTTP Code Description Schema

200

success

v1.DeploymentConfigRollback

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

replace scale of the specified Scale

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1beta1.Scale

PathParameter

namespace

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

true

string

PathParameter

name

name of the Scale

true

string

Responses

HTTP Code Description Schema

200

success

v1beta1.Scale

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

read scale of the specified Scale

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

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 Scale

true

string

Responses

HTTP Code Description Schema

200

success

v1beta1.Scale

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

partially update scale of the specified Scale

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

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

true

string

PathParameter

name

name of the Scale

true

string

Responses

HTTP Code Description Schema

200

success

v1beta1.Scale

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

replace status of the specified DeploymentConfig

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.DeploymentConfig

PathParameter

namespace

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

true

string

PathParameter

name

name of the DeploymentConfig

true

string

Responses

HTTP Code Description Schema

200

success

v1.DeploymentConfig

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete collection of EgressNetworkPolicy

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

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

list or watch objects of kind EgressNetworkPolicy

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

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.EgressNetworkPolicyList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

create an EgressNetworkPolicy

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.EgressNetworkPolicy

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.EgressNetworkPolicy

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete an EgressNetworkPolicy

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

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

false

integer

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

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

true

string

PathParameter

name

name of the EgressNetworkPolicy

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

replace the specified EgressNetworkPolicy

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.EgressNetworkPolicy

PathParameter

namespace

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

true

string

PathParameter

name

name of the EgressNetworkPolicy

true

string

Responses

HTTP Code Description Schema

200

success

v1.EgressNetworkPolicy

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

read the specified EgressNetworkPolicy

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

QueryParameter

export

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

false

boolean

QueryParameter

exact

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

false

boolean

PathParameter

namespace

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

true

string

PathParameter

name

name of the EgressNetworkPolicy

true

string

Responses

HTTP Code Description Schema

200

success

v1.EgressNetworkPolicy

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

partially update the specified EgressNetworkPolicy

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

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

true

string

PathParameter

name

name of the EgressNetworkPolicy

true

string

Responses

HTTP Code Description Schema

200

success

v1.EgressNetworkPolicy

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

Responses

HTTP Code Description Schema

200

success

v1.DeploymentConfig

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

Responses

HTTP Code Description Schema

200

success

v1.ImageStreamImage

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

create an ImageStreamImport

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.ImageStreamImport

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.ImageStreamImport

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

create an 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

v1.ImageStreamMapping

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.ImageStreamMapping

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete collection of ImageStream

DELETE /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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.ImageStreamList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

create an 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

v1.ImageStream

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.ImageStream

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete an 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

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

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

false

integer

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

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

true

string

PathParameter

name

name of the ImageStream

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.ImageStream

PathParameter

namespace

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

true

string

PathParameter

name

name of the ImageStream

true

string

Responses

HTTP Code Description Schema

200

success

v1.ImageStream

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

export

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

false

boolean

QueryParameter

exact

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

false

boolean

PathParameter

namespace

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

true

string

PathParameter

name

name of the ImageStream

true

string

Responses

HTTP Code Description Schema

200

success

v1.ImageStream

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

unversioned.Patch

PathParameter

namespace

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

true

string

PathParameter

name

name of the ImageStream

true

string

Responses

HTTP Code Description Schema

200

success

v1.ImageStream

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

read secrets of the specified SecretList

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

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

PathParameter

name

name of the SecretList

true

string

Responses

HTTP Code Description Schema

200

success

v1.SecretList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.ImageStream

PathParameter

namespace

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

true

string

PathParameter

name

name of the ImageStream

true

string

Responses

HTTP Code Description Schema

200

success

v1.ImageStream

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.ImageStreamTagList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

create an ImageStreamTag

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.ImageStreamTag

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.ImageStreamTag

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete an 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

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.ImageStreamTag

PathParameter

namespace

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

true

string

PathParameter

name

name of the ImageStreamTag

true

string

Responses

HTTP Code Description Schema

200

success

v1.ImageStreamTag

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

Responses

HTTP Code Description Schema

200

success

v1.ImageStreamTag

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

unversioned.Patch

PathParameter

namespace

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

true

string

PathParameter

name

name of the ImageStreamTag

true

string

Responses

HTTP Code Description Schema

200

success

v1.ImageStreamTag

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.LocalResourceAccessReview

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.LocalResourceAccessReview

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.LocalSubjectAccessReview

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.LocalSubjectAccessReview

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

create a PodSecurityPolicyReview

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.PodSecurityPolicyReview

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.PodSecurityPolicyReview

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

create a PodSecurityPolicySelfSubjectReview

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.PodSecurityPolicySelfSubjectReview

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.PodSecurityPolicySelfSubjectReview

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

create a PodSecurityPolicySubjectReview

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.PodSecurityPolicySubjectReview

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.PodSecurityPolicySubjectReview

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete collection of Policy

DELETE /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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.PolicyList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

v1.Policy

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.Policy

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

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

false

integer

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

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

true

string

PathParameter

name

name of the Policy

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.Policy

PathParameter

namespace

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

true

string

PathParameter

name

name of the Policy

true

string

Responses

HTTP Code Description Schema

200

success

v1.Policy

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

export

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

false

boolean

QueryParameter

exact

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

false

boolean

PathParameter

namespace

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

true

string

PathParameter

name

name of the Policy

true

string

Responses

HTTP Code Description Schema

200

success

v1.Policy

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

unversioned.Patch

PathParameter

namespace

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

true

string

PathParameter

name

name of the Policy

true

string

Responses

HTTP Code Description Schema

200

success

v1.Policy

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete collection of PolicyBinding

DELETE /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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.PolicyBindingList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

v1.PolicyBinding

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.PolicyBinding

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

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

false

integer

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

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

true

string

PathParameter

name

name of the PolicyBinding

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.PolicyBinding

PathParameter

namespace

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

true

string

PathParameter

name

name of the PolicyBinding

true

string

Responses

HTTP Code Description Schema

200

success

v1.PolicyBinding

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

export

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

false

boolean

QueryParameter

exact

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

false

boolean

PathParameter

namespace

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

true

string

PathParameter

name

name of the PolicyBinding

true

string

Responses

HTTP Code Description Schema

200

success

v1.PolicyBinding

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

unversioned.Patch

PathParameter

namespace

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

true

string

PathParameter

name

name of the PolicyBinding

true

string

Responses

HTTP Code Description Schema

200

success

v1.PolicyBinding

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.Template

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.Template

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.ResourceAccessReview

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.ResourceAccessReview

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete collection of RoleBindingRestriction

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

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

list or watch objects of kind RoleBindingRestriction

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

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.RoleBindingRestrictionList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

create a RoleBindingRestriction

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.RoleBindingRestriction

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.RoleBindingRestriction

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete a RoleBindingRestriction

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

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

false

integer

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

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

true

string

PathParameter

name

name of the RoleBindingRestriction

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

replace the specified RoleBindingRestriction

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.RoleBindingRestriction

PathParameter

namespace

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

true

string

PathParameter

name

name of the RoleBindingRestriction

true

string

Responses

HTTP Code Description Schema

200

success

v1.RoleBindingRestriction

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

read the specified RoleBindingRestriction

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

QueryParameter

export

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

false

boolean

QueryParameter

exact

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

false

boolean

PathParameter

namespace

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

true

string

PathParameter

name

name of the RoleBindingRestriction

true

string

Responses

HTTP Code Description Schema

200

success

v1.RoleBindingRestriction

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

partially update the specified RoleBindingRestriction

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

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

true

string

PathParameter

name

name of the RoleBindingRestriction

true

string

Responses

HTTP Code Description Schema

200

success

v1.RoleBindingRestriction

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.RoleBindingList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

v1.RoleBinding

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.RoleBinding

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

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

false

integer

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

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

true

string

PathParameter

name

name of the RoleBinding

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.RoleBinding

PathParameter

namespace

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

true

string

PathParameter

name

name of the RoleBinding

true

string

Responses

HTTP Code Description Schema

200

success

v1.RoleBinding

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

Responses

HTTP Code Description Schema

200

success

v1.RoleBinding

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

unversioned.Patch

PathParameter

namespace

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

true

string

PathParameter

name

name of the RoleBinding

true

string

Responses

HTTP Code Description Schema

200

success

v1.RoleBinding

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.RoleList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

v1.Role

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.Role

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

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

false

integer

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

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

true

string

PathParameter

name

name of the Role

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.Role

PathParameter

namespace

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

true

string

PathParameter

name

name of the Role

true

string

Responses

HTTP Code Description Schema

200

success

v1.Role

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

Responses

HTTP Code Description Schema

200

success

v1.Role

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

unversioned.Patch

PathParameter

namespace

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

true

string

PathParameter

name

name of the Role

true

string

Responses

HTTP Code Description Schema

200

success

v1.Role

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete collection of Route

DELETE /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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.RouteList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

v1.Route

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.Route

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

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

false

integer

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

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

true

string

PathParameter

name

name of the Route

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.Route

PathParameter

namespace

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

true

string

PathParameter

name

name of the Route

true

string

Responses

HTTP Code Description Schema

200

success

v1.Route

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

export

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

false

boolean

QueryParameter

exact

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

false

boolean

PathParameter

namespace

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

true

string

PathParameter

name

name of the Route

true

string

Responses

HTTP Code Description Schema

200

success

v1.Route

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

unversioned.Patch

PathParameter

namespace

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

true

string

PathParameter

name

name of the Route

true

string

Responses

HTTP Code Description Schema

200

success

v1.Route

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.Route

PathParameter

namespace

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

true

string

PathParameter

name

name of the Route

true

string

Responses

HTTP Code Description Schema

200

success

v1.Route

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

create a SelfSubjectRulesReview

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.SelfSubjectRulesReview

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.SelfSubjectRulesReview

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.SubjectAccessReview

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.SubjectAccessReview

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

create a SubjectRulesReview

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

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.SubjectRulesReview

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.SubjectRulesReview

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete collection of Template

DELETE /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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.TemplateList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

v1.Template

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

v1.Template

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

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

false

integer

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

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

true

string

PathParameter

name

name of the Template

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.Template

PathParameter

namespace

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

true

string

PathParameter

name

name of the Template

true

string

Responses

HTTP Code Description Schema

200

success

v1.Template

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

export

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

false

boolean

QueryParameter

exact

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

false

boolean

PathParameter

namespace

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

true

string

PathParameter

name

name of the Template

true

string

Responses

HTTP Code Description Schema

200

success

v1.Template

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

unversioned.Patch

PathParameter

namespace

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

true

string

PathParameter

name

name of the Template

true

string

Responses

HTTP Code Description Schema

200

success

v1.Template

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete collection of NetNamespace

DELETE /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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.NetNamespaceList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

v1.NetNamespace

Responses

HTTP Code Description Schema

200

success

v1.NetNamespace

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

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

false

integer

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

name

name of the NetNamespace

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.NetNamespace

PathParameter

name

name of the NetNamespace

true

string

Responses

HTTP Code Description Schema

200

success

v1.NetNamespace

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

export

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

false

boolean

QueryParameter

exact

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

false

boolean

PathParameter

name

name of the NetNamespace

true

string

Responses

HTTP Code Description Schema

200

success

v1.NetNamespace

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

unversioned.Patch

PathParameter

name

name of the NetNamespace

true

string

Responses

HTTP Code Description Schema

200

success

v1.NetNamespace

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete collection of OAuthAccessToken

DELETE /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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

list or watch 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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.OAuthAccessTokenList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

create an 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

v1.OAuthAccessToken

Responses

HTTP Code Description Schema

200

success

v1.OAuthAccessToken

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete an 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

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

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

false

integer

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

name

name of the OAuthAccessToken

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

replace the specified OAuthAccessToken

PUT /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

v1.OAuthAccessToken

PathParameter

name

name of the OAuthAccessToken

true

string

Responses

HTTP Code Description Schema

200

success

v1.OAuthAccessToken

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

export

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

false

boolean

QueryParameter

exact

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

false

boolean

PathParameter

name

name of the OAuthAccessToken

true

string

Responses

HTTP Code Description Schema

200

success

v1.OAuthAccessToken

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

partially update the specified OAuthAccessToken

PATCH /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

unversioned.Patch

PathParameter

name

name of the OAuthAccessToken

true

string

Responses

HTTP Code Description Schema

200

success

v1.OAuthAccessToken

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete collection of OAuthAuthorizeToken

DELETE /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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

list or watch 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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.OAuthAuthorizeTokenList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

create an 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

v1.OAuthAuthorizeToken

Responses

HTTP Code Description Schema

200

success

v1.OAuthAuthorizeToken

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete an 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

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

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

false

integer

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

name

name of the OAuthAuthorizeToken

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

replace the specified OAuthAuthorizeToken

PUT /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

v1.OAuthAuthorizeToken

PathParameter

name

name of the OAuthAuthorizeToken

true

string

Responses

HTTP Code Description Schema

200

success

v1.OAuthAuthorizeToken

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

export

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

false

boolean

QueryParameter

exact

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

false

boolean

PathParameter

name

name of the OAuthAuthorizeToken

true

string

Responses

HTTP Code Description Schema

200

success

v1.OAuthAuthorizeToken

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

partially update the specified OAuthAuthorizeToken

PATCH /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

unversioned.Patch

PathParameter

name

name of the OAuthAuthorizeToken

true

string

Responses

HTTP Code Description Schema

200

success

v1.OAuthAuthorizeToken

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete collection of OAuthClientAuthorization

DELETE /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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.OAuthClientAuthorizationList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

create an 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

v1.OAuthClientAuthorization

Responses

HTTP Code Description Schema

200

success

v1.OAuthClientAuthorization

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete an 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

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

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

false

integer

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

name

name of the OAuthClientAuthorization

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.OAuthClientAuthorization

PathParameter

name

name of the OAuthClientAuthorization

true

string

Responses

HTTP Code Description Schema

200

success

v1.OAuthClientAuthorization

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

export

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

false

boolean

QueryParameter

exact

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

false

boolean

PathParameter

name

name of the OAuthClientAuthorization

true

string

Responses

HTTP Code Description Schema

200

success

v1.OAuthClientAuthorization

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

unversioned.Patch

PathParameter

name

name of the OAuthClientAuthorization

true

string

Responses

HTTP Code Description Schema

200

success

v1.OAuthClientAuthorization

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete collection of OAuthClient

DELETE /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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.OAuthClientList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

create an 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

v1.OAuthClient

Responses

HTTP Code Description Schema

200

success

v1.OAuthClient

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete an 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

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

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

false

integer

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

name

name of the OAuthClient

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.OAuthClient

PathParameter

name

name of the OAuthClient

true

string

Responses

HTTP Code Description Schema

200

success

v1.OAuthClient

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

export

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

false

boolean

QueryParameter

exact

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

false

boolean

PathParameter

name

name of the OAuthClient

true

string

Responses

HTTP Code Description Schema

200

success

v1.OAuthClient

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

unversioned.Patch

PathParameter

name

name of the OAuthClient

true

string

Responses

HTTP Code Description Schema

200

success

v1.OAuthClient

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

create a PodSecurityPolicyReview

POST /oapi/v1/podsecuritypolicyreviews

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.PodSecurityPolicyReview

Responses

HTTP Code Description Schema

200

success

v1.PodSecurityPolicyReview

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

create a PodSecurityPolicySelfSubjectReview

POST /oapi/v1/podsecuritypolicyselfsubjectreviews

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.PodSecurityPolicySelfSubjectReview

Responses

HTTP Code Description Schema

200

success

v1.PodSecurityPolicySelfSubjectReview

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

create a PodSecurityPolicySubjectReview

POST /oapi/v1/podsecuritypolicysubjectreviews

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.PodSecurityPolicySubjectReview

Responses

HTTP Code Description Schema

200

success

v1.PodSecurityPolicySubjectReview

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.PolicyList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

v1.Policy

Responses

HTTP Code Description Schema

200

success

v1.Policy

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.PolicyBindingList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

v1.PolicyBinding

Responses

HTTP Code Description Schema

200

success

v1.PolicyBinding

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.Template

Responses

HTTP Code Description Schema

200

success

v1.Template

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

v1.ProjectRequest

Responses

HTTP Code Description Schema

200

success

v1.ProjectRequest

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

list or watch 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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.ProjectList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

v1.Project

Responses

HTTP Code Description Schema

200

success

v1.Project

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.Project

PathParameter

name

name of the Project

true

string

Responses

HTTP Code Description Schema

200

success

v1.Project

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

Responses

HTTP Code Description Schema

200

success

v1.Project

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

unversioned.Patch

PathParameter

name

name of the Project

true

string

Responses

HTTP Code Description Schema

200

success

v1.Project

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.ResourceAccessReview

Responses

HTTP Code Description Schema

200

success

v1.ResourceAccessReview

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

list or watch objects of kind RoleBindingRestriction

GET /oapi/v1/rolebindingrestrictions

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.RoleBindingRestrictionList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

create a RoleBindingRestriction

POST /oapi/v1/rolebindingrestrictions

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.RoleBindingRestriction

Responses

HTTP Code Description Schema

200

success

v1.RoleBindingRestriction

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.RoleBindingList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

v1.RoleBinding

Responses

HTTP Code Description Schema

200

success

v1.RoleBinding

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.RoleList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

v1.Role

Responses

HTTP Code Description Schema

200

success

v1.Role

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.RouteList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

v1.Route

Responses

HTTP Code Description Schema

200

success

v1.Route

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

create a SelfSubjectRulesReview

POST /oapi/v1/selfsubjectrulesreviews

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.SelfSubjectRulesReview

Responses

HTTP Code Description Schema

200

success

v1.SelfSubjectRulesReview

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.SubjectAccessReview

Responses

HTTP Code Description Schema

200

success

v1.SubjectAccessReview

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

create a SubjectRulesReview

POST /oapi/v1/subjectrulesreviews

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

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

false

string

BodyParameter

body

true

v1.SubjectRulesReview

Responses

HTTP Code Description Schema

200

success

v1.SubjectRulesReview

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.TemplateList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

v1.Template

Responses

HTTP Code Description Schema

200

success

v1.Template

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

create an 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

v1.UserIdentityMapping

Responses

HTTP Code Description Schema

200

success

v1.UserIdentityMapping

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete an 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

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.UserIdentityMapping

PathParameter

name

name of the UserIdentityMapping

true

string

Responses

HTTP Code Description Schema

200

success

v1.UserIdentityMapping

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

Responses

HTTP Code Description Schema

200

success

v1.UserIdentityMapping

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

unversioned.Patch

PathParameter

name

name of the UserIdentityMapping

true

string

Responses

HTTP Code Description Schema

200

success

v1.UserIdentityMapping

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete collection of User

DELETE /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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

v1.UserList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

create an 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

v1.User

Responses

HTTP Code Description Schema

200

success

v1.User

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

delete an 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

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

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

false

integer

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

name

name of the User

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

v1.User

PathParameter

name

name of the User

true

string

Responses

HTTP Code Description Schema

200

success

v1.User

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

export

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

false

boolean

QueryParameter

exact

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

false

boolean

PathParameter

name

name of the User

true

string

Responses

HTTP Code Description Schema

200

success

v1.User

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

unversioned.Patch

PathParameter

name

name of the User

true

string

Responses

HTTP Code Description Schema

200

success

v1.User

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

name

name of the ClusterNetwork

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

name

name of the ClusterPolicy

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

name

name of the ClusterPolicyBinding

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

watch individual changes to a list of ClusterResourceQuota

GET /oapi/v1/watch/clusterresourcequotas

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

watch changes to an object of kind ClusterResourceQuota

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

name

name of the ClusterResourceQuota

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

watch individual changes to a list of EgressNetworkPolicy

GET /oapi/v1/watch/egressnetworkpolicies

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

name

name of the Group

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

name

name of the HostSubnet

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

name

name of the Identity

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

name

name of the Image

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

PathParameter

name

name of the BuildConfig

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

PathParameter

name

name of the Build

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

PathParameter

name

name of the DeploymentConfig

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

watch individual changes to a list of EgressNetworkPolicy

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

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

watch changes to an object of kind EgressNetworkPolicy

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

PathParameter

name

name of the EgressNetworkPolicy

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

PathParameter

name

name of the ImageStream

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

PathParameter

name

name of the Policy

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

PathParameter

name

name of the PolicyBinding

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

watch individual changes to a list of RoleBindingRestriction

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

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

watch changes to an object of kind RoleBindingRestriction

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

PathParameter

name

name of the RoleBindingRestriction

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

PathParameter

name

name of the Route

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

namespace

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

true

string

PathParameter

name

name of the Template

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

name

name of the NetNamespace

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

watch individual changes to a list of OAuthAccessToken

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

watch changes to an object of kind OAuthAccessToken

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

name

name of the OAuthAccessToken

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

watch individual changes to a list of OAuthAuthorizeToken

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

watch changes to an object of kind OAuthAuthorizeToken

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

name

name of the OAuthAuthorizeToken

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

name

name of the OAuthClientAuthorization

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

name

name of the OAuthClient

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

watch individual changes to a list of Project

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

watch changes to an object of kind Project

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

name

name of the Project

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

watch individual changes to a list of RoleBindingRestriction

GET /oapi/v1/watch/rolebindingrestrictions

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

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

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer

PathParameter

name

name of the User

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Tags

  • oapiv1

Definitions

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

runtime.RawExtension

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

types.UID

unversioned.APIResource

APIResource specifies the name of a resource and whether it is namespaced.

Name Description Required Schema Default

name

name is the name of the resource.

true

string

namespaced

namespaced indicates if a resource is namespaced or not.

true

boolean

kind

kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')

true

string

unversioned.APIResourceList

APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.

Name Description Required Schema 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

groupVersion

groupVersion is the group and version this APIResourceList is for.

true

string

resources

resources contains the name of the resources and if they are namespaced.

true

unversioned.APIResource array

unversioned.LabelSelector

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

Name Description Required Schema Default

matchLabels

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

false

object

matchExpressions

matchExpressions is a list of label selector requirements. The requirements are ANDed.

false

unversioned.LabelSelectorRequirement array

unversioned.LabelSelectorRequirement

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name Description Required Schema Default

key

key is the label key that the selector applies to.

true

string

operator

operator represents a key’s relationship to a set of values. Valid operators ard In, NotIn, Exists and DoesNotExist.

true

string

values

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

false

string array

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

unversioned.Patch

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

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

unversioned.ListMeta

status

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

false

string

message

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

false

string

reason

A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.

false

string

details

Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.

false

unversioned.StatusDetails

code

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

false

integer (int32)

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.

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

false

string

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

group

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

false

string

kind

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

false

string

causes

The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.

false

unversioned.StatusCause array

retryAfterSeconds

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

false

integer (int32)

v1.AWSElasticBlockStoreVolumeSource

Represents a Persistent Disk resource in AWS.

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

Name Description Required Schema Default

volumeID

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

true

string

fsType

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

false

string

partition

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

false

integer (int32)

readOnly

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

false

boolean

v1.AppliedClusterResourceQuota

AppliedClusterResourceQuota mirrors ClusterResourceQuota at a project scope, for projection into a project. It allows a project-admin to know which ClusterResourceQuotas are applied to his project and their associated usage.

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

true

v1.ObjectMeta

spec

Spec defines the desired quota

true

v1.ClusterResourceQuotaSpec

status

Status defines the actual enforced quota and its current usage

false

v1.ClusterResourceQuotaStatus

v1.AppliedClusterResourceQuotaList

AppliedClusterResourceQuotaList is a collection of AppliedClusterResourceQuotas

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

unversioned.ListMeta

items

Items is a list of AppliedClusterResourceQuota

true

v1.AppliedClusterResourceQuota array

v1.AzureDataDiskCachingMode

v1.AzureDiskVolumeSource

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

Name Description Required Schema Default

diskName

The Name of the data disk in the blob storage

true

string

diskURI

The URI the data disk in the blob storage

true

string

cachingMode

Host Caching mode: None, Read Only, Read Write.

false

v1.AzureDataDiskCachingMode

fsType

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

false

string

readOnly

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

false

boolean

v1.AzureFileVolumeSource

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

Name Description Required Schema Default

secretName

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

true

string

shareName

Share Name

true

string

readOnly

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

false

boolean

v1.BinaryBuildSource

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

Name Description Required Schema Default

asFile

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

false

string

v1.Build

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

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

v1.ObjectMeta

spec

spec is all the inputs used to execute the build.

false

v1.BuildSpec

status

status is the current status of the build.

false

v1.BuildStatus

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

metadata for BuildConfig.

false

v1.ObjectMeta

spec

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

true

v1.BuildConfigSpec

status

status holds any relevant information about a build config

true

v1.BuildConfigStatus

v1.BuildConfigList

BuildConfigList is a collection of BuildConfigs.

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

metadata for BuildConfigList.

false

unversioned.ListMeta

items

items is a list of build configs

true

v1.BuildConfig array

v1.BuildConfigSpec

BuildConfigSpec describes when and how builds are created

Name Description Required Schema Default

triggers

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

true

v1.BuildTriggerPolicy array

runPolicy

RunPolicy describes how the new build created from this build configuration will be scheduled for execution. This is optional, if not specified we default to "Serial".

false

string

serviceAccount

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

false

string

source

source describes the SCM in use.

false

v1.BuildSource

revision

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

false

v1.SourceRevision

strategy

strategy defines how to perform a build.

true

v1.BuildStrategy

output

output describes the Docker image the Strategy should produce.

false

v1.BuildOutput

resources

resources computes resource requirements to execute the build.

false

v1.ResourceRequirements

postCommit

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

false

v1.BuildPostCommitSpec

completionDeadlineSeconds

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

false

integer (int64)

nodeSelector

nodeSelector is a selector which must be true for the build pod to fit on a node If nil, it can be overridden by default build nodeselector values for the cluster. If set to an empty map or a map with any values, default build nodeselector values are ignored.

true

object

v1.BuildConfigStatus

BuildConfigStatus contains current state of the build config object.

Name Description Required Schema Default

lastVersion

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

true

integer (int64)

v1.BuildList

BuildList is a collection of Builds.

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

metadata for BuildList.

false

unversioned.ListMeta

items

items is a list of builds

true

v1.Build array

v1.BuildLog

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

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

v1.BuildOutput

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

Name Description Required Schema Default

to

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

false

v1.ObjectReference

pushSecret

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

false

v1.LocalObjectReference

imageLabels

imageLabels define a list of labels that are applied to the resulting image. If there are multiple labels with the same name then the last one in the list is used.

false

v1.ImageLabel array

v1.BuildPostCommitSpec

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

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

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

  1. Shell script:

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

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

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

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

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

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

Name Description Required Schema Default

command

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

false

string array

args

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

false

string array

script

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

false

string

v1.BuildRequest

BuildRequest is the resource used to pass parameters to build generator

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

metadata for BuildRequest.

false

v1.ObjectMeta

revision

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

false

v1.SourceRevision

triggeredByImage

triggeredByImage is the Image that triggered this build.

false

v1.ObjectReference

from

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

false

v1.ObjectReference

binary

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

false

v1.BinaryBuildSource

lastVersion

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

false

integer (int64)

env

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

false

v1.EnvVar array

triggeredBy

triggeredBy describes which triggers started the most recent update to the build configuration and contains information about those triggers.

true

v1.BuildTriggerCause array

v1.BuildSource

BuildSource is the SCM used for the build.

Name Description Required Schema Default

type

type of build input to accept

true

string

binary

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

false

v1.BinaryBuildSource

dockerfile

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

false

string

git

git contains optional information about git build source

false

v1.GitBuildSource

images

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

false

v1.ImageSource array

contextDir

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

false

string

sourceSecret

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

false

v1.LocalObjectReference

secrets

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

false

v1.SecretBuildSource array

v1.BuildSpec

BuildSpec has the information to represent a build and also additional information about a build

Name Description Required Schema Default

serviceAccount

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

false

string

source

source describes the SCM in use.

false

v1.BuildSource

revision

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

false

v1.SourceRevision

strategy

strategy defines how to perform a build.

true

v1.BuildStrategy

output

output describes the Docker image the Strategy should produce.

false

v1.BuildOutput

resources

resources computes resource requirements to execute the build.

false

v1.ResourceRequirements

postCommit

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

false

v1.BuildPostCommitSpec

completionDeadlineSeconds

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

false

integer (int64)

nodeSelector

nodeSelector is a selector which must be true for the build pod to fit on a node If nil, it can be overridden by default build nodeselector values for the cluster. If set to an empty map or a map with any values, default build nodeselector values are ignored.

true

object

triggeredBy

triggeredBy describes which triggers started the most recent update to the build configuration and contains information about those triggers.

true

v1.BuildTriggerCause array

v1.BuildStatus

BuildStatus contains the status of a build

Name Description Required Schema Default

phase

phase is the point in the build lifecycle.

true

string

cancelled

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

false

boolean

reason

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

false

string

message

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

false

string

startTimestamp

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

false

string

completionTimestamp

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

false

string

duration

duration contains time.Duration object describing build time.

false

time.Duration

outputDockerImageReference

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

false

string

config

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

false

v1.ObjectReference

output

output describes the Docker image the build has produced.

false

v1.BuildStatusOutput

v1.BuildStatusOutput

BuildStatusOutput contains the status of the built image.

Name Description Required Schema Default

to

to describes the status of the built image being pushed to a registry.

false

v1.BuildStatusOutputTo

v1.BuildStatusOutputTo

BuildStatusOutputTo describes the status of the built image with regards to image registry to which it was supposed to be pushed.

Name Description Required Schema Default

imageDigest

imageDigest is the digest of the built Docker image. The digest uniquely identifies the image in the registry to which it was pushed.

Please note that this field may not always be set even if the push completes successfully - e.g. when the registry returns no digest or returns it in a format that the builder doesn’t understand.

false

string

v1.BuildStrategy

BuildStrategy contains the details of how to perform a build.

Name Description Required Schema Default

type

type is the kind of build strategy.

true

string

dockerStrategy

dockerStrategy holds the parameters to the Docker build strategy.

false

v1.DockerBuildStrategy

sourceStrategy

sourceStrategy holds the parameters to the Source build strategy.

false

v1.SourceBuildStrategy

customStrategy

customStrategy holds the parameters to the Custom build strategy

false

v1.CustomBuildStrategy

jenkinsPipelineStrategy

JenkinsPipelineStrategy holds the parameters to the Jenkins Pipeline build strategy. This strategy is in tech preview.

false

v1.JenkinsPipelineBuildStrategy

v1.BuildTriggerCause

BuildTriggerCause holds information about a triggered build. It is used for displaying build trigger data for each build and build configuration in oc describe. It is also used to describe which triggers led to the most recent update in the build configuration.

Name Description Required Schema Default

message

message is used to store a human readable message for why the build was triggered. E.g.: "Manually triggered by user", "Configuration change",etc.

false

string

genericWebHook

genericWebHook holds data about a builds generic webhook trigger.

false

v1.GenericWebHookCause

githubWebHook

gitHubWebHook represents data for a GitHub webhook that fired a specific build.

false

v1.GitHubWebHookCause

imageChangeBuild

imageChangeBuild stores information about an imagechange event that triggered a new build.

false

v1.ImageChangeCause

v1.BuildTriggerPolicy

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

Name Description Required Schema Default

type

type is the type of build trigger

true

string

github

github contains the parameters for a GitHub webhook type of trigger

false

v1.WebHookTrigger

generic

generic contains the parameters for a Generic webhook type of trigger

false

v1.WebHookTrigger

imageChange

imageChange contains parameters for an ImageChange type of trigger

false

v1.ImageChangeTrigger

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

v1.CephFSVolumeSource

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

Name Description Required Schema Default

monitors

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

true

string array

path

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

false

string

user

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

false

string

secretFile

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

false

string

secretRef

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

false

v1.LocalObjectReference

readOnly

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

false

boolean

v1.CinderVolumeSource

Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.

Name Description Required Schema 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

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

false

string

readOnly

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

false

boolean

v1.ClusterNetwork

ClusterNetwork describes the cluster network. There is normally only one object of this type, named "default", which is created by the SDN network plugin based on the master configuration when the cluster is brought up for the first time.

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

v1.ObjectMeta

network

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

true

string

hostsubnetlength

HostSubnetLength is the number of bits of network to allocate to each node. eg, 8 would mean that each node would have a /24 slice of the overlay network for its pods

true

integer

serviceNetwork

ServiceNetwork is the CIDR range that Service IP addresses are allocated from

true

string

pluginName

PluginName is the name of the network plugin being used

false

string

v1.ClusterNetworkList

ClusterNetworkList is a collection of ClusterNetworks

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

unversioned.ListMeta

items

Items is the list of cluster networks

true

v1.ClusterNetwork array

v1.ClusterPolicy

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

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

v1.ObjectMeta

lastModified

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

true

string

roles

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

true

v1.NamedClusterRole array

v1.ClusterPolicyBinding

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

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

v1.ObjectMeta

lastModified

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

true

string

policyRef

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

true

v1.ObjectReference

roleBindings

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

true

v1.NamedClusterRoleBinding array

v1.ClusterPolicyBindingList

ClusterPolicyBindingList is a collection of ClusterPolicyBindings

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

unversioned.ListMeta

items

Items is a list of ClusterPolicyBindings

true

v1.ClusterPolicyBinding array

v1.ClusterPolicyList

ClusterPolicyList is a collection of ClusterPolicies

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

unversioned.ListMeta

items

Items is a list of ClusterPolicies

true

v1.ClusterPolicy array

v1.ClusterResourceQuota

ClusterResourceQuota mirrors ResourceQuota at a cluster scope. This object is easily convertible to synthetic ResourceQuota object to allow quota evaluation re-use.

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

true

v1.ObjectMeta

spec

Spec defines the desired quota

true

v1.ClusterResourceQuotaSpec

status

Status defines the actual enforced quota and its current usage

false

v1.ClusterResourceQuotaStatus

v1.ClusterResourceQuotaList

ClusterResourceQuotaList is a collection of ClusterResourceQuotas

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

unversioned.ListMeta

items

Items is a list of ClusterResourceQuotas

true

v1.ClusterResourceQuota array

v1.ClusterResourceQuotaSelector

ClusterResourceQuotaSelector is used to select projects. At least one of LabelSelector or AnnotationSelector must present. If only one is present, it is the only selection criteria. If both are specified, the project must match both restrictions.

Name Description Required Schema Default

labels

LabelSelector is used to select projects by label.

true

unversioned.LabelSelector

annotations

AnnotationSelector is used to select projects by annotation.

true

object

v1.ClusterResourceQuotaSpec

ClusterResourceQuotaSpec defines the desired quota restrictions

Name Description Required Schema Default

selector

Selector is the selector used to match projects. It should only select active projects on the scale of dozens (though it can select many more less active projects). These projects will contend on object creation through this resource.

true

v1.ClusterResourceQuotaSelector

quota

Quota defines the desired quota

true

v1.ResourceQuotaSpec

v1.ClusterResourceQuotaStatus

ClusterResourceQuotaStatus defines the actual enforced quota and its current usage

Name Description Required Schema Default

total

Total defines the actual enforced quota and its current usage across all projects

true

v1.ResourceQuotaStatus

namespaces

Namespaces slices the usage by project. This division allows for quick resolution of deletion reconciliation inside of a single project without requiring a recalculation across all projects. This can be used to pull the deltas for a given project.

true

v1.ResourceQuotaStatusByNamespace array

v1.ClusterRole

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

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

v1.ObjectMeta

rules

Rules holds all the PolicyRules for this ClusterRole

true

v1.PolicyRule array

v1.ClusterRoleBinding

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

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

v1.ObjectMeta

userNames

UserNames holds all the usernames directly bound to the role. This field should only be specified when supporting legacy clients and servers. See Subjects for further details.

true

string array

groupNames

GroupNames holds all the groups directly bound to the role. This field should only be specified when supporting legacy clients and servers. See Subjects for further details.

true

string array

subjects

Subjects hold object references to authorize with this rule. This field is ignored if UserNames or GroupNames are specified to support legacy clients and servers. Thus newer clients that do not need to support backwards compatibility should send only fully qualified Subjects and should omit the UserNames and GroupNames fields. Clients that need to support backwards compatibility can use this field to build the UserNames and GroupNames.

true

v1.ObjectReference array

roleRef

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

true

v1.ObjectReference

v1.ClusterRoleBindingList

ClusterRoleBindingList is a collection of ClusterRoleBindings

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

unversioned.ListMeta

items

Items is a list of ClusterRoleBindings

true

v1.ClusterRoleBinding array

v1.ClusterRoleList

ClusterRoleList is a collection of ClusterRoles

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

unversioned.ListMeta

items

Items is a list of ClusterRoles

true

v1.ClusterRole array

v1.ClusterRoleScopeRestriction

ClusterRoleScopeRestriction describes restrictions on cluster role scopes

Name Description Required Schema Default

roleNames

RoleNames is the list of cluster roles that can referenced. * means anything

true

string array

namespaces

Namespaces is the list of namespaces that can be referenced. * means any of them (including *)

true

string array

allowEscalation

AllowEscalation indicates whether you can request roles and their escalating resources

true

boolean

v1.ConfigMapKeySelector

Selects a key from a ConfigMap.

Name Description Required Schema Default

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

key

The key to select.

true

string

v1.ConfigMapVolumeSource

Adapts a ConfigMap into a volume.

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

Name Description Required Schema Default

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

items

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

false

v1.KeyToPath array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

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://kubernetes.io/docs/user-guide/images

false

string

command

Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double , ie: (VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands

false

string array

args

Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double , ie: (VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands

false

string array

workingDir

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

false

string

ports

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

false

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://kubernetes.io/docs/user-guide/persistent-volumes#resources

false

v1.ResourceRequirements

volumeMounts

Pod volumes to mount into the container’s filesystem. 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://kubernetes.io/docs/user-guide/pod-states#container-probes

false

v1.Probe

readinessProbe

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

false

v1.Probe

lifecycle

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

false

v1.Lifecycle

terminationMessagePath

Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Defaults to /dev/termination-log. Cannot be updated.

false

string

imagePullPolicy

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/images#updating-images

false

string

securityContext

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

false

v1.SecurityContext

stdin

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

false

boolean

stdinOnce

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

false

boolean

tty

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

false

boolean

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

CustomBuildStrategy defines input parameters specific to Custom build.

Name Description Required Schema Default

from

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

true

v1.ObjectReference

pullSecret

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

false

v1.LocalObjectReference

env

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

false

v1.EnvVar array

exposeDockerSocket

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

false

boolean

forcePull

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

false

boolean

secrets

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

false

v1.SecretSpec array

buildAPIVersion

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

false

string

v1.CustomDeploymentStrategyParams

CustomDeploymentStrategyParams are the input to the Custom deployment strategy.

Name Description Required Schema Default

image

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

false

string

environment

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

false

v1.EnvVar array

command

Command is optional and overrides CMD in the container Image.

false

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.

false

integer (int64)

preconditions

Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.

false

v1.Preconditions

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

v1.DeploymentCause

DeploymentCause captures information about a particular cause of a deployment.

Name Description Required Schema Default

type

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

true

string

imageTrigger

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

false

v1.DeploymentCauseImageTrigger

v1.DeploymentCauseImageTrigger

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

Name Description Required Schema Default

from

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

true

v1.ObjectReference

v1.DeploymentCondition

DeploymentCondition describes the state of a deployment config at a certain point.

Name Description Required Schema Default

type

Type of deployment condition.

true

string

status

Status of the condition, one of True, False, Unknown.

true

string

lastUpdateTime

The last time this condition was updated.

false

string

lastTransitionTime

The last time the condition transitioned from one status to another.

false

string

reason

The reason for the condition’s last transition.

false

string

message

A human readable message indicating details about the transition.

false

string

v1.DeploymentConfig

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

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

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

v1.ObjectMeta

spec

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

true

v1.DeploymentConfigSpec

status

Status represents the current deployment state.

true

v1.DeploymentConfigStatus

v1.DeploymentConfigList

DeploymentConfigList is a collection of deployment configs.

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

unversioned.ListMeta

items

Items is a list of deployment configs

true

v1.DeploymentConfig array

v1.DeploymentConfigRollback

DeploymentConfigRollback provides the input to rollback generation.

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

name

Name of the deployment config that will be rolled back.

true

string

updatedAnnotations

UpdatedAnnotations is a set of new annotations that will be added in the deployment config.

false

object

spec

Spec defines the options to rollback generation.

true

v1.DeploymentConfigRollbackSpec

v1.DeploymentConfigRollbackSpec

DeploymentConfigRollbackSpec represents the options for rollback generation.

Name Description Required Schema Default

from

From points to a ReplicationController which is a deployment.

true

v1.ObjectReference

revision

Revision to rollback to. If set to 0, rollback to the last revision.

false

integer (int64)

includeTriggers

IncludeTriggers specifies whether to include config Triggers.

true

boolean

includeTemplate

IncludeTemplate specifies whether to include the PodTemplateSpec.

true

boolean

includeReplicationMeta

IncludeReplicationMeta specifies whether to include the replica count and selector.

true

boolean

includeStrategy

IncludeStrategy specifies whether to include the deployment Strategy.

true

boolean

v1.DeploymentConfigSpec

DeploymentConfigSpec represents the desired state of the deployment.

Name Description Required Schema Default

strategy

Strategy describes how a deployment is executed.

true

v1.DeploymentStrategy

minReadySeconds

MinReadySeconds is the minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)

false

integer (int32)

triggers

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

true

v1.DeploymentTriggerPolicy array

replicas

Replicas is the number of desired replicas.

true

integer (int32)

revisionHistoryLimit

RevisionHistoryLimit is the number of old ReplicationControllers to retain to allow for rollbacks. This field is a pointer to allow for differentiation between an explicit zero and not specified.

false

integer (int32)

test

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

true

boolean

paused

Paused indicates that the deployment config is paused resulting in no new deployments on template changes or changes in the template caused by other triggers.

false

boolean

selector

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

false

object

template

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

false

v1.PodTemplateSpec

v1.DeploymentConfigStatus

DeploymentConfigStatus represents the current deployment state.

Name Description Required Schema Default

latestVersion

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

true

integer (int64)

observedGeneration

ObservedGeneration is the most recent generation observed by the deployment config controller.

true

integer (int64)

replicas

Replicas is the total number of pods targeted by this deployment config.

true

integer (int32)

updatedReplicas

UpdatedReplicas is the total number of non-terminated pods targeted by this deployment config that have the desired template spec.

true

integer (int32)

availableReplicas

AvailableReplicas is the total number of available pods targeted by this deployment config.

true

integer (int32)

unavailableReplicas

UnavailableReplicas is the total number of unavailable pods targeted by this deployment config.

true

integer (int32)

details

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

false

v1.DeploymentDetails

conditions

Conditions represents the latest available observations of a deployment config’s current state.

false

v1.DeploymentCondition array

readyReplicas

Total number of ready pods targeted by this deployment.

false

integer (int32)

v1.DeploymentDetails

DeploymentDetails captures information about the causes of a deployment.

Name Description Required Schema Default

message

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

false

string

causes

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

true

v1.DeploymentCause array

v1.DeploymentLog

DeploymentLog represents the logs for a deployment

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

v1.DeploymentRequest

DeploymentRequest is a request to a deployment config for a new 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

name

Name of the deployment config for requesting a new deployment.

true

string

latest

Latest will update the deployment config with the latest state from all triggers.

true

boolean

force

Force will try to force a new deployment to run. If the deployment config is paused, then setting this to true will return an Invalid error.

true

boolean

v1.DeploymentStrategy

DeploymentStrategy describes how to perform a deployment.

Name Description Required Schema Default

type

Type is the name of a deployment strategy.

false

string

customParams

CustomParams are the input to the Custom deployment strategy, and may also be specified for the Recreate and Rolling strategies to customize the execution process that runs the deployment.

false

v1.CustomDeploymentStrategyParams

recreateParams

RecreateParams are the input to the Recreate deployment strategy.

false

v1.RecreateDeploymentStrategyParams

rollingParams

RollingParams are the input to the Rolling deployment strategy.

false

v1.RollingDeploymentStrategyParams

resources

Resources contains resource requirements to execute the deployment and any hooks.

false

v1.ResourceRequirements

labels

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

false

object

annotations

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

false

object

activeDeadlineSeconds

ActiveDeadlineSeconds is the duration in seconds that the deployer pods for this deployment config may be active on a node before the system actively tries to terminate them.

false

integer (int64)

v1.DeploymentTriggerImageChangeParams

DeploymentTriggerImageChangeParams represents the parameters to the ImageChange trigger.

Name Description Required Schema Default

automatic

Automatic means that the detection of a new tag value should result in an image update inside the pod template.

false

boolean

containerNames

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

false

string array

from

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

true

v1.ObjectReference

lastTriggeredImage

LastTriggeredImage is the last image to be triggered.

false

string

v1.DeploymentTriggerPolicy

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

Name Description Required Schema Default

type

Type of the trigger

false

string

imageChangeParams

ImageChangeParams represents the parameters for the ImageChange trigger.

false

v1.DeploymentTriggerImageChangeParams

v1.DeprecatedDownwardAPIVolumeFile

DeprecatedDownwardAPIVolumeFile represents information to create the file containing the pod field This type is deprecated and should be replaced by use of the downwardAPI volume source.

Name Description Required Schema Default

name

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

true

string

fieldRef

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

false

v1.ObjectFieldSelector

resourceFieldRef

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

false

v1.ResourceFieldSelector

mode

Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

v1.DeprecatedDownwardAPIVolumeSource

DeprecatedDownwardAPIVolumeSource represents a volume containing downward API info. This type is deprecated and should be replaced by use of the downwardAPI volume source.

Name Description Required Schema Default

items

Items is a list of downward API volume file

false

v1.DeprecatedDownwardAPIVolumeFile array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

v1.DockerBuildStrategy

DockerBuildStrategy defines input parameters specific to Docker build.

Name Description Required Schema Default

from

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

false

v1.ObjectReference

pullSecret

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

false

v1.LocalObjectReference

noCache

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

false

boolean

env

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

false

v1.EnvVar array

forcePull

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

false

boolean

dockerfilePath

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

false

string

v1.DownwardAPIVolumeFile

DownwardAPIVolumeFile represents information to create the file containing the pod field

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.

false

v1.ObjectFieldSelector

resourceFieldRef

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

false

v1.ResourceFieldSelector

mode

Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

v1.DownwardAPIVolumeSource

DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.

Name Description Required Schema Default

items

Items is a list of downward API volume file

false

v1.DownwardAPIVolumeFile array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

v1.EgressNetworkPolicy

EgressNetworkPolicy describes the current egress network policy for a Namespace. When using the 'redhat/openshift-ovs-multitenant' network plugin, traffic from a pod to an IP address outside the cluster will be checked against each EgressNetworkPolicyRule in the pod’s namespace’s EgressNetworkPolicy, in order. If no rule matches (or no EgressNetworkPolicy is present) then the traffic will be allowed by default.

Name Description Required Schema 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

metadata for EgressNetworkPolicy

false

v1.ObjectMeta

spec

spec is the specification of the current egress network policy

true

v1.EgressNetworkPolicySpec

v1.EgressNetworkPolicyList

EgressNetworkPolicyList is a collection of EgressNetworkPolicy

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

metadata for EgressNetworkPolicyList

false

unversioned.ListMeta

items

items is the list of policies

true

v1.EgressNetworkPolicy array

v1.EgressNetworkPolicyPeer

EgressNetworkPolicyPeer specifies a target to apply egress network policy to

Name Description Required Schema Default

cidrSelector

cidrSelector is the CIDR range to allow/deny traffic to

true

string

v1.EgressNetworkPolicyRule

EgressNetworkPolicyRule contains a single egress network policy rule

Name Description Required Schema Default

type

type marks this as an "Allow" or "Deny" rule

true

string

to

to is the target that traffic is allowed/denied to

true

v1.EgressNetworkPolicyPeer

v1.EgressNetworkPolicySpec

EgressNetworkPolicySpec provides a list of policies on outgoing network traffic

Name Description Required Schema Default

egress

egress contains the list of egress policy rules

true

v1.EgressNetworkPolicyRule array

v1.EmptyDirVolumeSource

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

Name Description Required Schema Default

medium

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

false

string

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

v1.EnvVarSource

v1.EnvVarSource

EnvVarSource represents a source for the value of an EnvVar.

Name Description Required Schema Default

fieldRef

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP.

false

v1.ObjectFieldSelector

resourceFieldRef

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

false

v1.ResourceFieldSelector

configMapKeyRef

Selects a key of a ConfigMap.

false

v1.ConfigMapKeySelector

secretKeyRef

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

false

v1.SecretKeySelector

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

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

Name Description Required Schema Default

command

Command is the action command and its arguments.

true

string array

env

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

false

v1.EnvVar array

containerName

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

true

string

volumes

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

false

string array

v1.FCVolumeSource

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

Name Description Required Schema Default

targetWWNs

Required: FC target worldwide names (WWNs)

true

string array

lun

Required: FC target lun number

true

integer (int32)

fsType

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

false

string

readOnly

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

false

boolean

v1.FinalizerName

v1.FlexVolumeSource

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

Name Description Required Schema Default

driver

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

true

string

fsType

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

false

string

secretRef

Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

false

v1.LocalObjectReference

readOnly

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

false

boolean

options

Optional: Extra command options if any.

false

object

v1.FlockerVolumeSource

Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.

Name Description Required Schema Default

datasetName

Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated

false

string

datasetUUID

UUID of the dataset. This is unique identifier of a Flocker dataset

false

string

v1.GCEPersistentDiskVolumeSource

Represents a Persistent Disk resource in Google Compute Engine.

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

Name Description Required Schema Default

pdName

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

true

string

fsType

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

false

string

partition

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

false

integer (int32)

readOnly

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

false

boolean

v1.GenericWebHookCause

GenericWebHookCause holds information about a generic WebHook that triggered a build.

Name Description Required Schema Default

revision

revision is an optional field that stores the git source revision information of the generic webhook trigger when it is available.

false

v1.SourceRevision

secret

secret is the obfuscated webhook secret that triggered a build.

false

string

v1.GitBuildSource

GitBuildSource defines the parameters of a Git SCM

Name Description Required Schema Default

uri

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

true

string

ref

ref is the branch/tag/ref to build.

false

string

httpProxy

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

false

string

httpsProxy

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

false

string

noProxy

noProxy is the list of domains for which the proxy should not be used

false

string

v1.GitHubWebHookCause

GitHubWebHookCause has information about a GitHub webhook that triggered a build.

Name Description Required Schema Default

revision

revision is the git revision information of the trigger.

false

v1.SourceRevision

secret

secret is the obfuscated webhook secret that triggered a build.

false

string

v1.GitRepoVolumeSource

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

Name Description Required Schema Default

repository

Repository URL

true

string

revision

Commit hash for the specified revision.

false

string

directory

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

false

string

v1.GitSourceRevision

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

Name Description Required Schema Default

commit

commit is the commit hash identifying a specific commit

false

string

author

author is the author of a specific commit

false

v1.SourceControlUser

committer

committer is the committer of a specific commit

false

v1.SourceControlUser

message

message is the description of a specific commit

false

string

v1.GlusterfsVolumeSource

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

Name Description Required Schema Default

endpoints

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

true

string

path

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

true

string

readOnly

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

false

boolean

v1.Group

Group represents a referenceable set of Users

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

v1.ObjectMeta

users

Users is the list of users in this group.

true

string array

v1.GroupList

GroupList is a collection of Groups

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

unversioned.ListMeta

items

Items is the list of groups

true

v1.Group array

v1.GroupRestriction

GroupRestriction matches a group either by a string match on the group name or a label selector applied to group labels.

Name Description Required Schema Default

groups

Groups is a list of groups used to match against an individual user’s groups. If the user is a member of one of the whitelisted groups, the user is allowed to be bound to a role.

true

string array

labels

Selectors specifies a list of label selectors over group labels.

true

unversioned.LabelSelector array

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. You probably want to set "Host" in httpHeaders instead.

false

string

scheme

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

false

string

httpHeaders

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

false

v1.HTTPHeader array

v1.HTTPHeader

HTTPHeader describes a custom header to be used in HTTP probes

Name Description Required Schema Default

name

The header field name

true

string

value

The header field value

true

string

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

v1.ExecAction

httpGet

HTTPGet specifies the http request to perform.

false

v1.HTTPGetAction

tcpSocket

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

false

v1.TCPSocketAction

v1.HostPathVolumeSource

Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.

Name Description Required Schema Default

path

Path of the directory on the host. More info: http://kubernetes.io/docs/user-guide/volumes#hostpath

true

string

v1.HostSubnet

HostSubnet describes the container subnet network on a node. The HostSubnet object must have the same name as the Node object it corresponds to.

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

v1.ObjectMeta

host

Host is the name of the node. (This is redundant with the object’s name, and this field is not actually used any more.)

true

string

hostIP

HostIP is the IP address to be used as a VTEP by other nodes in the overlay network

true

string

subnet

Subnet is the CIDR range of the overlay network assigned to the node for its pods

true

string

v1.HostSubnetList

HostSubnetList is a collection of HostSubnets

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

unversioned.ListMeta

items

Items is the list of host subnets

true

v1.HostSubnet array

v1.ISCSIVolumeSource

Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.

Name Description Required Schema 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)

iscsiInterface

Optional: Defaults to 'default' (tcp). iSCSI interface name that uses an iSCSI transport.

false

string

fsType

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

false

string

readOnly

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.

false

boolean

v1.Identity

Identity records a successful authentication of a user with an identity provider. The information about the source of authentication is stored on the identity, and the identity is then associated with a single user object. Multiple identities can reference a single user. Information retrieved from the authentication provider is stored in the extra field using a schema determined by the provider.

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

v1.ObjectMeta

providerName

ProviderName is the source of identity information

true

string

providerUserName

ProviderUserName uniquely represents this identity in the scope of the provider

true

string

user

User is a reference to the user this identity is associated with Both Name and UID must be set

true

v1.ObjectReference

extra

Extra holds extra information about this identity

false

object

v1.IdentityList

IdentityList is a collection of Identities

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

unversioned.ListMeta

items

Items is the list of identities

true

v1.Identity array

v1.Image

Image is an immutable representation of a Docker image and metadata at a point in 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

Standard object’s metadata.

false

v1.ObjectMeta

dockerImageReference

DockerImageReference is the string that can be used to pull this image.

false

string

dockerImageMetadata

DockerImageMetadata contains metadata about this image

false

string

dockerImageMetadataVersion

DockerImageMetadataVersion conveys the version of the object, which if empty defaults to "1.0"

false

string

dockerImageManifest

DockerImageManifest is the raw JSON of the manifest

false

string

dockerImageLayers

DockerImageLayers represents the layers in the image. May not be set if the image does not define that data.

true

v1.ImageLayer array

signatures

Signatures holds all signatures of the image.

false

v1.ImageSignature array

dockerImageSignatures

DockerImageSignatures provides the signatures as opaque blobs. This is a part of manifest schema v1.

false

v1.Image.dockerImageSignatures array

dockerImageManifestMediaType

DockerImageManifestMediaType specifies the mediaType of manifest. This is a part of manifest schema v2.

false

string

dockerImageConfig

DockerImageConfig is a JSON blob that the runtime uses to set up the container. This is a part of manifest schema v2.

false

string

v1.ImageChangeCause

ImageChangeCause contains information about the image that triggered a build

Name Description Required Schema Default

imageID

imageID is the ID of the image that triggered a a new build.

false

string

fromRef

fromRef contains detailed information about an image that triggered a build.

false

v1.ObjectReference

v1.ImageChangeTrigger

ImageChangeTrigger allows builds to be triggered when an ImageStream changes

Name Description Required Schema Default

lastTriggeredImageID

lastTriggeredImageID is used internally by the ImageChangeController to save last used image ID for build

false

string

from

from is a reference to an ImageStreamTag that will trigger a build when updated It is optional. If no From is specified, the From image from the build strategy will be used. Only one ImageChangeTrigger with an empty From reference is allowed in a build configuration.

false

v1.ObjectReference

v1.ImageImportSpec

ImageImportSpec describes a request to import a specific image.

Name Description Required Schema Default

from

From is the source of an image to import; only kind DockerImage is allowed

true

v1.ObjectReference

to

To is a tag in the current image stream to assign the imported image to, if name is not specified the default tag from from.name will be used

false

v1.LocalObjectReference

importPolicy

ImportPolicy is the policy controlling how the image is imported

false

v1.TagImportPolicy

includeManifest

IncludeManifest determines if the manifest for each image is returned in the response

false

boolean

v1.ImageImportStatus

ImageImportStatus describes the result of an image import.

Name Description Required Schema Default

status

Status is the status of the image import, including errors encountered while retrieving the image

true

unversioned.Status

image

Image is the metadata of that image, if the image was located

false

v1.Image

tag

Tag is the tag this image was located under, if any

false

string

v1.ImageLabel

ImageLabel represents a label applied to the resulting image.

Name Description Required Schema Default

name

name defines the name of the label. It must have non-zero length.

true

string

value

value defines the literal value of the label.

false

string

v1.ImageLayer

ImageLayer represents a single layer of the image. Some images may have multiple layers. Some may have none.

Name Description Required Schema Default

name

Name of the layer as defined by the underlying store.

true

string

size

Size of the layer in bytes as defined by the underlying store.

true

integer (int64)

mediaType

MediaType of the referenced object.

true

string

v1.ImageList

ImageList is a list of Image 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 object’s metadata.

false

unversioned.ListMeta

items

Items is a list of images

true

v1.Image array

v1.ImageSignature

ImageSignature holds a signature of an image. It allows to verify image identity and possibly other claims as long as the signature is trusted. Based on this information it is possible to restrict runnable images to those matching cluster-wide policy. Mandatory fields should be parsed by clients doing image verification. The others are parsed from signature’s content by the server. They serve just an informative purpose.

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

v1.ObjectMeta

type

Required: Describes a type of stored blob.

true

string

content

Required: An opaque binary string which is an image’s signature.

true

string

conditions

Conditions represent the latest available observations of a signature’s current state.

false

v1.SignatureCondition array

imageIdentity

A human readable string representing image’s identity. It could be a product name and version, or an image pull spec (e.g. "registry.access.redhat.com/rhel7/rhel:7.2").

false

string

signedClaims

Contains claims from the signature.

false

object

created

If specified, it is the time of signature’s creation.

false

string

issuedBy

If specified, it holds information about an issuer of signing certificate or key (a person or entity who signed the signing certificate or key).

false

v1.SignatureIssuer

issuedTo

If specified, it holds information about a subject of signing certificate or key (a person or entity who signed the image).

false

v1.SignatureSubject

v1.ImageSource

ImageSource is used to describe build source that will be extracted from an image. A reference of type ImageStreamTag, ImageStreamImage or DockerImage may be used. A pull secret can be specified to pull the image from an external registry or override the default service account secret if pulling from the internal registry. A list of paths to copy from the image and their respective destination within the build directory must be specified in the paths array.

Name Description Required Schema Default

from

from is a reference to an ImageStreamTag, ImageStreamImage, or DockerImage to copy source from.

true

v1.ObjectReference

paths

paths is a list of source and destination paths to copy from the image.

true

v1.ImageSourcePath array

pullSecret

pullSecret is a reference to a secret to be used to pull the image from a registry If the image is pulled from the OpenShift registry, this field does not need to be set.

false

v1.LocalObjectReference

v1.ImageSourcePath

ImageSourcePath describes a path to be copied from a source image and its destination within the build directory.

Name Description Required Schema Default

sourcePath

sourcePath is the absolute path of the file or directory inside the image to copy to the build directory.

true

string

destinationDir

destinationDir is the relative directory within the build directory where files copied from the image are placed.

true

string

v1.ImageStream

ImageStream stores a mapping of tags to images, metadata overrides that are applied when images are tagged in a stream, and an optional reference to a Docker image repository on a registry.

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

v1.ObjectMeta

spec

Spec describes the desired state of this stream

true

v1.ImageStreamSpec

status

Status describes the current state of this stream

false

v1.ImageStreamStatus

v1.ImageStreamImage

ImageStreamImage represents an Image that is retrieved by image name from an 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

Standard object’s metadata.

false

v1.ObjectMeta

image

Image associated with the ImageStream and image name.

true

v1.Image

v1.ImageStreamImport

The image stream import resource provides an easy way for a user to find and import Docker images from other Docker registries into the server. Individual images or an entire image repository may be imported, and users may choose to see the results of the import prior to tagging the resulting images into the specified image stream.

This API is intended for end-user tools that need to see the metadata of the image prior to import (for instance, to generate an application from it). Clients that know the desired image can continue to create spec.tags directly into their image streams.

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

v1.ObjectMeta

spec

Spec is a description of the images that the user wishes to import

true

v1.ImageStreamImportSpec

status

Status is the the result of importing the image

true

v1.ImageStreamImportStatus

v1.ImageStreamImportSpec

ImageStreamImportSpec defines what images should be imported.

Name Description Required Schema Default

import

Import indicates whether to perform an import - if so, the specified tags are set on the spec and status of the image stream defined by the type meta.

true

boolean

repository

Repository is an optional import of an entire Docker image repository. A maximum limit on the number of tags imported this way is imposed by the server.

false

v1.RepositoryImportSpec

images

Images are a list of individual images to import.

false

v1.ImageImportSpec array

v1.ImageStreamImportStatus

ImageStreamImportStatus contains information about the status of an image stream import.

Name Description Required Schema Default

import

Import is the image stream that was successfully updated or created when 'to' was set.

false

v1.ImageStream

repository

Repository is set if spec.repository was set to the outcome of the import

false

v1.RepositoryImportStatus

images

Images is set with the result of importing spec.images

false

v1.ImageImportStatus array

v1.ImageStreamList

ImageStreamList is a list of ImageStream 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 object’s metadata.

false

unversioned.ListMeta

items

Items is a list of imageStreams

true

v1.ImageStream array

v1.ImageStreamMapping

ImageStreamMapping represents a mapping from a single tag to a Docker image as well as the reference to the Docker image stream the image came from.

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

v1.ObjectMeta

image

Image is a Docker image.

true

v1.Image

tag

Tag is a string value this image can be located with inside the stream.

true

string

v1.ImageStreamSpec

ImageStreamSpec represents options for ImageStreams.

Name Description Required Schema Default

dockerImageRepository

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

false

string

tags

Tags map arbitrary string values to specific image locators

false

v1.TagReference array

v1.ImageStreamStatus

ImageStreamStatus contains information about the state of this image stream.

Name Description Required Schema Default

dockerImageRepository

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

true

string

tags

Tags are a historical record of images associated with each tag. The first entry in the TagEvent array is the currently tagged image.

false

v1.NamedTagEventList array

v1.ImageStreamTag

ImageStreamTag represents an Image that is retrieved by tag name from an 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

Standard object’s metadata.

false

v1.ObjectMeta

tag

Tag is the spec tag associated with this image stream tag, and it may be null if only pushes have occurred to this image stream.

true

v1.TagReference

generation

Generation is the current generation of the tagged image - if tag is provided and this value is not equal to the tag generation, a user has requested an import that has not completed, or Conditions will be filled out indicating any error.

true

integer (int64)

conditions

Conditions is an array of conditions that apply to the image stream tag.

false

v1.TagEventCondition array

image

Image associated with the ImageStream and tag.

true

v1.Image

v1.ImageStreamTagList

ImageStreamTagList is a list of ImageStreamTag 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 object’s metadata.

false

unversioned.ListMeta

items

Items is the list of image stream tags

true

v1.ImageStreamTag array

v1.JenkinsPipelineBuildStrategy

JenkinsPipelineBuildStrategy holds parameters specific to a Jenkins Pipeline build. This strategy is in tech preview.

Name Description Required Schema Default

jenkinsfilePath

JenkinsfilePath is the optional path of the Jenkinsfile that will be used to configure the pipeline relative to the root of the context (contextDir). If both JenkinsfilePath & Jenkinsfile are both not specified, this defaults to Jenkinsfile in the root of the specified contextDir.

false

string

jenkinsfile

Jenkinsfile defines the optional raw contents of a Jenkinsfile which defines a Jenkins pipeline build.

false

string

v1.KeyToPath

Maps a string key to a path within a volume.

Name Description Required Schema Default

key

The key to project.

true

string

path

The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

true

string

mode

Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

v1.Lifecycle

Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.

Name Description Required Schema Default

postStart

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: http://kubernetes.io/docs/user-guide/container-environment#hook-details

false

v1.Handler

preStop

PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: http://kubernetes.io/docs/user-guide/container-environment#hook-details

false

v1.Handler

v1.LifecycleHook

LifecycleHook defines a specific deployment lifecycle action. Only one type of action may be specified at any time.

Name Description Required Schema Default

failurePolicy

FailurePolicy specifies what action to take if the hook fails.

true

string

execNewPod

ExecNewPod specifies the options for a lifecycle hook backed by a pod.

false

v1.ExecNewPodHook

tagImages

TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag.

false

v1.TagImageHook array

v1.LocalObjectReference

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

Name Description Required Schema Default

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

v1.LocalResourceAccessReview

LocalResourceAccessReview is a means to request a list of which users and groups are authorized to perform the action specified by spec in a particular namespace

Name Description Required Schema 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 is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces

true

string

verb

Verb is one of: get, list, watch, create, update, delete

true

string

resourceAPIGroup

Group is the API group of the resource Serialized as resourceAPIGroup to avoid confusion with the 'groups' field when inlined

true

string

resourceAPIVersion

Version is the API version of the resource Serialized as resourceAPIVersion to avoid confusion with TypeMeta.apiVersion and ObjectMeta.resourceVersion when inlined

true

string

resource

Resource is one of the existing resource types

true

string

resourceName

ResourceName is the name of the resource being requested for a "get" or deleted for a "delete"

true

string

path

Path is the path of a non resource URL

true

string

isNonResourceURL

IsNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hieraarchy)

true

boolean

content

Content is the actual content of the request for create and update

false

string

v1.LocalSubjectAccessReview

LocalSubjectAccessReview is an object for requesting information about whether a user or group can perform an action in a particular namespace

Name Description Required Schema 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 is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces

true

string

verb

Verb is one of: get, list, watch, create, update, delete

true

string

resourceAPIGroup

Group is the API group of the resource Serialized as resourceAPIGroup to avoid confusion with the 'groups' field when inlined

true

string

resourceAPIVersion

Version is the API version of the resource Serialized as resourceAPIVersion to avoid confusion with TypeMeta.apiVersion and ObjectMeta.resourceVersion when inlined

true

string

resource

Resource is one of the existing resource types

true

string

resourceName

ResourceName is the name of the resource being requested for a "get" or deleted for a "delete"

true

string

path

Path is the path of a non resource URL

true

string

isNonResourceURL

IsNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hieraarchy)

true

boolean

content

Content is the actual content of the request for create and update

false

string

user

User is optional. If both User and Groups are empty, the current authenticated user is used.

true

string

groups

Groups is optional. Groups is the list of groups to which the User belongs.

true

string array

scopes

Scopes to use for the evaluation. Empty means "use the unscoped (full) permissions of the user/groups". Nil for a self-SAR, means "use the scopes on this request". Nil for a regular SAR, means the same as empty.

true

string array

v1.NFSVolumeSource

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

Name Description Required Schema Default

server

Server is the hostname or IP address of the NFS server. More info: http://kubernetes.io/docs/user-guide/volumes#nfs

true

string

path

Path that is exported by the NFS server. More info: http://kubernetes.io/docs/user-guide/volumes#nfs

true

string

readOnly

ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: http://kubernetes.io/docs/user-guide/volumes#nfs

false

boolean

v1.NamedClusterRole

NamedClusterRole relates a name with a cluster role

Name Description Required Schema Default

name

Name is the name of the cluster role

true

string

role

Role is the cluster role being named

true

v1.ClusterRole

v1.NamedClusterRoleBinding

NamedClusterRoleBinding relates a name with a cluster role binding

Name Description Required Schema Default

name

Name is the name of the cluster role binding

true

string

roleBinding

RoleBinding is the cluster role binding being named

true

v1.ClusterRoleBinding

v1.NamedRole

NamedRole relates a Role with a name

Name Description Required Schema Default

name

Name is the name of the role

true

string

role

Role is the role being named

true

v1.Role

v1.NamedRoleBinding

NamedRoleBinding relates a role binding with a name

Name Description Required Schema Default

name

Name is the name of the role binding

true

string

roleBinding

RoleBinding is the role binding being named

true

v1.RoleBinding

v1.NamedTagEventList

NamedTagEventList relates a tag to its image history.

Name Description Required Schema Default

tag

Tag is the tag for which the history is recorded

true

string

items

Standard object’s metadata.

true

v1.TagEvent array

conditions

Conditions is an array of conditions that apply to the tag event list.

false

v1.TagEventCondition array

v1.NetNamespace

NetNamespace describes a single isolated network. When using the redhat/openshift-ovs-multitenant plugin, every Namespace will have a corresponding NetNamespace object with the same name. (When using redhat/openshift-ovs-subnet, NetNamespaces are not used.)

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

v1.ObjectMeta

netname

NetName is the name of the network namespace. (This is the same as the object’s name, but both fields must be set.)

true

string

netid

NetID is the network identifier of the network namespace assigned to each overlay network packet. This can be manipulated with the "oc adm pod-network" commands.

true

integer

v1.NetNamespaceList

NetNamespaceList is a collection of 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

Standard object’s metadata.

false

unversioned.ListMeta

items

Items is the list of net namespaces

true

v1.NetNamespace array

v1.OAuthAccessToken

OAuthAccessToken describes an OAuth access token

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

v1.ObjectMeta

clientName

ClientName references the client that created this token.

false

string

expiresIn

ExpiresIn is the seconds from CreationTime before this token expires.

false

integer (int64)

scopes

Scopes is an array of the requested scopes.

false

string array

redirectURI

RedirectURI is the redirection associated with the token.

false

string

userName

UserName is the user name associated with this token

false

string

userUID

UserUID is the unique UID associated with this token

false

string

authorizeToken

AuthorizeToken contains the token that authorized this token

false

string

refreshToken

RefreshToken is the value by which this token can be renewed. Can be blank.

false

string

v1.OAuthAccessTokenList

OAuthAccessTokenList is a collection of OAuth access tokens

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

unversioned.ListMeta

items

Items is the list of OAuth access tokens

true

v1.OAuthAccessToken array

v1.OAuthAuthorizeToken

OAuthAuthorizeToken describes an OAuth authorization token

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

v1.ObjectMeta

clientName

ClientName references the client that created this token.

false

string

expiresIn

ExpiresIn is the seconds from CreationTime before this token expires.

false

integer (int64)

scopes

Scopes is an array of the requested scopes.

false

string array

redirectURI

RedirectURI is the redirection associated with the token.

false

string

state

State data from request

false

string

userName

UserName is the user name associated with this token

false

string

userUID

UserUID is the unique UID associated with this token. UserUID and UserName must both match for this token to be valid.

false

string

codeChallenge

CodeChallenge is the optional code_challenge associated with this authorization code, as described in rfc7636

false

string

codeChallengeMethod

CodeChallengeMethod is the optional code_challenge_method associated with this authorization code, as described in rfc7636

false

string

v1.OAuthAuthorizeTokenList

OAuthAuthorizeTokenList is a collection of OAuth authorization tokens

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

unversioned.ListMeta

items

Items is the list of OAuth authorization tokens

true

v1.OAuthAuthorizeToken array

v1.OAuthClient

OAuthClient describes an OAuth client

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

v1.ObjectMeta

secret

Secret is the unique secret associated with a client

false

string

additionalSecrets

AdditionalSecrets holds other secrets that may be used to identify the client. This is useful for rotation and for service account token validation

false

string array

respondWithChallenges

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

false

boolean

redirectURIs

RedirectURIs is the valid redirection URIs associated with a client

false

string array

grantMethod

GrantMethod determines how to handle grants for this client. If no method is provided, the cluster default grant handling method will be used. Valid grant handling methods are:
- auto: always approves grant requests, useful for trusted clients
- prompt: prompts the end user for approval of grant requests, useful for third-party clients
- deny: always denies grant requests, useful for black-listed clients

false

string

scopeRestrictions

ScopeRestrictions describes which scopes this client can request. Each requested scope is checked against each restriction. If any restriction matches, then the scope is allowed. If no restriction matches, then the scope is denied.

false

v1.ScopeRestriction array

v1.OAuthClientAuthorization

OAuthClientAuthorization describes an authorization created by an OAuth client

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

v1.ObjectMeta

clientName

ClientName references the client that created this authorization

false

string

userName

UserName is the user name that authorized this client

false

string

userUID

UserUID is the unique UID associated with this authorization. UserUID and UserName must both match for this authorization to be valid.

false

string

scopes

Scopes is an array of the granted scopes.

false

string array

v1.OAuthClientAuthorizationList

OAuthClientAuthorizationList is a collection of OAuth client authorizations

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

unversioned.ListMeta

items

Items is the list of OAuth client authorizations

true

v1.OAuthClientAuthorization array

v1.OAuthClientList

OAuthClientList is a collection of OAuth clients

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

unversioned.ListMeta

items

Items is the list of OAuth clients

true

v1.OAuthClient 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.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://kubernetes.io/docs/user-guide/identifiers#names

false

string

generateName

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

Applied only if Name is not specified. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#idempotency

false

string

namespace

Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

false

string

selfLink

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

false

string

uid

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

false

string

resourceVersion

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

generation

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

false

integer (int64)

creationTimestamp

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

string

deletionTimestamp

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

string

deletionGracePeriodSeconds

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

false

integer (int64)

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

false

object

annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

false

object

ownerReferences

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

false

v1.OwnerReference array

finalizers

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

false

string array

clusterName

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

false

string

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://kubernetes.io/docs/user-guide/namespaces

false

string

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

uid

UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

false

string

apiVersion

API version of the referent.

false

string

resourceVersion

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

false

string

fieldPath

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.

false

string

v1.OwnerReference

OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

Name Description Required Schema Default

apiVersion

API version of the referent.

true

string

kind

Kind of the referent. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

true

string

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

true

string

uid

UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

true

string

controller

If true, this reference points to the managing controller.

false

boolean

v1.Parameter

Parameter defines a name/value variable that is to be processed during the Template to Config transformation.

Name Description Required Schema Default

name

Name must be set and it can be referenced in Template Items using ${PARAMETER_NAME}. Required.

true

string

displayName

Optional: The name that will show in UI instead of parameter 'Name'

false

string

description

Description of a parameter. Optional.

false

string

value

Value holds the Parameter data. If specified, the generator will be ignored. The value replaces all occurrences of the Parameter ${Name} expression during the Template to Config transformation. Optional.

false

string

generate

generate specifies the generator to be used to generate random string from an input value specified by From field. The result string is stored into Value field. If empty, no generator is being used, leaving the result Value untouched. Optional.

The only supported generator is "expression", which accepts a "from" value in the form of a simple regular expression containing the range expression "[a-zA-Z0-9]", and the length expression "a{length}".

Examples:

from

value

false

string

from

From is an input value for the generator. Optional.

false

string

required

Optional: Indicates the parameter must have a value. Defaults to false.

false

boolean

v1.PersistentVolumeClaimVolumeSource

PersistentVolumeClaimVolumeSource references the user’s PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).

Name Description Required Schema Default

claimName

ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims

true

string

readOnly

Will force the ReadOnly setting in VolumeMounts. Default false.

false

boolean

v1.PhotonPersistentDiskVolumeSource

Represents a Photon Controller persistent disk resource.

Name Description Required Schema Default

pdID

ID that identifies Photon Controller persistent disk

true

string

fsType

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

false

string

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

v1.SELinuxOptions

runAsUser

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

false

integer (int64)

runAsNonRoot

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

boolean

supplementalGroups

A list of groups applied to the first process run in each container, in addition to the container’s primary GID. If unspecified, no groups will be added to any container.

false

integer array

fsGroup

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:

1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR’d with rw-rw

false

integer (int64)

v1.PodSecurityPolicyReview

PodSecurityPolicyReview checks which service accounts (not users, since that would be cluster-wide) can create the PodTemplateSpec in question.

Name Description Required Schema 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

spec is the PodSecurityPolicy to check.

true

v1.PodSecurityPolicyReviewSpec

status

status represents the current information/status for the PodSecurityPolicyReview.

false

v1.PodSecurityPolicyReviewStatus

v1.PodSecurityPolicyReviewSpec

PodSecurityPolicyReviewSpec defines specification for PodSecurityPolicyReview

Name Description Required Schema Default

template

template is the PodTemplateSpec to check. The template.spec.serviceAccountName field is used if serviceAccountNames is empty, unless the template.spec.serviceAccountName is empty, in which case "default" is used. If serviceAccountNames is specified, template.spec.serviceAccountName is ignored.

true

v1.PodTemplateSpec

serviceAccountNames

serviceAccountNames is an optional set of ServiceAccounts to run the check with. If serviceAccountNames is empty, the template.spec.serviceAccountName is used, unless it’s empty, in which case "default" is used instead. If serviceAccountNames is specified, template.spec.serviceAccountName is ignored.

false

string array

v1.PodSecurityPolicyReviewStatus

PodSecurityPolicyReviewStatus represents the status of PodSecurityPolicyReview.

Name Description Required Schema Default

allowedServiceAccounts

allowedServiceAccounts returns the list of service accounts in this namespace that have the power to create the PodTemplateSpec.

true

v1.ServiceAccountPodSecurityPolicyReviewStatus array

v1.PodSecurityPolicySelfSubjectReview

PodSecurityPolicySelfSubjectReview checks whether this user/SA tuple can create the PodTemplateSpec

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

spec defines specification the PodSecurityPolicySelfSubjectReview.

true

v1.PodSecurityPolicySelfSubjectReviewSpec

status

status represents the current information/status for the PodSecurityPolicySelfSubjectReview.

false

v1.PodSecurityPolicySubjectReviewStatus

v1.PodSecurityPolicySelfSubjectReviewSpec

PodSecurityPolicySelfSubjectReviewSpec contains specification for PodSecurityPolicySelfSubjectReview.

Name Description Required Schema Default

template

template is the PodTemplateSpec to check.

true

v1.PodTemplateSpec

v1.PodSecurityPolicySubjectReview

PodSecurityPolicySubjectReview checks whether a particular user/SA tuple can create the PodTemplateSpec.

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

spec defines specification for the PodSecurityPolicySubjectReview.

true

v1.PodSecurityPolicySubjectReviewSpec

status

status represents the current information/status for the PodSecurityPolicySubjectReview.

false

v1.PodSecurityPolicySubjectReviewStatus

v1.PodSecurityPolicySubjectReviewSpec

PodSecurityPolicySubjectReviewSpec defines specification for PodSecurityPolicySubjectReview

Name Description Required Schema Default

template

template is the PodTemplateSpec to check. If template.spec.serviceAccountName is empty it will not be defaulted. If its non-empty, it will be checked.

true

v1.PodTemplateSpec

user

user is the user you’re testing for. If you specify "user" but not "group", then is it interpreted as "What if user were not a member of any groups. If user and groups are empty, then the check is performed using only the serviceAccountName in the template.

false

string

groups

groups is the groups you’re testing for.

false

string array

v1.PodSecurityPolicySubjectReviewStatus

PodSecurityPolicySubjectReviewStatus contains information/status for PodSecurityPolicySubjectReview.

Name Description Required Schema Default

allowedBy

allowedBy is a reference to the rule that allows the PodTemplateSpec. A rule can be a SecurityContextConstraint or a PodSecurityPolicy A nil, indicates that it was denied.

false

v1.ObjectReference

reason

A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available.

false

string

template

template is the PodTemplateSpec after the defaulting is applied.

false

v1.PodTemplateSpec

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://kubernetes.io/docs/user-guide/volumes

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://kubernetes.io/docs/user-guide/containers

true

v1.Container array

restartPolicy

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://kubernetes.io/docs/user-guide/pod-states#restartpolicy

false

string

terminationGracePeriodSeconds

Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.

false

integer (int64)

activeDeadlineSeconds

Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.

false

integer (int64)

dnsPolicy

Set DNS policy for containers within the pod. One of 'ClusterFirst' or 'Default'. Defaults to "ClusterFirst".

false

string

nodeSelector

NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: http://kubernetes.io/docs/user-guide/node-selection/README

false

object

serviceAccountName

ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: http://releases.k8s.io/HEAD/docs/design/service_accounts.md

false

string

serviceAccount

DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.

false

string

nodeName

NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.

false

string

hostNetwork

Host networking requested for this pod. Use the host’s network namespace. If this option is set, the ports that will be used must be specified. Default to false.

false

boolean

hostPID

Use the host’s pid namespace. Optional: Default to false.

false

boolean

hostIPC

Use the host’s ipc namespace. Optional: Default to false.

false

boolean

securityContext

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

false

v1.PodSecurityContext

imagePullSecrets

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod

false

v1.LocalObjectReference array

hostname

Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value.

false

string

subdomain

If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all.

false

string

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

v1.ObjectMeta

spec

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

false

v1.PodSpec

v1.Policy

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

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

v1.ObjectMeta

lastModified

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

true

string

roles

Roles holds all the Roles held by this Policy, mapped by Role.Name

true

v1.NamedRole array

v1.PolicyBinding

PolicyBinding is a object that holds all the RoleBindings for a particular namespace. There is one PolicyBinding document per referenced Policy namespace

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

v1.ObjectMeta

lastModified

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

true

string

policyRef

PolicyRef is a reference to the Policy that contains all the Roles that this PolicyBinding’s RoleBindings may reference

true

v1.ObjectReference

roleBindings

RoleBindings holds all the RoleBindings held by this PolicyBinding, mapped by RoleBinding.Name

true

v1.NamedRoleBinding array

v1.PolicyBindingList

PolicyBindingList is a collection of PolicyBindings

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

unversioned.ListMeta

items

Items is a list of PolicyBindings

true

v1.PolicyBinding array

v1.PolicyList

PolicyList is a collection of Policies

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

unversioned.ListMeta

items

Items is a list of Policies

true

v1.Policy array

v1.PolicyRule

PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.

Name Description Required Schema Default

verbs

Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.

true

string array

attributeRestrictions

AttributeRestrictions will vary depending on what the Authorizer/AuthorizationAttributeBuilder pair supports. If the Authorizer does not recognize how to handle the AttributeRestrictions, the Authorizer should report an error.

false

string

apiGroups

APIGroups is the name of the APIGroup that contains the resources. If this field is empty, then both kubernetes and origin API groups are assumed. That means that if an action is requested against one of the enumerated resources in either the kubernetes or the origin API group, the request will be allowed

true

string array

resources

Resources is a list of resources this rule applies to. ResourceAll represents all resources.

true

string array

resourceNames

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

false

string array

nonResourceURLs

NonResourceURLsSlice is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path This name is intentionally different than the internal type so that the DefaultConvert works nicely and because the ordering may be different.

false

string array

v1.Preconditions

Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

Name Description Required Schema Default

uid

Specifies the target UID.

false

types.UID

v1.Probe

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

Name Description Required Schema Default

exec

One and only one of the following should be specified. Exec specifies the action to take.

false

v1.ExecAction

httpGet

HTTPGet specifies the http request to perform.

false

v1.HTTPGetAction

tcpSocket

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

false

v1.TCPSocketAction

initialDelaySeconds

Number of seconds after the container has started before liveness probes are initiated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes

false

integer (int32)

timeoutSeconds

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes

false

integer (int32)

periodSeconds

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

false

integer (int32)

successThreshold

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

false

integer (int32)

failureThreshold

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

false

integer (int32)

v1.Project

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

Listing or watching projects will return only projects the user has the reader role on.

An OpenShift project is an alternative representation of a Kubernetes namespace. Projects are exposed as editable to end users while namespaces are not. Direct creation of a project is typically restricted to administrators, while end users should use the requestproject resource.

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

v1.ObjectMeta

spec

Spec defines the behavior of the Namespace.

false

v1.ProjectSpec

status

Status describes the current status of a Namespace

false

v1.ProjectStatus

v1.ProjectList

ProjectList is a list of Project 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 object’s metadata.

false

unversioned.ListMeta

items

Items is the list of projects

true

v1.Project array

v1.ProjectRequest

ProjectRequest is the set of options necessary to fully qualify a project request

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

Standard object’s metadata.

subfield name

v1.ObjectMeta

displayName

DisplayName is the display name to apply to a project

false

string

description

Description is the description to apply to a project

false

string

v1.ProjectSpec

ProjectSpec describes the attributes on a Project

Name Description Required Schema Default

finalizers

Finalizers is an opaque list of values that must be empty to permanently remove object from storage

false

v1.FinalizerName array

v1.ProjectStatus

ProjectStatus is information about the current status of a Project

Name Description Required Schema Default

phase

Phase is the current lifecycle phase of the project

false

string

v1.QuobyteVolumeSource

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

Name Description Required Schema Default

registry

Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes

true

string

volume

Volume is a string that references an already created Quobyte volume by name.

true

string

readOnly

ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.

false

boolean

user

User to map volume access to Defaults to serivceaccount user

false

string

group

Group to map volume access to Default is no group

false

string

v1.RBDVolumeSource

Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.

Name Description Required Schema Default

monitors

A collection of Ceph monitors. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

true

string array

image

The rados image name. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

true

string

fsType

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

false

string

pool

The rados pool name. Default is rbd. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it.

false

string

user

The rados user name. Default is admin. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

false

string

keyring

Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

false

string

secretRef

SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

false

v1.LocalObjectReference

readOnly

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

false

boolean

v1.RecreateDeploymentStrategyParams

RecreateDeploymentStrategyParams are the input to the Recreate deployment strategy.

Name Description Required Schema Default

timeoutSeconds

TimeoutSeconds is the time to wait for updates before giving up. If the value is nil, a default will be used.

false

integer (int64)

pre

Pre is a lifecycle hook which is executed before the strategy manipulates the deployment. All LifecycleHookFailurePolicy values are supported.

false

v1.LifecycleHook

mid

Mid is a lifecycle hook which is executed while the deployment is scaled down to zero before the first new pod is created. All LifecycleHookFailurePolicy values are supported.

false

v1.LifecycleHook

post

Post is a lifecycle hook which is executed after the strategy has finished all deployment logic. All LifecycleHookFailurePolicy values are supported.

false

v1.LifecycleHook

v1.RepositoryImportSpec

RepositoryImportSpec describes a request to import images from a Docker image repository.

Name Description Required Schema Default

from

From is the source for the image repository to import; only kind DockerImage and a name of a Docker image repository is allowed

true

v1.ObjectReference

importPolicy

ImportPolicy is the policy controlling how the image is imported

false

v1.TagImportPolicy

includeManifest

IncludeManifest determines if the manifest for each image is returned in the response

false

boolean

v1.RepositoryImportStatus

RepositoryImportStatus describes the result of an image repository import

Name Description Required Schema Default

status

Status reflects whether any failure occurred during import

false

unversioned.Status

images

Images is a list of images successfully retrieved by the import of the repository.

false

v1.ImageImportStatus array

additionalTags

AdditionalTags are tags that exist in the repository but were not imported because a maximum limit of automatic imports was applied.

false

string array

v1.ResourceAccessReview

ResourceAccessReview is a means to request a list of which users and groups are authorized to perform the action specified by spec

Name Description Required Schema 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 is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces

true

string

verb

Verb is one of: get, list, watch, create, update, delete

true

string

resourceAPIGroup

Group is the API group of the resource Serialized as resourceAPIGroup to avoid confusion with the 'groups' field when inlined

true

string

resourceAPIVersion

Version is the API version of the resource Serialized as resourceAPIVersion to avoid confusion with TypeMeta.apiVersion and ObjectMeta.resourceVersion when inlined

true

string

resource

Resource is one of the existing resource types

true

string

resourceName

ResourceName is the name of the resource being requested for a "get" or deleted for a "delete"

true

string

path

Path is the path of a non resource URL

true

string

isNonResourceURL

IsNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hieraarchy)

true

boolean

content

Content is the actual content of the request for create and update

false

string

v1.ResourceFieldSelector

ResourceFieldSelector represents container resources (cpu, memory) and their output format

Name Description Required Schema Default

containerName

Container name: required for volumes, optional for env vars

false

string

resource

Required: resource to select

true

string

divisor

Specifies the output format of the exposed resources, defaults to "1"

false

string

v1.ResourceQuotaScope

v1.ResourceQuotaSpec

ResourceQuotaSpec defines the desired hard limits to enforce for Quota.

Name Description Required Schema Default

hard

Hard is the set of desired hard limits for each named resource. More info: http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota

false

object

scopes

A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects.

false

v1.ResourceQuotaScope array

v1.ResourceQuotaStatus

ResourceQuotaStatus defines the enforced hard limits and observed use.

Name Description Required Schema Default

hard

Hard is the set of enforced hard limits for each named resource. More info: http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota

false

object

used

Used is the current observed total usage of the resource in the namespace.

false

object

v1.ResourceQuotaStatusByNamespace

ResourceQuotaStatusByNamespace gives status for a particular project

Name Description Required Schema Default

namespace

Namespace the project this status applies to

true

string

status

Status indicates how many resources have been consumed by this project

true

v1.ResourceQuotaStatus

v1.ResourceRequirements

ResourceRequirements describes the compute resource requirements.

Name Description Required Schema Default

limits

Limits describes the maximum amount of compute resources allowed. More info: http://kubernetes.io/docs/user-guide/compute-resources/

false

object

requests

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: http://kubernetes.io/docs/user-guide/compute-resources/

false

object

v1.Role

Role is a logical grouping of PolicyRules that can be referenced as a unit by RoleBindings.

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

v1.ObjectMeta

rules

Rules holds all the PolicyRules for this Role

true

v1.PolicyRule array

v1.RoleBinding

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

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

v1.ObjectMeta

userNames

UserNames holds all the usernames directly bound to the role. This field should only be specified when supporting legacy clients and servers. See Subjects for further details.

true

string array

groupNames

GroupNames holds all the groups directly bound to the role. This field should only be specified when supporting legacy clients and servers. See Subjects for further details.

true

string array

subjects

Subjects hold object references to authorize with this rule. This field is ignored if UserNames or GroupNames are specified to support legacy clients and servers. Thus newer clients that do not need to support backwards compatibility should send only fully qualified Subjects and should omit the UserNames and GroupNames fields. Clients that need to support backwards compatibility can use this field to build the UserNames and GroupNames.

true

v1.ObjectReference array

roleRef

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

true

v1.ObjectReference

v1.RoleBindingList

RoleBindingList is a collection of RoleBindings

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

unversioned.ListMeta

items

Items is a list of RoleBindings

true

v1.RoleBinding array

v1.RoleBindingRestriction

RoleBindingRestriction is an object that can be matched against a subject (user, group, or service account) to determine whether rolebindings on that subject are allowed in the namespace to which the RoleBindingRestriction belongs. If any one of those RoleBindingRestriction objects matches a subject, rolebindings on that subject in the namespace are allowed.

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

true

v1.ObjectMeta

spec

Spec defines the matcher.

true

v1.RoleBindingRestrictionSpec

v1.RoleBindingRestrictionList

RoleBindingRestrictionList is a collection of RoleBindingRestriction 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 object’s metadata.

false

unversioned.ListMeta

items

Items is a list of RoleBindingRestriction objects.

true

v1.RoleBindingRestriction array

v1.RoleBindingRestrictionSpec

RoleBindingRestrictionSpec defines a rolebinding restriction. Exactly one field must be non-nil.

Name Description Required Schema Default

userrestriction

UserRestriction matches against user subjects.

true

v1.UserRestriction

grouprestriction

GroupRestriction matches against group subjects.

true

v1.GroupRestriction

serviceaccountrestriction

ServiceAccountRestriction matches against service-account subjects.

true

v1.ServiceAccountRestriction

v1.RoleList

RoleList is a collection of Roles

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

unversioned.ListMeta

items

Items is a list of Roles

true

v1.Role array

v1.RollingDeploymentStrategyParams

RollingDeploymentStrategyParams are the input to the Rolling deployment strategy.

Name Description Required Schema Default

updatePeriodSeconds

UpdatePeriodSeconds is the time to wait between individual pod updates. If the value is nil, a default will be used.

false

integer (int64)

intervalSeconds

IntervalSeconds is the time to wait between polling deployment status after update. If the value is nil, a default will be used.

false

integer (int64)

timeoutSeconds

TimeoutSeconds is the time to wait for updates before giving up. If the value is nil, a default will be used.

false

integer (int64)

maxUnavailable

MaxUnavailable is the maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total pods at the start of update (ex: 10%). Absolute number is calculated from percentage by rounding down.

This cannot be 0 if MaxSurge is 0. By default, 25% is used.

Example: when this is set to 30%, the old RC can be scaled down by 30% immediately when the rolling update starts. Once new pods are ready, old RC can be scaled down further, followed by scaling up the new RC, ensuring that at least 70% of original number of pods are available at all times during the update.

false

string

maxSurge

MaxSurge is the maximum number of pods that can be scheduled above the original number of pods. Value can be an absolute number (ex: 5) or a percentage of total pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up.

This cannot be 0 if MaxUnavailable is 0. By default, 25% is used.

Example: when this is set to 30%, the new RC can be scaled up by 30% immediately when the rolling update starts. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of original pods.

false

string

pre

Pre is a lifecycle hook which is executed before the deployment process begins. All LifecycleHookFailurePolicy values are supported.

false

v1.LifecycleHook

post

Post is a lifecycle hook which is executed after the strategy has finished all deployment logic. All LifecycleHookFailurePolicy values are supported.

false

v1.LifecycleHook

v1.Route

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

Once a route is created, the host field may not be changed. Generally, routers use the oldest route with a given host when resolving conflicts.

Routers are subject to additional customization and may support additional controls via the annotations field.

Because administrators may configure multiple routers, the route status field is used to return information to clients about the names and states of the route under each router. If a client chooses a duplicate name, for instance, the route status conditions are used to indicate the route cannot be chosen.

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object metadata.

false

v1.ObjectMeta

spec

spec is the desired state of the route

true

v1.RouteSpec

status

status is the current state of the route

true

v1.RouteStatus

v1.RouteIngress

RouteIngress holds information about the places where a route is exposed.

Name Description Required Schema Default

host

Host is the host string under which the route is exposed; this value is required

false

string

routerName

Name is a name chosen by the router to identify itself; this value is required

false

string

conditions

Conditions is the state of the route, may be empty.

false

v1.RouteIngressCondition array

wildcardPolicy

Wildcard policy is the wildcard policy that was allowed where this route is exposed.

false

string

routerCanonicalHostname

CanonicalHostname is the external host name for the router that can be used as a CNAME for the host requested for this route. This value is optional and may not be set in all cases.

false

string

v1.RouteIngressCondition

RouteIngressCondition contains details for the current condition of this route on a particular router.

Name Description Required Schema Default

type

Type is the type of the condition. Currently only Ready.

true

string

status

Status is the status of the condition. Can be True, False, Unknown.

true

string

reason

(brief) reason for the condition’s last transition, and is usually a machine and human readable constant

false

string

message

Human readable message indicating details about last transition.

false

string

lastTransitionTime

RFC 3339 date and time when this condition last transitioned

false

string

v1.RouteList

RouteList is a collection of Routes.

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object metadata.

false

unversioned.ListMeta

items

items is a list of routes

true

v1.Route array

v1.RoutePort

RoutePort defines a port mapping from a router to an endpoint in the service endpoints.

Name Description Required Schema Default

targetPort

The target port on pods selected by the service this route points to. If this is a string, it will be looked up as a named port in the target endpoints port list. Required

true

string

v1.RouteSpec

RouteSpec describes the hostname or path the route exposes, any security information, and one or more backends the route points to. Weights on each backend can define the balance of traffic sent to each backend - if all weights are zero the route will be considered to have no backends and return a standard 503 response.

The tls field is optional and allows specific certificates or behavior for the route. Routers typically configure a default certificate on a wildcard domain to terminate routes without explicit certificates, but custom hostnames usually must choose passthrough (send traffic directly to the backend via the TLS Server-Name- Indication field) or provide a certificate.

Name Description Required Schema Default

host

host is an alias/DNS that points to the service. Optional. If not specified a route name will typically be automatically chosen. Must follow DNS952 subdomain conventions.

true

string

path

Path that the router watches for, to route traffic for to the service. Optional

false

string

to

to is an object the route should use as the primary backend. Only the Service kind is allowed, and it will be defaulted to Service. If the weight field is set to zero, no traffic will be sent to this service.

true

v1.RouteTargetReference

alternateBackends

alternateBackends is an extension of the 'to' field. If more than one service needs to be pointed to, then use this field. Use the weight field in RouteTargetReference object to specify relative preference. If the weight field is zero, the backend is ignored.

false

v1.RouteTargetReference array

port

If specified, the port to be used by the router. Most routers will use all endpoints exposed by the service by default - set this value to instruct routers which port to use.

false

v1.RoutePort

tls

The tls field provides the ability to configure certificates and termination for the route.

false

v1.TLSConfig

wildcardPolicy

Wildcard policy if any for the route. Currently only 'Subdomain' or 'None' is allowed.

false

string

v1.RouteStatus

RouteStatus provides relevant info about the status of a route, including which routers acknowledge it.

Name Description Required Schema Default

ingress

ingress describes the places where the route may be exposed. The list of ingress points may contain duplicate Host or RouterName values. Routes are considered live once they are Ready

true

v1.RouteIngress array

v1.RouteTargetReference

RouteTargetReference specifies the target that resolve into endpoints. Only the 'Service' kind is allowed. Use 'weight' field to emphasize one over others.

Name Description Required Schema Default

kind

The kind of target that the route is referring to. Currently, only 'Service' is allowed

true

string

name

name of the service/target that is being referred to. e.g. name of the service

true

string

weight

weight as an integer between 1 and 256 that specifies the target’s relative weight against other target reference objects

true

integer (int32)

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

ScopeRestriction describe one restriction on scopes. Exactly one option must be non-nil.

Name Description Required Schema Default

literals

ExactValues means the scope has to match a particular set of strings exactly

false

string array

clusterRole

ClusterRole describes a set of restrictions for cluster role scoping.

false

v1.ClusterRoleScopeRestriction

v1.Secret

Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes.

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

data

Data contains the secret data. Each key must be a valid DNS_SUBDOMAIN or leading dot followed by valid DNS_SUBDOMAIN. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4

false

object

stringData

stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API.

false

object

type

Used to facilitate programmatic handling of secret data.

false

string

v1.SecretBuildSource

SecretBuildSource describes a secret and its destination directory that will be used only at the build time. The content of the secret referenced here will be copied into the destination directory instead of mounting.

Name Description Required Schema Default

secret

secret is a reference to an existing secret that you want to use in your build.

true

v1.LocalObjectReference

destinationDir

destinationDir is the directory where the files from the secret should be available for the build time. For the Source build strategy, these will be injected into a container where the assemble script runs. Later, when the script finishes, all files injected will be truncated to zero length. For the Docker build strategy, these will be copied into the build directory, where the Dockerfile is located, so users can ADD or COPY them during docker build.

false

string

v1.SecretKeySelector

SecretKeySelector selects a key of a Secret.

Name Description Required Schema Default

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

key

The key of the secret to select from. Must be a valid secret key.

true

string

v1.SecretList

SecretList is a list of Secret.

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

unversioned.ListMeta

items

Items is a list of secret objects. More info: http://kubernetes.io/docs/user-guide/secrets

true

v1.Secret array

v1.SecretSpec

SecretSpec specifies a secret to be included in a build pod and its corresponding mount point

Name Description Required Schema Default

secretSource

secretSource is a reference to the secret

true

v1.LocalObjectReference

mountPath

mountPath is the path at which to mount the secret

true

string

v1.SecretVolumeSource

Adapts a Secret into a volume.

The contents of the target Secret’s Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.

Name Description Required Schema Default

secretName

Name of the secret in the pod’s namespace to use. More info: http://kubernetes.io/docs/user-guide/volumes#secrets

false

string

items

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

false

v1.KeyToPath array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

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

v1.Capabilities

privileged

Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.

false

boolean

seLinuxOptions

The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

v1.SELinuxOptions

runAsUser

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

integer (int64)

runAsNonRoot

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

boolean

readOnlyRootFilesystem

Whether this container has a read-only root filesystem. Default is false.

false

boolean

v1.SelfSubjectRulesReview

SelfSubjectRulesReview is a resource you can create to determine which actions you can perform in a namespace

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

spec

Spec adds information about how to conduct the check

true

v1.SelfSubjectRulesReviewSpec

status

Status is completed by the server to tell which permissions you have

false

v1.SubjectRulesReviewStatus

v1.SelfSubjectRulesReviewSpec

SelfSubjectRulesReviewSpec adds information about how to conduct the check

Name Description Required Schema Default

scopes

Scopes to use for the evaluation. Empty means "use the unscoped (full) permissions of the user/groups". Nil means "use the scopes on this request".

true

string array

v1.ServiceAccountPodSecurityPolicyReviewStatus

ServiceAccountPodSecurityPolicyReviewStatus represents ServiceAccount name and related review status

Name Description Required Schema Default

allowedBy

allowedBy is a reference to the rule that allows the PodTemplateSpec. A rule can be a SecurityContextConstraint or a PodSecurityPolicy A nil, indicates that it was denied.

false

v1.ObjectReference

reason

A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available.

false

string

template

template is the PodTemplateSpec after the defaulting is applied.

false

v1.PodTemplateSpec

name

name contains the allowed and the denied ServiceAccount name

true

string

v1.ServiceAccountReference

ServiceAccountReference specifies a service account and namespace by their names.

Name Description Required Schema Default

name

Name is the name of the service account.

true

string

namespace

Namespace is the namespace of the service account. Service accounts from inside the whitelisted namespaces are allowed to be bound to roles. If Namespace is empty, then the namespace of the RoleBindingRestriction in which the ServiceAccountReference is embedded is used.

true

string

v1.ServiceAccountRestriction

ServiceAccountRestriction matches a service account by a string match on either the service-account name or the name of the service account’s namespace.

Name Description Required Schema Default

serviceaccounts

ServiceAccounts specifies a list of literal service-account names.

true

v1.ServiceAccountReference array

namespaces

Namespaces specifies a list of literal namespace names.

true

string array

v1.SignatureCondition

SignatureCondition describes an image signature condition of particular kind at particular probe time.

Name Description Required Schema Default

type

Type of signature condition, Complete or Failed.

true

string

status

Status of the condition, one of True, False, Unknown.

true

string

lastProbeTime

Last time the condition was checked.

false

string

lastTransitionTime

Last time the condition transit from one status to another.

false

string

reason

(brief) reason for the condition’s last transition.

false

string

message

Human readable message indicating details about last transition.

false

string

v1.SignatureIssuer

SignatureIssuer holds information about an issuer of signing certificate or key.

Name Description Required Schema Default

organization

Organization name.

false

string

commonName

Common name (e.g. openshift-signing-service).

false

string

v1.SignatureSubject

SignatureSubject holds information about a person or entity who created the signature.

Name Description Required Schema Default

organization

Organization name.

false

string

commonName

Common name (e.g. openshift-signing-service).

false

string

publicKeyID

If present, it is a human readable key id of public key belonging to the subject used to verify image signature. It should contain at least 64 lowest bits of public key’s fingerprint (e.g. 0x685ebe62bf278440).

true

string

v1.SourceBuildStrategy

SourceBuildStrategy defines input parameters specific to an Source build.

Name Description Required Schema Default

from

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

true

v1.ObjectReference

pullSecret

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

false

v1.LocalObjectReference

env

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

false

v1.EnvVar array

scripts

scripts is the location of Source scripts

false

string

incremental

incremental flag forces the Source build to do incremental builds if true.

false

boolean

forcePull

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

false

boolean

runtimeImage

runtimeImage is an optional image that is used to run an application without unneeded dependencies installed. The building of the application is still done in the builder image but, post build, you can copy the needed artifacts in the runtime image for use. This field and the feature it enables are in tech preview.

false

v1.ObjectReference

runtimeArtifacts

runtimeArtifacts specifies a list of source/destination pairs that will be copied from the builder to the runtime image. sourcePath can be a file or directory. destinationDir must be a directory. destinationDir can also be empty or equal to ".", in this case it just refers to the root of WORKDIR. This field and the feature it enables are in tech preview.

false

v1.ImageSourcePath array

v1.SourceControlUser

SourceControlUser defines the identity of a user of source control

Name Description Required Schema Default

name

name of the source control user

false

string

email

email of the source control user

false

string

v1.SourceRevision

SourceRevision is the revision or commit information from the source for the build

Name Description Required Schema Default

type

type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images'

true

string

git

Git contains information about git-based build source

false

v1.GitSourceRevision

v1.SubjectAccessReview

SubjectAccessReview is an object for requesting information about whether a user or group can perform an 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 is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces

true

string

verb

Verb is one of: get, list, watch, create, update, delete

true

string

resourceAPIGroup

Group is the API group of the resource Serialized as resourceAPIGroup to avoid confusion with the 'groups' field when inlined

true

string

resourceAPIVersion

Version is the API version of the resource Serialized as resourceAPIVersion to avoid confusion with TypeMeta.apiVersion and ObjectMeta.resourceVersion when inlined

true

string

resource

Resource is one of the existing resource types

true

string

resourceName

ResourceName is the name of the resource being requested for a "get" or deleted for a "delete"

true

string

path

Path is the path of a non resource URL

true

string

isNonResourceURL

IsNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hieraarchy)

true

boolean

content

Content is the actual content of the request for create and update

false

string

user

User is optional. If both User and Groups are empty, the current authenticated user is used.

true

string

groups

GroupsSlice is optional. Groups is the list of groups to which the User belongs.

true

string array

scopes

Scopes to use for the evaluation. Empty means "use the unscoped (full) permissions of the user/groups". Nil for a self-SAR, means "use the scopes on this request". Nil for a regular SAR, means the same as empty.

true

string array

v1.SubjectRulesReview

SubjectRulesReview is a resource you can create to determine which actions another user can perform in a namespace

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

spec

Spec adds information about how to conduct the check

true

v1.SubjectRulesReviewSpec

status

Status is completed by the server to tell which permissions you have

false

v1.SubjectRulesReviewStatus

v1.SubjectRulesReviewSpec

SubjectRulesReviewSpec adds information about how to conduct the check

Name Description Required Schema Default

user

User is optional. At least one of User and Groups must be specified.

true

string

groups

Groups is optional. Groups is the list of groups to which the User belongs. At least one of User and Groups must be specified.

true

string array

scopes

Scopes to use for the evaluation. Empty means "use the unscoped (full) permissions of the user/groups".

true

string array

v1.SubjectRulesReviewStatus

SubjectRulesReviewStatus is contains the result of a rules check

Name Description Required Schema Default

rules

Rules is the list of rules (no particular sort) that are allowed for the subject

true

v1.PolicyRule array

evaluationError

EvaluationError can appear in combination with Rules. It means some error happened during evaluation that may have prevented additional rules from being populated.

false

string

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

TLSConfig defines config used to secure a route and provide termination

Name Description Required Schema Default

termination

termination indicates termination type.

true

string

certificate

certificate provides certificate contents

false

string

key

key provides key file contents

false

string

caCertificate

caCertificate provides the cert authority certificate contents

false

string

destinationCACertificate

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

false

string

insecureEdgeTerminationPolicy

insecureEdgeTerminationPolicy indicates the desired behavior for insecure connections to a route. While each router may make its own decisions on which ports to expose, this is normally port 80.

* Allow - traffic is sent to the server on the insecure port (default) * Disable - no traffic is allowed on the insecure port. * Redirect - clients are redirected to the secure port.

false

string

v1.TagEvent

TagEvent is used by ImageStreamStatus to keep a historical record of images associated with a tag.

Name Description Required Schema Default

created

Created holds the time the TagEvent was created

true

string

dockerImageReference

DockerImageReference is the string that can be used to pull this image

true

string

image

Image is the image

true

string

generation

Generation is the spec tag generation that resulted in this tag being updated

true

integer (int64)

v1.TagEventCondition

TagEventCondition contains condition information for a tag event.

Name Description Required Schema Default

type

Type of tag event condition, currently only ImportSuccess

true

string

status

Status of the condition, one of True, False, Unknown.

true

string

lastTransitionTime

LastTransitionTIme is the time the condition transitioned from one status to another.

false

string

reason

Reason is a brief machine readable explanation for the condition’s last transition.

false

string

message

Message is a human readable description of the details about last transition, complementing reason.

false

string

generation

Generation is the spec tag generation that this status corresponds to

true

integer (int64)

v1.TagImageHook

TagImageHook is a request to tag the image in a particular container onto an ImageStreamTag.

Name Description Required Schema Default

containerName

ContainerName is the name of a container in the deployment config whose image value will be used as the source of the tag. If there is only a single container this value will be defaulted to the name of that container.

true

string

to

To is the target ImageStreamTag to set the container’s image onto.

true

v1.ObjectReference

v1.TagImportPolicy

TagImportPolicy controls how images related to this tag will be imported.

Name Description Required Schema Default

insecure

Insecure is true if the server may bypass certificate verification or connect directly over HTTP during image import.

false

boolean

scheduled

Scheduled indicates to the server that this tag should be periodically checked to ensure it is up to date, and imported

false

boolean

v1.TagReference

TagReference specifies optional annotations for images using this tag and an optional reference to an ImageStreamTag, ImageStreamImage, or DockerImage this tag should track.

Name Description Required Schema Default

name

Name of the tag

true

string

annotations

Annotations associated with images using this tag

true

object

from

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

false

v1.ObjectReference

reference

Reference states if the tag will be imported. Default value is false, which means the tag will be imported.

false

boolean

generation

Generation is the image stream generation that updated this tag - setting it to 0 is an indication that the generation must be updated. Legacy clients will send this as nil, which means the client doesn’t know or care.

true

integer (int64)

importPolicy

Import is information that controls how images may be imported by the server.

false

v1.TagImportPolicy

referencePolicy

ReferencePolicy defines how other components should consume the image

false

v1.TagReferencePolicy

v1.TagReferencePolicy

TagReferencePolicy describes how pull-specs for images in this image stream tag are generated when image change triggers in deployment configs or builds are resolved. This allows the image stream author to control how images are accessed.

Name Description Required Schema Default

type

Type determines how the image pull spec should be transformed when the image stream tag is used in deployment config triggers or new builds. The default value is Source, indicating the original location of the image should be used (if imported). The user may also specify Local, indicating that the pull spec should point to the integrated Docker registry and leverage the registry’s ability to proxy the pull to an upstream registry. Local allows the credentials used to pull this image to be managed from the image stream’s namespace, so others on the platform can access a remote image but have no access to the remote secret. It also allows the image layers to be mirrored into the local registry which the images can still be pulled even if the upstream registry is unavailable.

true

string

v1.Template

Template contains the inputs needed to produce a Config.

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

v1.ObjectMeta

message

message is an optional instructional message that will be displayed when this template is instantiated. This field should inform the user how to utilize the newly created resources. Parameter substitution will be performed on the message before being displayed so that generated credentials and other parameters can be included in the output.

false

string

objects

objects is an array of resources to include in this template. If a namespace value is hardcoded in the object, it will be removed during template instantiation, however if the namespace value is, or contains, a ${PARAMETER_REFERENCE}, the resolved value after parameter substitution will be respected and the object will be created in that namespace.

true

runtime.RawExtension array

parameters

parameters is an optional array of Parameters used during the Template to Config transformation.

false

v1.Parameter array

labels

labels is a optional set of labels that are applied to every object during the Template to Config transformation.

false

object

v1.TemplateList

TemplateList is a list of Template 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 object’s metadata.

false

unversioned.ListMeta

items

Items is a list of templates

true

v1.Template array

v1.User

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

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

v1.ObjectMeta

fullName

FullName is the full name of user

false

string

identities

Identities are the identities associated with this user

true

string array

groups

Groups specifies group names this user is a member of. This field is deprecated and will be removed in a future release. Instead, create a Group object containing the name of this User.

true

string array

v1.UserIdentityMapping

UserIdentityMapping maps a user to an 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

Standard object’s metadata.

false

v1.ObjectMeta

identity

Identity is a reference to an identity

false

v1.ObjectReference

user

User is a reference to a user

false

v1.ObjectReference

v1.UserList

UserList is a collection of Users

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object’s metadata.

false

unversioned.ListMeta

items

Items is the list of users

true

v1.User array

v1.UserRestriction

UserRestriction matches a user either by a string match on the user name, a string match on the name of a group to which the user belongs, or a label selector applied to the user labels.

Name Description Required Schema Default

users

Users specifies a list of literal user names.

true

string array

groups

Groups specifies a list of literal group names.

true

string array

labels

Selectors specifies a list of label selectors over user labels.

true

unversioned.LabelSelector array

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://kubernetes.io/docs/user-guide/identifiers#names

true

string

hostPath

HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: http://kubernetes.io/docs/user-guide/volumes#hostpath

false

v1.HostPathVolumeSource

emptyDir

EmptyDir represents a temporary directory that shares a pod’s lifetime. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

false

v1.EmptyDirVolumeSource

gcePersistentDisk

GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk

false

v1.GCEPersistentDiskVolumeSource

awsElasticBlockStore

AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore

false

v1.AWSElasticBlockStoreVolumeSource

gitRepo

GitRepo represents a git repository at a particular revision.

false

v1.GitRepoVolumeSource

secret

Secret represents a secret that should populate this volume. More info: http://kubernetes.io/docs/user-guide/volumes#secrets

false

v1.SecretVolumeSource

nfs

NFS represents an NFS mount on the host that shares a pod’s lifetime More info: http://kubernetes.io/docs/user-guide/volumes#nfs

false

v1.NFSVolumeSource

iscsi

ISCSI represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/HEAD/examples/volumes/iscsi/README.md

false

v1.ISCSIVolumeSource

glusterfs

Glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md

false

v1.GlusterfsVolumeSource

persistentVolumeClaim

PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims

false

v1.PersistentVolumeClaimVolumeSource

rbd

RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md

false

v1.RBDVolumeSource

flexVolume

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

false

v1.FlexVolumeSource

cinder

Cinder represents a cinder volume attached and mounted on kubelets host machine More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

false

v1.CinderVolumeSource

cephfs

CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime

false

v1.CephFSVolumeSource

flocker

Flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running

false

v1.FlockerVolumeSource

downwardAPI

DownwardAPI represents downward API about the pod that should populate this volume

false

v1.DownwardAPIVolumeSource

fc

FC represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.

false

v1.FCVolumeSource

azureFile

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

false

v1.AzureFileVolumeSource

configMap

ConfigMap represents a configMap that should populate this volume

false

v1.ConfigMapVolumeSource

vsphereVolume

VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

false

v1.VsphereVirtualDiskVolumeSource

quobyte

Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

false

v1.QuobyteVolumeSource

azureDisk

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

false

v1.AzureDiskVolumeSource

photonPersistentDisk

PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

false

v1.PhotonPersistentDiskVolumeSource

metadata

Metadata represents metadata about the pod that should populate this volume Deprecated: Use downwardAPI instead.

false

v1.DeprecatedDownwardAPIVolumeSource

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

mountPath

Path within the container at which the volume should be mounted. Must not contain ':'.

true

string

subPath

Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root).

false

string

v1.VsphereVirtualDiskVolumeSource

Represents a vSphere volume resource.

Name Description Required Schema Default

volumePath

Path that identifies vSphere volume vmdk

true

string

fsType

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

false

string

v1.WebHookTrigger

WebHookTrigger is a trigger that gets invoked using a webhook type of post

Name Description Required Schema Default

secret

secret used to validate requests.

false

string

allowEnv

allowEnv determines whether the webhook can set environment variables; can only be set to true for GenericWebHook.

false

boolean

v1beta1.Scale

represents a scaling request for a resource.

Name Description Required Schema Default

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object metadata; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata.

false

v1.ObjectMeta

spec

defines the behavior of the scale. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status.

false

v1beta1.ScaleSpec

status

current status of the scale. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status. Read-only.

false

v1beta1.ScaleStatus

v1beta1.ScaleSpec

describes the attributes of a scale subresource

Name Description Required Schema Default

replicas

desired number of instances for the scaled object.

false

integer (int32)

v1beta1.ScaleStatus

represents the current status of a scale subresource.

Name Description Required Schema Default

replicas

actual number of observed instances of the scaled object.

true

integer (int32)

selector

label query over pods that should match the replicas count. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors

false

object

targetSelector

label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors

false

string

versioned.Event

Name Description Required Schema Default

type

true

string

object

true

string