Chapter 2. OpenShift Container Platform v1 REST API
2.1. Overview
The OpenShift Container Platform API exposes operations for managing an enterprise Kubernetes cluster, including security and user management, application deployments, image and source builds, HTTP(s) routing, and project management.
2.1.1. Version information
Version: v1
2.1.2. URI scheme
Host: 127.0.0.1:8443 BasePath: / Schemes: HTTPS
2.2. Paths
2.2.1. get available resources
GET /oapi/v1
2.2.1.1. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success |
2.2.1.2. Consumes
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.1.3. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.1.4. Tags
- oapiv1
2.2.2. list objects of kind AppliedClusterResourceQuota
GET /oapi/v1/appliedclusterresourcequotas
2.2.2.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer |
2.2.2.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.2.3. Consumes
- /
2.2.2.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
- application/json;stream=watch
- application/vnd.kubernetes.protobuf;stream=watch
2.2.2.5. Tags
- oapiv1
2.2.3. list or watch objects of kind BuildConfig
GET /oapi/v1/buildconfigs
2.2.3.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer |
2.2.3.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.3.3. Consumes
- /
2.2.3.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
- application/json;stream=watch
- application/vnd.kubernetes.protobuf;stream=watch
2.2.3.5. Tags
- oapiv1
2.2.4. create a BuildConfig
POST /oapi/v1/buildconfigs
2.2.4.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.4.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.4.3. Consumes
- /
2.2.4.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.4.5. Tags
- oapiv1
2.2.5. list or watch objects of kind Build
GET /oapi/v1/builds
2.2.5.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer |
2.2.5.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.5.3. Consumes
- /
2.2.5.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
- application/json;stream=watch
- application/vnd.kubernetes.protobuf;stream=watch
2.2.5.5. Tags
- oapiv1
2.2.6. create a Build
POST /oapi/v1/builds
2.2.6.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.6.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.6.3. Consumes
- /
2.2.6.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.6.5. Tags
- oapiv1
2.2.7. delete collection of ClusterNetwork
DELETE /oapi/v1/clusternetworks
2.2.7.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer |
2.2.7.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.7.3. Consumes
- /
2.2.7.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.7.5. Tags
- oapiv1
2.2.8. list or watch objects of kind ClusterNetwork
GET /oapi/v1/clusternetworks
2.2.8.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer |
2.2.8.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.8.3. Consumes
- /
2.2.8.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
- application/json;stream=watch
- application/vnd.kubernetes.protobuf;stream=watch
2.2.8.5. Tags
- oapiv1
2.2.9. create a ClusterNetwork
POST /oapi/v1/clusternetworks
2.2.9.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.9.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.9.3. Consumes
- /
2.2.9.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.9.5. Tags
- oapiv1
2.2.10. delete a ClusterNetwork
DELETE /oapi/v1/clusternetworks/{name}
2.2.10.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
QueryParameter | gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | false | integer | |
QueryParameter | orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. | false | boolean | |
PathParameter | name | name of the ClusterNetwork | true | string |
2.2.10.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.10.3. Consumes
- /
2.2.10.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.10.5. Tags
- oapiv1
2.2.11. replace the specified ClusterNetwork
PUT /oapi/v1/clusternetworks/{name}
2.2.11.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the ClusterNetwork | true | string |
2.2.11.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.11.3. Consumes
- /
2.2.11.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.11.5. Tags
- oapiv1
2.2.12. read the specified ClusterNetwork
GET /oapi/v1/clusternetworks/{name}
2.2.12.1. Parameters
Type | Name | Description | Required | Schema | 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 |
2.2.12.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.12.3. Consumes
- /
2.2.12.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.12.5. Tags
- oapiv1
2.2.13. partially update the specified ClusterNetwork
PATCH /oapi/v1/clusternetworks/{name}
2.2.13.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the ClusterNetwork | true | string |
2.2.13.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.13.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.13.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.13.5. Tags
- oapiv1
2.2.14. delete collection of ClusterPolicy
DELETE /oapi/v1/clusterpolicies
2.2.14.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer |
2.2.14.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.14.3. Consumes
- /
2.2.14.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.14.5. Tags
- oapiv1
2.2.15. list or watch objects of kind ClusterPolicy
GET /oapi/v1/clusterpolicies
2.2.15.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer |
2.2.15.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.15.3. Consumes
- /
2.2.15.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
- application/json;stream=watch
- application/vnd.kubernetes.protobuf;stream=watch
2.2.15.5. Tags
- oapiv1
2.2.16. create a ClusterPolicy
POST /oapi/v1/clusterpolicies
2.2.16.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.16.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.16.3. Consumes
- /
2.2.16.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.16.5. Tags
- oapiv1
2.2.17. delete a ClusterPolicy
DELETE /oapi/v1/clusterpolicies/{name}
2.2.17.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
QueryParameter | gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | false | integer | |
QueryParameter | orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. | false | boolean | |
PathParameter | name | name of the ClusterPolicy | true | string |
2.2.17.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.17.3. Consumes
- /
2.2.17.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.17.5. Tags
- oapiv1
2.2.18. replace the specified ClusterPolicy
PUT /oapi/v1/clusterpolicies/{name}
2.2.18.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the ClusterPolicy | true | string |
2.2.18.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.18.3. Consumes
- /
2.2.18.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.18.5. Tags
- oapiv1
2.2.19. read the specified ClusterPolicy
GET /oapi/v1/clusterpolicies/{name}
2.2.19.1. Parameters
Type | Name | Description | Required | Schema | 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 |
2.2.19.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.19.3. Consumes
- /
2.2.19.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.19.5. Tags
- oapiv1
2.2.20. partially update the specified ClusterPolicy
PATCH /oapi/v1/clusterpolicies/{name}
2.2.20.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the ClusterPolicy | true | string |
2.2.20.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.20.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.20.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.20.5. Tags
- oapiv1
2.2.21. delete collection of ClusterPolicyBinding
DELETE /oapi/v1/clusterpolicybindings
2.2.21.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer |
2.2.21.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.21.3. Consumes
- /
2.2.21.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.21.5. Tags
- oapiv1
2.2.22. list or watch objects of kind ClusterPolicyBinding
GET /oapi/v1/clusterpolicybindings
2.2.22.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer |
2.2.22.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.22.3. Consumes
- /
2.2.22.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
- application/json;stream=watch
- application/vnd.kubernetes.protobuf;stream=watch
2.2.22.5. Tags
- oapiv1
2.2.23. create a ClusterPolicyBinding
POST /oapi/v1/clusterpolicybindings
2.2.23.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.23.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.23.3. Consumes
- /
2.2.23.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.23.5. Tags
- oapiv1
2.2.24. delete a ClusterPolicyBinding
DELETE /oapi/v1/clusterpolicybindings/{name}
2.2.24.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
QueryParameter | gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | false | integer | |
QueryParameter | orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. | false | boolean | |
PathParameter | name | name of the ClusterPolicyBinding | true | string |
2.2.24.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.24.3. Consumes
- /
2.2.24.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.24.5. Tags
- oapiv1
2.2.25. replace the specified ClusterPolicyBinding
PUT /oapi/v1/clusterpolicybindings/{name}
2.2.25.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the ClusterPolicyBinding | true | string |
2.2.25.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.25.3. Consumes
- /
2.2.25.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.25.5. Tags
- oapiv1
2.2.26. read the specified ClusterPolicyBinding
GET /oapi/v1/clusterpolicybindings/{name}
2.2.26.1. Parameters
Type | Name | Description | Required | Schema | 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 |
2.2.26.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.26.3. Consumes
- /
2.2.26.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.26.5. Tags
- oapiv1
2.2.27. partially update the specified ClusterPolicyBinding
PATCH /oapi/v1/clusterpolicybindings/{name}
2.2.27.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the ClusterPolicyBinding | true | string |
2.2.27.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.27.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.27.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.27.5. Tags
- oapiv1
2.2.28. delete collection of ClusterResourceQuota
DELETE /oapi/v1/clusterresourcequotas
2.2.28.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer |
2.2.28.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.28.3. Consumes
- /
2.2.28.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.28.5. Tags
- oapiv1
2.2.29. list or watch objects of kind ClusterResourceQuota
GET /oapi/v1/clusterresourcequotas
2.2.29.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer |
2.2.29.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.29.3. Consumes
- /
2.2.29.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
- application/json;stream=watch
- application/vnd.kubernetes.protobuf;stream=watch
2.2.29.5. Tags
- oapiv1
2.2.30. create a ClusterResourceQuota
POST /oapi/v1/clusterresourcequotas
2.2.30.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.30.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.30.3. Consumes
- /
2.2.30.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.30.5. Tags
- oapiv1
2.2.31. delete a ClusterResourceQuota
DELETE /oapi/v1/clusterresourcequotas/{name}
2.2.31.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
QueryParameter | gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | false | integer | |
QueryParameter | orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. | false | boolean | |
PathParameter | name | name of the ClusterResourceQuota | true | string |
2.2.31.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.31.3. Consumes
- /
2.2.31.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.31.5. Tags
- oapiv1
2.2.32. replace the specified ClusterResourceQuota
PUT /oapi/v1/clusterresourcequotas/{name}
2.2.32.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the ClusterResourceQuota | true | string |
2.2.32.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.32.3. Consumes
- /
2.2.32.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.32.5. Tags
- oapiv1
2.2.33. read the specified ClusterResourceQuota
GET /oapi/v1/clusterresourcequotas/{name}
2.2.33.1. Parameters
Type | Name | Description | Required | Schema | 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 |
2.2.33.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.33.3. Consumes
- /
2.2.33.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.33.5. Tags
- oapiv1
2.2.34. partially update the specified ClusterResourceQuota
PATCH /oapi/v1/clusterresourcequotas/{name}
2.2.34.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the ClusterResourceQuota | true | string |
2.2.34.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.34.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.34.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.34.5. Tags
- oapiv1
2.2.35. replace status of the specified ClusterResourceQuota
PUT /oapi/v1/clusterresourcequotas/{name}/status
2.2.35.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the ClusterResourceQuota | true | string |
2.2.35.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.35.3. Consumes
- /
2.2.35.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.35.5. Tags
- oapiv1
2.2.36. read status of the specified ClusterResourceQuota
GET /oapi/v1/clusterresourcequotas/{name}/status
2.2.36.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | name | name of the ClusterResourceQuota | true | string |
2.2.36.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.36.3. Consumes
- /
2.2.36.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.36.5. Tags
- oapiv1
2.2.37. partially update status of the specified ClusterResourceQuota
PATCH /oapi/v1/clusterresourcequotas/{name}/status
2.2.37.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the ClusterResourceQuota | true | string |
2.2.37.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.37.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.37.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.37.5. Tags
- oapiv1
2.2.38. list objects of kind ClusterRoleBinding
GET /oapi/v1/clusterrolebindings
2.2.38.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer |
2.2.38.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.38.3. Consumes
- /
2.2.38.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
- application/json;stream=watch
- application/vnd.kubernetes.protobuf;stream=watch
2.2.38.5. Tags
- oapiv1
2.2.39. create a ClusterRoleBinding
POST /oapi/v1/clusterrolebindings
2.2.39.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.39.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.39.3. Consumes
- /
2.2.39.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.39.5. Tags
- oapiv1
2.2.40. delete a ClusterRoleBinding
DELETE /oapi/v1/clusterrolebindings/{name}
2.2.40.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
QueryParameter | gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | false | integer | |
QueryParameter | orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. | false | boolean | |
PathParameter | name | name of the ClusterRoleBinding | true | string |
2.2.40.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.40.3. Consumes
- /
2.2.40.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.40.5. Tags
- oapiv1
2.2.41. replace the specified ClusterRoleBinding
PUT /oapi/v1/clusterrolebindings/{name}
2.2.41.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the ClusterRoleBinding | true | string |
2.2.41.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.41.3. Consumes
- /
2.2.41.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.41.5. Tags
- oapiv1
2.2.42. read the specified ClusterRoleBinding
GET /oapi/v1/clusterrolebindings/{name}
2.2.42.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | name | name of the ClusterRoleBinding | true | string |
2.2.42.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.42.3. Consumes
- /
2.2.42.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.42.5. Tags
- oapiv1
2.2.43. partially update the specified ClusterRoleBinding
PATCH /oapi/v1/clusterrolebindings/{name}
2.2.43.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the ClusterRoleBinding | true | string |
2.2.43.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.43.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.43.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.43.5. Tags
- oapiv1
2.2.44. list objects of kind ClusterRole
GET /oapi/v1/clusterroles
2.2.44.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer |
2.2.44.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.44.3. Consumes
- /
2.2.44.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
- application/json;stream=watch
- application/vnd.kubernetes.protobuf;stream=watch
2.2.44.5. Tags
- oapiv1
2.2.45. create a ClusterRole
POST /oapi/v1/clusterroles
2.2.45.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.45.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.45.3. Consumes
- /
2.2.45.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.45.5. Tags
- oapiv1
2.2.46. delete a ClusterRole
DELETE /oapi/v1/clusterroles/{name}
2.2.46.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
QueryParameter | gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | false | integer | |
QueryParameter | orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. | false | boolean | |
PathParameter | name | name of the ClusterRole | true | string |
2.2.46.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.46.3. Consumes
- /
2.2.46.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.46.5. Tags
- oapiv1
2.2.47. replace the specified ClusterRole
PUT /oapi/v1/clusterroles/{name}
2.2.47.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the ClusterRole | true | string |
2.2.47.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.47.3. Consumes
- /
2.2.47.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.47.5. Tags
- oapiv1
2.2.48. read the specified ClusterRole
GET /oapi/v1/clusterroles/{name}
2.2.48.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | name | name of the ClusterRole | true | string |
2.2.48.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.48.3. Consumes
- /
2.2.48.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.48.5. Tags
- oapiv1
2.2.49. partially update the specified ClusterRole
PATCH /oapi/v1/clusterroles/{name}
2.2.49.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the ClusterRole | true | string |
2.2.49.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.49.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.49.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.49.5. Tags
- oapiv1
2.2.50. create a DeploymentConfigRollback
POST /oapi/v1/deploymentconfigrollbacks
2.2.50.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.50.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.50.3. Consumes
- /
2.2.50.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.50.5. Tags
- oapiv1
2.2.51. list or watch objects of kind DeploymentConfig
GET /oapi/v1/deploymentconfigs
2.2.51.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer |
2.2.51.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.51.3. Consumes
- /
2.2.51.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
- application/json;stream=watch
- application/vnd.kubernetes.protobuf;stream=watch
2.2.51.5. Tags
- oapiv1
2.2.52. create a DeploymentConfig
POST /oapi/v1/deploymentconfigs
2.2.52.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.52.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.52.3. Consumes
- /
2.2.52.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.52.5. Tags
- oapiv1
2.2.53. list or watch objects of kind EgressNetworkPolicy
GET /oapi/v1/egressnetworkpolicies
2.2.53.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer |
2.2.53.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.53.3. Consumes
- /
2.2.53.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
- application/json;stream=watch
- application/vnd.kubernetes.protobuf;stream=watch
2.2.53.5. Tags
- oapiv1
2.2.54. create an EgressNetworkPolicy
POST /oapi/v1/egressnetworkpolicies
2.2.54.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.54.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.54.3. Consumes
- /
2.2.54.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.54.5. Tags
- oapiv1
2.2.55. delete collection of Group
DELETE /oapi/v1/groups
2.2.55.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer |
2.2.55.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.55.3. Consumes
- /
2.2.55.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.55.5. Tags
- oapiv1
2.2.56. list or watch objects of kind Group
GET /oapi/v1/groups
2.2.56.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer |
2.2.56.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.56.3. Consumes
- /
2.2.56.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
- application/json;stream=watch
- application/vnd.kubernetes.protobuf;stream=watch
2.2.56.5. Tags
- oapiv1
2.2.57. create a Group
POST /oapi/v1/groups
2.2.57.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.57.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.57.3. Consumes
- /
2.2.57.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.57.5. Tags
- oapiv1
2.2.58. delete a Group
DELETE /oapi/v1/groups/{name}
2.2.58.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
QueryParameter | gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | false | integer | |
QueryParameter | orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. | false | boolean | |
PathParameter | name | name of the Group | true | string |
2.2.58.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.58.3. Consumes
- /
2.2.58.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.58.5. Tags
- oapiv1
2.2.59. replace the specified Group
PUT /oapi/v1/groups/{name}
2.2.59.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the Group | true | string |
2.2.59.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.59.3. Consumes
- /
2.2.59.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.59.5. Tags
- oapiv1
2.2.60. read the specified Group
GET /oapi/v1/groups/{name}
2.2.60.1. Parameters
Type | Name | Description | Required | Schema | 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 |
2.2.60.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.60.3. Consumes
- /
2.2.60.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.60.5. Tags
- oapiv1
2.2.61. partially update the specified Group
PATCH /oapi/v1/groups/{name}
2.2.61.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the Group | true | string |
2.2.61.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.61.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.61.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.61.5. Tags
- oapiv1
2.2.62. delete collection of HostSubnet
DELETE /oapi/v1/hostsubnets
2.2.62.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer |
2.2.62.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.62.3. Consumes
- /
2.2.62.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.62.5. Tags
- oapiv1
2.2.63. list or watch objects of kind HostSubnet
GET /oapi/v1/hostsubnets
2.2.63.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer |
2.2.63.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.63.3. Consumes
- /
2.2.63.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
- application/json;stream=watch
- application/vnd.kubernetes.protobuf;stream=watch
2.2.63.5. Tags
- oapiv1
2.2.64. create a HostSubnet
POST /oapi/v1/hostsubnets
2.2.64.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.64.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.64.3. Consumes
- /
2.2.64.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.64.5. Tags
- oapiv1
2.2.65. delete a HostSubnet
DELETE /oapi/v1/hostsubnets/{name}
2.2.65.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
QueryParameter | gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | false | integer | |
QueryParameter | orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. | false | boolean | |
PathParameter | name | name of the HostSubnet | true | string |
2.2.65.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.65.3. Consumes
- /
2.2.65.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.65.5. Tags
- oapiv1
2.2.66. replace the specified HostSubnet
PUT /oapi/v1/hostsubnets/{name}
2.2.66.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the HostSubnet | true | string |
2.2.66.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.66.3. Consumes
- /
2.2.66.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.66.5. Tags
- oapiv1
2.2.67. read the specified HostSubnet
GET /oapi/v1/hostsubnets/{name}
2.2.67.1. Parameters
Type | Name | Description | Required | Schema | 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 |
2.2.67.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.67.3. Consumes
- /
2.2.67.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.67.5. Tags
- oapiv1
2.2.68. partially update the specified HostSubnet
PATCH /oapi/v1/hostsubnets/{name}
2.2.68.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the HostSubnet | true | string |
2.2.68.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.68.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.68.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.68.5. Tags
- oapiv1
2.2.69. delete collection of Identity
DELETE /oapi/v1/identities
2.2.69.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer |
2.2.69.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.69.3. Consumes
- /
2.2.69.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.69.5. Tags
- oapiv1
2.2.70. list or watch objects of kind Identity
GET /oapi/v1/identities
2.2.70.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer |
2.2.70.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.70.3. Consumes
- /
2.2.70.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
- application/json;stream=watch
- application/vnd.kubernetes.protobuf;stream=watch
2.2.70.5. Tags
- oapiv1
2.2.71. create an Identity
POST /oapi/v1/identities
2.2.71.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.71.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.71.3. Consumes
- /
2.2.71.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.71.5. Tags
- oapiv1
2.2.72. delete an Identity
DELETE /oapi/v1/identities/{name}
2.2.72.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
QueryParameter | gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | false | integer | |
QueryParameter | orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. | false | boolean | |
PathParameter | name | name of the Identity | true | string |
2.2.72.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.72.3. Consumes
- /
2.2.72.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.72.5. Tags
- oapiv1
2.2.73. replace the specified Identity
PUT /oapi/v1/identities/{name}
2.2.73.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the Identity | true | string |
2.2.73.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.73.3. Consumes
- /
2.2.73.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.73.5. Tags
- oapiv1
2.2.74. read the specified Identity
GET /oapi/v1/identities/{name}
2.2.74.1. Parameters
Type | Name | Description | Required | Schema | 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 |
2.2.74.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.74.3. Consumes
- /
2.2.74.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.74.5. Tags
- oapiv1
2.2.75. partially update the specified Identity
PATCH /oapi/v1/identities/{name}
2.2.75.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the Identity | true | string |
2.2.75.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.75.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.75.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.75.5. Tags
- oapiv1
2.2.76. delete collection of Image
DELETE /oapi/v1/images
2.2.76.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer |
2.2.76.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.76.3. Consumes
- /
2.2.76.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.76.5. Tags
- oapiv1
2.2.77. list or watch objects of kind Image
GET /oapi/v1/images
2.2.77.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer |
2.2.77.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.77.3. Consumes
- /
2.2.77.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
- application/json;stream=watch
- application/vnd.kubernetes.protobuf;stream=watch
2.2.77.5. Tags
- oapiv1
2.2.78. create an Image
POST /oapi/v1/images
2.2.78.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.78.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.78.3. Consumes
- /
2.2.78.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.78.5. Tags
- oapiv1
2.2.79. delete an Image
DELETE /oapi/v1/images/{name}
2.2.79.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
QueryParameter | gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | false | integer | |
QueryParameter | orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. | false | boolean | |
PathParameter | name | name of the Image | true | string |
2.2.79.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.79.3. Consumes
- /
2.2.79.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.79.5. Tags
- oapiv1
2.2.80. replace the specified Image
PUT /oapi/v1/images/{name}
2.2.80.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the Image | true | string |
2.2.80.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.80.3. Consumes
- /
2.2.80.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.80.5. Tags
- oapiv1
2.2.81. read the specified Image
GET /oapi/v1/images/{name}
2.2.81.1. Parameters
Type | Name | Description | Required | Schema | 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 |
2.2.81.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.81.3. Consumes
- /
2.2.81.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.81.5. Tags
- oapiv1
2.2.82. partially update the specified Image
PATCH /oapi/v1/images/{name}
2.2.82.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | name | name of the Image | true | string |
2.2.82.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.82.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.82.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.82.5. Tags
- oapiv1
2.2.83. create an ImageSignature
POST /oapi/v1/imagesignatures
2.2.83.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.83.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.83.3. Consumes
- /
2.2.83.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.83.5. Tags
- oapiv1
2.2.84. delete an ImageSignature
DELETE /oapi/v1/imagesignatures/{name}
2.2.84.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
PathParameter | name | name of the ImageSignature | true | string |
2.2.84.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.84.3. Consumes
- /
2.2.84.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.84.5. Tags
- oapiv1
2.2.85. create an ImageStreamImport
POST /oapi/v1/imagestreamimports
2.2.85.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.85.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.85.3. Consumes
- /
2.2.85.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.85.5. Tags
- oapiv1
2.2.86. create an ImageStreamMapping
POST /oapi/v1/imagestreammappings
2.2.86.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.86.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.86.3. Consumes
- /
2.2.86.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.86.5. Tags
- oapiv1
2.2.87. list or watch objects of kind ImageStream
GET /oapi/v1/imagestreams
2.2.87.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer |
2.2.87.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.87.3. Consumes
- /
2.2.87.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
- application/json;stream=watch
- application/vnd.kubernetes.protobuf;stream=watch
2.2.87.5. Tags
- oapiv1
2.2.88. create an ImageStream
POST /oapi/v1/imagestreams
2.2.88.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.88.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.88.3. Consumes
- /
2.2.88.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.88.5. Tags
- oapiv1
2.2.89. list objects of kind ImageStreamTag
GET /oapi/v1/imagestreamtags
2.2.89.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer |
2.2.89.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.89.3. Consumes
- /
2.2.89.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
- application/json;stream=watch
- application/vnd.kubernetes.protobuf;stream=watch
2.2.89.5. Tags
- oapiv1
2.2.90. create an ImageStreamTag
POST /oapi/v1/imagestreamtags
2.2.90.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.90.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.90.3. Consumes
- /
2.2.90.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.90.5. Tags
- oapiv1
2.2.91. create a LocalResourceAccessReview
POST /oapi/v1/localresourceaccessreviews
2.2.91.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.91.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.91.3. Consumes
- /
2.2.91.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.91.5. Tags
- oapiv1
2.2.92. create a LocalSubjectAccessReview
POST /oapi/v1/localsubjectaccessreviews
2.2.92.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true |
2.2.92.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.92.3. Consumes
- /
2.2.92.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.92.5. Tags
- oapiv1
2.2.93. list objects of kind AppliedClusterResourceQuota
GET /oapi/v1/namespaces/{namespace}/appliedclusterresourcequotas
2.2.93.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.93.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.93.3. Consumes
- /
2.2.93.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
- application/json;stream=watch
- application/vnd.kubernetes.protobuf;stream=watch
2.2.93.5. Tags
- oapiv1
2.2.94. read the specified AppliedClusterResourceQuota
GET /oapi/v1/namespaces/{namespace}/appliedclusterresourcequotas/{name}
2.2.94.1. Parameters
Type | Name | Description | Required | Schema | 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 |
2.2.94.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.94.3. Consumes
- /
2.2.94.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.94.5. Tags
- oapiv1
2.2.95. delete collection of BuildConfig
DELETE /oapi/v1/namespaces/{namespace}/buildconfigs
2.2.95.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.95.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.95.3. Consumes
- /
2.2.95.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.95.5. Tags
- oapiv1
2.2.96. list or watch objects of kind BuildConfig
GET /oapi/v1/namespaces/{namespace}/buildconfigs
2.2.96.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.96.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.96.3. Consumes
- /
2.2.96.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
- application/json;stream=watch
- application/vnd.kubernetes.protobuf;stream=watch
2.2.96.5. Tags
- oapiv1
2.2.97. create a BuildConfig
POST /oapi/v1/namespaces/{namespace}/buildconfigs
2.2.97.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.97.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.97.3. Consumes
- /
2.2.97.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.97.5. Tags
- oapiv1
2.2.98. delete a BuildConfig
DELETE /oapi/v1/namespaces/{namespace}/buildconfigs/{name}
2.2.98.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
QueryParameter | gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | false | integer | |
QueryParameter | orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. | false | boolean | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the BuildConfig | true | string |
2.2.98.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.98.3. Consumes
- /
2.2.98.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.98.5. Tags
- oapiv1
2.2.99. replace the specified BuildConfig
PUT /oapi/v1/namespaces/{namespace}/buildconfigs/{name}
2.2.99.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the BuildConfig | true | string |
2.2.99.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.99.3. Consumes
- /
2.2.99.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.99.5. Tags
- oapiv1
2.2.100. read the specified BuildConfig
GET /oapi/v1/namespaces/{namespace}/buildconfigs/{name}
2.2.100.1. Parameters
Type | Name | Description | Required | Schema | 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 |
2.2.100.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.100.3. Consumes
- /
2.2.100.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.100.5. Tags
- oapiv1
2.2.101. partially update the specified BuildConfig
PATCH /oapi/v1/namespaces/{namespace}/buildconfigs/{name}
2.2.101.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the BuildConfig | true | string |
2.2.101.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.101.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.101.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.101.5. Tags
- oapiv1
2.2.102. create instantiate of a BuildRequest
POST /oapi/v1/namespaces/{namespace}/buildconfigs/{name}/instantiate
2.2.102.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the BuildRequest | true | string |
2.2.102.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.102.3. Consumes
- /
2.2.102.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.102.5. Tags
- oapiv1
2.2.103. connect POST requests to instantiatebinary of BinaryBuildRequestOptions
POST /oapi/v1/namespaces/{namespace}/buildconfigs/{name}/instantiatebinary
2.2.103.1. Parameters
Type | Name | Description | Required | Schema | 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 |
2.2.103.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
2.2.103.3. Consumes
- /
2.2.103.4. Produces
- /
2.2.103.5. Tags
- oapiv1
2.2.104. connect POST requests to webhooks of Status
POST /oapi/v1/namespaces/{namespace}/buildconfigs/{name}/webhooks
2.2.104.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | path | Path is the URL path to use for the current proxy request to pod. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Status | true | string |
2.2.104.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
2.2.104.3. Consumes
- /
2.2.104.4. Produces
- /
2.2.104.5. Tags
- oapiv1
2.2.105. connect POST requests to webhooks of Status
POST /oapi/v1/namespaces/{namespace}/buildconfigs/{name}/webhooks/{path}
2.2.105.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | path | Path is the URL path to use for the current proxy request to pod. | false | string | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Status | true | string | |
PathParameter | path | path to the resource | true | string |
2.2.105.2. Responses
HTTP Code | Description | Schema |
---|---|---|
default | success | string |
2.2.105.3. Consumes
- /
2.2.105.4. Produces
- /
2.2.105.5. Tags
- oapiv1
2.2.106. delete collection of Build
DELETE /oapi/v1/namespaces/{namespace}/builds
2.2.106.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.106.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.106.3. Consumes
- /
2.2.106.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.106.5. Tags
- oapiv1
2.2.107. list or watch objects of kind Build
GET /oapi/v1/namespaces/{namespace}/builds
2.2.107.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string | |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string | |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean | |
QueryParameter | resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | false | string | |
QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.107.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.107.3. Consumes
- /
2.2.107.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
- application/json;stream=watch
- application/vnd.kubernetes.protobuf;stream=watch
2.2.107.5. Tags
- oapiv1
2.2.108. create a Build
POST /oapi/v1/namespaces/{namespace}/builds
2.2.108.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string |
2.2.108.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.108.3. Consumes
- /
2.2.108.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.108.5. Tags
- oapiv1
2.2.109. delete a Build
DELETE /oapi/v1/namespaces/{namespace}/builds/{name}
2.2.109.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
QueryParameter | gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | false | integer | |
QueryParameter | orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. | false | boolean | |
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Build | true | string |
2.2.109.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.109.3. Consumes
- /
2.2.109.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.109.5. Tags
- oapiv1
2.2.110. replace the specified Build
PUT /oapi/v1/namespaces/{namespace}/builds/{name}
2.2.110.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Build | true | string |
2.2.110.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.110.3. Consumes
- /
2.2.110.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.110.5. Tags
- oapiv1
2.2.111. read the specified Build
GET /oapi/v1/namespaces/{namespace}/builds/{name}
2.2.111.1. Parameters
Type | Name | Description | Required | Schema | 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 |
2.2.111.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.111.3. Consumes
- /
2.2.111.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.111.5. Tags
- oapiv1
2.2.112. partially update the specified Build
PATCH /oapi/v1/namespaces/{namespace}/builds/{name}
2.2.112.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Build | true | string |
2.2.112.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.112.3. Consumes
- application/json-patch+json
- application/merge-patch+json
- application/strategic-merge-patch+json
2.2.112.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.112.5. Tags
- oapiv1
2.2.113. create clone of a BuildRequest
POST /oapi/v1/namespaces/{namespace}/builds/{name}/clone
2.2.113.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the BuildRequest | true | string |
2.2.113.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.113.3. Consumes
- /
2.2.113.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.113.5. Tags
- oapiv1
2.2.114. replace details of the specified Build
PUT /oapi/v1/namespaces/{namespace}/builds/{name}/details
2.2.114.1. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter | pretty | If 'true', then the output is pretty printed. | false | string | |
BodyParameter | body | true | |||
PathParameter | namespace | object name and auth scope, such as for teams and projects | true | string | |
PathParameter | name | name of the Build | true | string |
2.2.114.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.114.3. Consumes
- /
2.2.114.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.114.5. Tags
- oapiv1
2.2.115. read log of the specified BuildLog
GET /oapi/v1/namespaces/{namespace}/builds/{name}/log
2.2.115.1. Parameters
Type | Name | Description | Required | Schema | 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 |
2.2.115.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 | success |
2.2.115.3. Consumes
- /
2.2.115.4. Produces
- application/json
- application/yaml
- application/vnd.kubernetes.protobuf
2.2.115.5. Tags
- oapiv1
2.2.116. create a DeploymentConfigRollback
POST /oapi/v1/namespaces/{namespace}/deploymentconfigrollbacks
2.2.116.1. Parameters
Type | Name | Description | Required |
---|